_dRdZddlZddlZddlmZddlmZddlmZm Z m Z m Z m Z m Z mZmZmZddlmZmZddlmZmZmZmZGd d eZGd d eZGd de ZGddeZGddeZy)z/A base class for objects that are configurable.N)deepcopy)dedent) Any ContainerDict HasTraitsInstancedefaultobserveobserve_compatvalidate)indentwrap_paragraphs)ConfigDeferredConfigLazyConfigValue_is_section_keyc eZdZy)ConfigurableErrorN__name__ __module__ __qualname__?/usr/lib/python3/dist-packages/traitlets/config/configurable.pyrr rrc eZdZy)MultipleInstanceErrorNrrrrr r $rrr ceZdZeediZeddZfdZedZ dZ ddZ e d e d Zd Zedd Zedd ZeddZedZeddZedZxZS) Configurablerz*traitlets.config.configurable.ConfigurableT) allow_nonec jdd}|(jdd|jd<||_jdd}t |dit fd}|j||||_n|j|j|j|D]}t|||y)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. parentNconfigcZ|jvrj|jyy)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_overrideZs( {{f$%))&++6%rr) popgetr&r%super__init__setr _load_config unobservesetattr)selfr,r%r&r-r(r+ __class__s ` @rr1zConfigurable.__init__2s2Hd+  zz(D)1#)==x  DKHd+ "6"!$ 7 +,  !DK   dkk * -.) .D D$t - .rct|jDcgc]*}t|trt||r |j,c}Scc}w)zreturn section names as a list)reversed__mro__ issubclassr"r)clscs r section_nameszConfigurable.section_nameszsD ckk* !\*z#q/A JJ   s/A c|g}|jr*|j|jj|t}|D]=}|j D](}|j |s|j ||*?|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_configrr> _has_sectionmerge)r6cfgcfgs my_configr=snames rrAzConfigurable._find_my_configsu ;; KK 33C8 9H  .A++- .>>%(OOAeH-  . . rc ||jd}||j}|j|}|j5|j D]N\}}||vrit |t rt||}|j|}n$t |tr|j||}t||t|tt|rt |trddlm}t |t r|j"j$} nd} |||} dj'||j(j*} t-| d k(r | d | dd z } n;t-| d k\r-| d j'd j/t1| z } | | Q dddy#1swYyxYw)z load traits from a Config objectNTr&r)get_close_matchesc0tj|dS)N ) stacklevel)warningswarn)msgs rz+Configurable._load_config..s8==+Krz5Config option `{option}` not recognized by `{klass}`.)optionklassrz Did you mean `z`?z# Did you mean one of: `{matches}`?, )matches)traitsr>rAhold_trait_notificationsitems isinstancergetattr get_valuerr5rrrdifflibrJLoggingConfigurablelogwarningformatr7rlenjoinsorted) r6rDr>rVrFr( config_valueinitialrJrOrUrPs rr3zConfigurable._load_configs >[[[-F   ..0M((-  * * ,! &/oo&7 "l6>!,@#*$"5'3'='=g'F #L.A'3'='=fTl'K D$(>?(.z,PV7W9!$(;<#xx//K/f=GQXX#4>>+B+BYC7|q(!1'!*R@@W*DKK$(IIfWo$> L IA ! ! ! sBF5F5*CF55F>r&c|jd}|j}|j|j||y)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. TrI)rVr>N)rVr>r3new)r6r*rVr>s r_config_changedzConfigurable._config_changeds=D) **,  &**V=Qrct|j|_|j||jj|y)z%Update config and load the new valuesN)rr&r3rC)r6r&s r update_configzConfigurable.update_configs4t{{+  &! &!rc|t||sJg}djd|jD}|j|jd|d|jt |ddzt |jdjD](\}}|j||}|j|*d j|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. rTc34K|]}|jywN)r.0ps r z.Configurable.class_get_help..s C Cs(z ) optionsr-TrI ) rYrb __bases__r@rrarc class_traitsrXclass_get_trait_help)r<inst final_help base_classes_vhelps rclass_get_helpzConfigurable.class_get_helps|z$444 yy CS]] CC S\\N!L>CD#jm,s233++4+8>>@A $DAq++At4D   d # $yy$$rc  |t||sJg}d|jd|j}t|ttfrm|j j dd}t|trd}n'd|jjjz}|dk(r |d|d }n%|d |d }n|d |jjd }|j|| |j}|d k7r5djt|d}|jt|d|jjvr+|jtd|jz|2|jtdt||jnF |j!}|3t%|dkDr|ddd z}|jtd|zdj|S#t"$rd}YSwxYw)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--. multiplicityr@z=z <%s-item-1>=... z=<>rtLEnumz Choices: %sz Current: @=z Default: %s)rYrr(rrmetadatar/r7lowerr@r}rbrrinforZdefault_value_repr Exceptionra) r<traitrxhelptextlinesheaderr sample_valuedvrs rrwz!Configurable.class_get_trait_helps|z$444cll^1UZZL1 ei. / >>--nhGL%&2 ,u/G/G/M/M/OO x'"81\N#6"81\N#6xr%//":":!;1=F V  zzH r>yy2!>?H LL) * U__-- - LL  <= >   LL)GD%**,E+H IJ K ..0s8b=cr(U*C VMC$789yy  sG55 HHc8t|j|y)z4Get the help string for a single trait and print it.N)printr~)r<rxs rclass_print_helpzConfigurable.class_print_help1s c  &'rc|}|jD]I}t|ts||vs|jdj |j d|usH|}K|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`. TrIN)mror;r"class_own_traitsr/r()r<rclasses defining_clsr%s r_defining_classzConfigurable._defining_class6se$ ggi &F6<0g%++4+8<.c]s- OAr23A199T733 3rzO#------------------------------------------------------------------------------rTc3VK|]!}t|ts|j#ywrm)r;r"rrns rrqz4Configurable.class_config_section..es"d! STVbHc1::"ds))z# rrz) configuration description__doc__rTrIrz# Choices: %sz# Default: %srtrrz # See also: rz# c.z = )rbrurrvr/ default_valuerZr@rcrXrrr}typersplit) r<rr=breakerparent_classesrrdescr(r default_reprdefining_classs rclass_config_sectionz!Configurable.class_config_sectionRs 4!"ds}}"dda/ ?!W%!%%m4 %%D3 2.D  LL4 ! LL !#"2"2$"2"?"E"E"GH KD% 335L!$!4!4UG!D!$$::LL5::/T%[111LL!1EJJL!@A - <=::LL5::#3#3D!#rAr3r r rhrjr~rwrrrr __classcell__)r7s@rr"r"-s fb" %F Bt TFB.P  2,\ XRR " %% 1 1 f((69 9 v' ' rr"c`eZdZdZedZeddZeddZ dZ y) r]zA 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)r}r^ct|jtjtjfs9t j |jjd|jd|jS)Nz..log should be a Logger or LoggerAdapter, got r) rYvalueloggingLogger LoggerAdapterrNrOr7r)r6proposals r _validate_logz!LoggingConfigurable._validate_logs](..7>>7;P;P*QR MM>>**+, 'q* ~~rct|jtr|jjSddlm}|j S)Nr)r^)rYr%r]r^ traitlets get_logger)r6r^s r _log_defaultz LoggingConfigurable._log_defaults/ dkk#6 7;;?? "!~~rc|j}t|tjr |j}t |ddsy|j dS)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)r^rYrrloggerrZr)r6rs r_get_log_handlerz$LoggingConfigurable._get_log_handlersD fg33 4]]Fvz40q!!rN) rrrrrr^r rr rrrrrr]r]sG 5 6C e_ U^  "rr]cTeZdZdZdZedZedZedZedZ y)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|jD].}t||st|ts!|tk7s+|0yw)zfWalk the cls.mro() for parent classes that are also singletons For use in instance() N)rr;rr<subclasss r _walk_mrozSingletonConfigurable._walk_mros@  H3)x)>? 55  s AA AAc|jsy|jD] }t|j|sd|_"y)z5unset _instance for this class and singleton parents.N) initializedrrY _instancers rclear_instancez$SingletonConfigurable.clear_instances@   *H(,,c2&*"  *rc|j$||i|}|jD] }||_ 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 zAn incompatible sibling of 'z(' is already instanciated as singleton: )rrrYr rr)r<argsr,rxrs rinstancezSingletonConfigurable.instance s: == ''D MMO *%)" * cmmS )== ''*||T#--5H5Q5QS rc:t|dxr|jduS)zHas an instance been created?rN)hasattrr)r<s rrz!SingletonConfigurable.initialized5ssK(FS]]$-FFr) rrrrrrrrrrrrrrrs_I  **))VGGrr)rrrNcopyrtextwraprtraitlets.traitletsrrrrr r r r r traitlets.utils.textrrloaderrrrrrrr r"r]rrrrrsv5    9LL   - I 9I X )",)"XSG/SGr