KcRdZddlZddlZddlmZddlmZddlmZm Z m Z m Z m Z m Z mZmZmZddlmZmZddlmZmZmZmZGd d eZGd d eZGd de ZGddeZGddeZdS)z/A base class for objects that are configurable.N)deepcopy)dedent) Any ContainerDict HasTraitsInstancedefaultobserveobserve_compatvalidate)indentwrap_paragraphs)ConfigDeferredConfigLazyConfigValue_is_section_keyceZdZdS)ConfigurableErrorN__name__ __module__ __qualname__=lib/python3.11/site-packages/traitlets/config/configurable.pyrr!DrrceZdZdS)MultipleInstanceErrorNrrrrr r %rrr c@eZdZeediZeddZfdZedZ dZ dd Z e d e d Zd Zedd ZeddZeddZedZeddZedZxZS) Configurablerz*traitlets.config.configurable.ConfigurableT) allow_nonec dd}|'dd |jd<||_dd}t jdit fd}|||||_n||j| |D]}t|||dS)aCreate a configurable given a config config. Parameters ---------- config : Config If this is empty, default values are used. If config is a :class:`Config` instance, it will be used to configure the instance. parent : Configurable instance, optional The parent Configurable instance of this object. Notes ----- Subclasses of Configurable must call the :meth:`__init__` method of :class:`Configurable` *before* doing anything else and using :func:`super`:: class MyConfigurable(Configurable): def __init__(self, config=None): super(MyConfigurable, self).__init__(config=config) # Then any other code you need to finish initialization. This ensures that instances will be configured properly. parentNconfigcR|jvr|jdSdS)zRecord traits set by both config and kwargs. They will need to be overridden again after loading config. N)nameadd)changeconfig_override_nameskwargss rnotice_config_overridez5Configurable.__init__..notice_config_override[s: {f$ 7%))&+66666 7 7rr) popgetr&r%super__init__setr _load_config unobservesetattr)selfr,r%r&r-r(r+ __class__s ` @rr1zConfigurable.__init__3s.2Hd++  !zz(D)) 1#)=x  DKHd++ ""6"""!$ 7 7 7 7 7 7 +,,,  +!DKK   dk * * * -...) . .D D$t - - - - . .rcDfdtjDS)zreturn section names as a listchg|].}t|tt|'|j/Sr issubclassr"r).0cclss r z.Configurable.section_names..~sO   !\** 0:#q/A/A J   r)reversed__mro__r>s`r section_nameszConfigurable.section_names{s8    ck**    rc(|g}|jr-||j|t}|D]I}|D]2}||r|||3J|S)aextract my config from a global Config object will construct a Config object of only the config values that apply to me based on my mro(), as well as those of my parent(s) if they exist. If I am Bar and my parent is Foo, and their parent is Tim, this will return merge following config sections, in this order:: [Bar, Foo.Bar, Tim.Foo.Bar] With the last item being the highest priority. )r%append_find_my_configrrC _has_sectionmerge)r6cfgcfgs my_configr=snames rrFzConfigurable._find_my_configsu ; : KK 33C88 9 9 9HH  . .A++-- . .>>%((.OOAeH---  . rNc (||d}||}||}|5|D]\}}||vrt |t r&t||}||}n0t |tr|||}t||t|t|st |tsddlm}t |t r |jj} nd} |||} d||jj} t-| d kr| d | dd z } nLt-| d kr9| d d t1| z } | |  ddddS#1swxYwYdS)z load traits from a Config objectNTr&r)get_close_matchesc.tj|dS)N ) stacklevel)warningswarn)msgs rz+Configurable._load_config..s8=+K+K+Krz5Config option `{option}` not recognized by `{klass}`.)optionklassrz Did you mean `z`?z# Did you mean one of: `{matches}`?, )matches)traitsrCrFhold_trait_notificationsitems isinstancergetattr get_valuerr5rrrdifflibrOLoggingConfigurablelogwarningformatr7rlenjoinsorted) r6rIrCr[rKr( config_valueinitialrOrTrZrUs rr3zConfigurable._load_configs  .[[[--F  1 ..00M((--  * * , ,! ! &/oo&7&7  "l6>!,@@L#*$"5"5'3'='=g'F'F #L.AAL'3'='=fTl'K'K D$(>(>????(..z,PV7W7W999999!$(;<<L#x/KK//f==GQXX#4>+BYC7||q(@'!*@@@@W*DKK$(IIfWoo$>$> L  DIIIA ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! sF!HH H r&c|d}|}||j||dS)zUpdate all the class traits having ``config=True`` in metadata. For any class trait with a ``config`` metadata attribute that is ``True``, we update the trait with the value of the corresponding config entry. TrN)r[rCN)r[rCr3new)r6r*r[rCs r_config_changedzConfigurable._config_changedsMD)) **,,  &*V=QQQQQrct|j|_|||j|dS)z%Update config and load the new valuesN)rr&r3rH)r6r&s r update_configzConfigurable.update_configsEt{++  &!!! &!!!!!rc|t||sJg}dd|jD}||jd|d|t |ddzt |d D]0\}}| ||}||1d |S) zGet the help string for this class in ReST format. If `inst` is given, its current trait values will be used in place of class defaults. NrYc3$K|] }|jV dSN)rr<ps r z.Configurable.class_get_help..s$ C C C C C C C Cr(z ) optionsr-TrN ) r^rg __bases__rErrfrh class_traitsr]class_get_trait_help)r>inst final_help base_classes_vhelps rclass_get_helpzConfigurable.class_get_helps4z$44444 yy C CS] C C CCC S\CCLCCCDDD#jm,,s23333++4+88>>@@AA $ $DAq++At44D   d # # # #yy$$$rc `|t||sJg}d|jd|j}t|ttfrl|jdd}t|trd}n!d|jjz}|dkr |d|d }n|d |d }n|d |jjd }| |||j }|d krEd t|d}| t|d|jjvr7| td|z|9| tdt||jno |}n#t"$rd}YnwxYw|Et%|dkr |ddd z}| td|zd |S)aGet the helptext string for a single trait. :param inst: If given, its current trait values will be used in place of the class default. :param helptext: If not given, uses the `help` attribute of the current trait. Nz--. multiplicityrEz=z <%s-item-1>=... z=<>rxLEnumz Choices: %sz Current: @=z Default: %s)r^rr(rrmetadatar/r7lowerrErrgrrinfor_default_value_repr Exceptionrf) r>traitr|helptextlinesheaderr sample_valuedvrs rr{z!Configurable.class_get_trait_helpsf4z$444441cl11UZ11 ei. / / > >--nhGGL%&& P2 ,u/G/M/M/O/OO x' 7"66\666"66\666==%/":===F V  "zH r> +yy2!>!>??H LL)) * * * U_- - ? LL  <== > > >  : LL IGD%*,E,E I IJJ K K K K ..00     :s88b=+crc(U*C VMC$788999yys-G GGcJt||dS)z4Get the help string for a single trait and print it.N)printr)r>r|s rclass_print_helpzConfigurable.class_print_help2s& c  &&'''''rc|}|D]N}t|tr7||vr3|d|jd|ur|}O|S)a7Get the class that defines a trait For reducing redundant help output in config files. Returns the current class if: - the trait is defined on this class, or - the class where it is defined would not be in the config file Parameters ---------- trait : Trait The trait to look for classes : list The list of other classes to consider for redundancy. Will return `cls` even if it is not defined on `cls` if the defining class is not in `classes`. TrNN)mror;r"class_own_traitsr/r()r>rclasses defining_clsr%s r_defining_classzConfigurable._defining_class7s$ ggii & &F6<00 &g% &++4+88<.c^s6 OAr2233A199T7333 3rzO#------------------------------------------------------------------------------rYc3NK|] }t|t|jV!dSrrr:rss rruz4Configurable.class_config_section..fs5"d"d! STVbHcHc"d1:"d"d"d"d"d"drz# rvz) configuration description__doc__rTrNrz# Choices: %sz# Default: %srxrrz # See also: rz# c.z = )rgryrrzr/ default_valuer_rErhr]rrrtypersplit) r>rr=breakerparent_classesrrdescr(r default_reprdefining_classs rclass_config_sectionz!Configurable.class_config_sectionSs 4 4 4!"d"ds}"d"d"ddd ? ? ? ? ? ?!W%!!%%m44  &%D /3 2..D   LL4 ! ! ! LL   !#"2"2$"2"?"?"E"E"G"GHH  KD% 3355L %!$!4!4UG!D!D!$$ O:0LL5:///T%[[11BLL!1EJJLL!@AAA - <====:BLL5:#3#3D!#<#r classnamerrttypetermlinerrs rclass_config_rst_docz!Configurable.class_config_rst_docs L s//t/<<BBDDEE  HAuO,E 33H *EENN$4$444EEM) LL " " " ..00     !s88b=+crc(U*Ckk%11 V$5$;<<=== R   :1!1D LLt -- . . . LL    yysB00 B?>B?)NNrr)rrrr rr&r%r1 classmethodrCrFr3r r rmrorr{rrrr __classcell__)r7s@rr"r".s Xfb" % %F XBt T T TFB.B.B.B.B.P  [ 2,,,,\ WXRR^R " " " %%%[% 1 1 1 [1 f((([([69 9 9 [9 v' ' [' ' ' ' ' rr"ceZdZdZedZeddZeddZ dZ dS) rbzA parent class for Configurables that log. Subclasses have a log trait, and the default behavior is to get the logger from the currently running Application. z Logger or LoggerAdapter instance)rrcct|jtjtjfs)t j|jjd|jd|jS)Nz..log should be a Logger or LoggerAdapter, got r) r^valueloggingLogger LoggerAdapterrSrTr7r)r6proposals r _validate_logz!LoggingConfigurable._validate_logsd(.7>7;P*QRR  M>*** ***   ~rct|jtr |jjSddlm}|S)Nr)rc)r^r%rbrc traitlets get_logger)r6rcs r _log_defaultz LoggingConfigurable._log_defaultsC dk#6 7 7 #;? "!!!!!!~~rc|j}t|tjr|j}t |ddsdS|jdS)zReturn the default Handler Returns None if none can be found Deprecated, this now returns the first log handler which may or may not be the default one. handlersNr)rcr^rrloggerr_r)r6rs r_get_log_handlerz$LoggingConfigurable._get_log_handlersM fg3 4 4 #]Fvz400 4q!!rN) rrrrrrcr rr rrrrrrbrbs #5 6 6 6C Xe___ WU^^  ^ """""rrbcneZdZdZdZedZedZedZedZ dS)SingletonConfigurablezA configurable that only allows one instance. This class is for classes that should only have one instance of itself or *any* subclass. To create and retrieve such a class use the :meth:`SingletonConfigurable.instance` method. Nc#K|D]6}t||r$t|tr|tkr|V7dS)zfWalk the cls.mro() for parent classes that are also singletons For use in instance() N)rr;rr>subclasss r _walk_mrozSingletonConfigurable._walk_mrosj   H3)) x)>??  55     rc|sdS|D]}t|j|rd|_dS)z5unset _instance for this class and singleton parents.N) initializedrr^ _instancers rclear_instancez$SingletonConfigurable.clear_instances\    F  * *H(,c22 *&*"  * *rc|j&||i|}|D] }||_ t|j|r|jStd|jdt |jj)aReturns a global instance of this class. This method create a new instance if none have previously been created and returns a previously created instance is one already exists. The arguments and keyword arguments passed to this method are passed on to the :meth:`__init__` method of the class upon instantiation. Examples -------- Create a singleton class using instance, and retrieve it:: >>> from traitlets.config.configurable import SingletonConfigurable >>> class Foo(SingletonConfigurable): pass >>> foo = Foo.instance() >>> foo == Foo.instance() True Create a subclass that is retrived using the base class instance:: >>> class Bar(SingletonConfigurable): pass >>> class Bam(Bar): pass >>> bam = Bam.instance() >>> bam == Bar.instance() True NzAn incompatible sibling of 'z(' is already instanciated as singleton: )rrr^r rr)r>argsr,r|rs rinstancezSingletonConfigurable.instance s: = *3'''D MMOO * *%)"" cmS ) ) = '''*|||T#-5H5H5Q5QS rc4t|do|jduS)zHas an instance been created?rN)hasattrrrBs rrz!SingletonConfigurable.initialized6s sK((FS]$-FFr) rrrrrrrrrrrrrrrsI  [ **[*))[)VGG[GGGrr)rrrScopyrtextwraprtraitlets.traitletsrrrrr r r r r traitlets.utils.textrrloaderrrrrrrr r"rbrrrrrs55                       98888888LLLLLLLLLLLL             -   I I I I I 9I I I X )")")")")",)")")"XSGSGSGSGSG/SGSGSGSGSGr