o BZhW@s0dZddlmZddlZddlZddlmZddlm Z ddl m Z m Z m Z mZmZmZmZmZmZmZddlmZddlmZdd lmZmZd d lmZmZmZm Z ej!rdej"ej#ej$ej fZ%nej Z%Gd d d e&Z'Gddde'Z(GdddeZ)Gddde)Z*ej+dddZ,Gddde*Z-dS)z/A base class for objects that are configurable.) annotationsN)deepcopy)dedent) Any ContainerDict HasTraitsInstance TraitTypedefaultobserveobserve_compatvalidate)warnings)Bunch)indentwrap_paragraphs)ConfigDeferredConfigLazyConfigValue_is_section_keyc@ eZdZdS)ConfigurableErrorN__name__ __module__ __qualname__rrT/var/www/html/lang_env/lib/python3.10/site-packages/traitlets/config/configurable.pyr(rc@r)MultipleInstanceErrorNrrrrrr!,r r!cseZdZeediZedddZd7fd d Zed8d d Z d9ddZ  d:d;ddZ e de dd?d#d$Ze  d:d@d)d*Zed>dAd+d,ZedBd0d1Zed>dCd3d4ZedDd5d6ZZS)E Configurablerz*traitlets.config.configurable.ConfigurableT) allow_nonekwargst.AnyreturnNonec sdd}|durdddur|jd<||_dd}tjd itd fdd }|||durA||_n||j| |D] }t |||qNdS) 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. parentNconfigchangerr&r'cs|jvr |jdSdS)zRecord traits set by both config and kwargs. They will need to be overridden again after loading config. N)nameadd)r*Zconfig_override_namesr$rrnotice_config_overrideas z5Configurable.__init__..notice_config_overriderr*rr&r') popgetr)r(super__init__setr _load_configZ unobservesetattr)selfr$r(r)r.r+ __class__r-rr39s"      zConfigurable.__init__ list[str]csfddtjDS)zreturn section names as a listcs&g|]}t|trt|r|jqSr issubclassr"r).0cclsrr sz.Configurable.section_names..)reversed__mro__r?rr?r section_namess zConfigurable.section_namescfgrcCsX|g}|jr||j|t}|D]}|D]}||r(|||qq|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_configrrDZ _has_sectionmerge)r7rEZcfgs my_configr>ZsnamerrrrGs   zConfigurable._find_my_configNrDlist[str] | Nonetraits)dict[str, TraitType[t.Any, t.Any]] | Nonec Csz|dur |jdd}|dur|}||}||D]\}}||vrMt|tr8t||}||}n t|t rD|||}t ||t |q t |st|t sddlm}t|trm|jdushJ|jj} ndd d } |||} d |d |jjd} t| dkr| d| dd7} nt| dkr| djdt| d7} | | q WddS1swYdS)z load traits from a Config objectNTr)r)get_close_matchesmsgr%r&r'cSstj|tddS)N  stacklevel)rwarn UserWarning)rOrrrrSsz'Configurable._load_config..warnzConfig option `z` not recognized by `z`.rz Did you mean `z`?z# Did you mean one of: `{matches}`?, )matches)rOr%r&r')rKrDrGZhold_trait_notificationsitems isinstancergetattr get_valuerr6rrrdifflibrNLoggingConfigurablelogwarningr9rlenformatjoinsorted) r7rErDrKrIr+Z config_valueinitialrNrSrVrOrrrr5s@               "zConfigurable._load_configr)r*rcCs*|jdd}|}|j|j||ddS)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. TrM)rKrDN)rKrDr5new)r7r*rKrDrrr_config_changeds zConfigurable._config_changedcCs&t|j|_|||j|dS)z%Update config and load the new valuesN)rr)r5rH)r7r)rrr update_configs  zConfigurable.update_configinstHasTraits | NonestrcCs|dus t||s Jg}ddd|jD}||jd|d|t|ddt|jd d D]\}}| ||}||q9d |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. NrUcss|]}|jVqdSN)rr=prrr sz.Configurable.class_get_help..(z ) optionsr-TrM ) rXra __bases__rFrr_rb class_traitsrWclass_get_trait_help)r@rgZ final_helpZ base_classes_vhelprrrclass_get_helps   zConfigurable.class_get_helptraitTraitType[t.Any, t.Any]helptext str | Nonec Cs|dus t||s Jg}d|jd|j}t|ttfrK|jdd}t|tr-d}nd|jj}|dkrB|d|d }n|d |d }n |d |jjd }| ||dura|j }|d krtd t |d}| t |d|jjvr| t d||dur| t dt||jpd n-z|}Wn tyd}Ynw|durt|dkr|ddd }| t d|d |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--. multiplicityrFz=z <%s-item-1>=... z=<>rpLEnumz Choices: %sz Current: @=z Default: %s)rXrr+rrmetadatar1r9lowerrFrvrarrinforYdefault_value_repr Exceptionr_) r@rxrgrzlinesheaderr}Z sample_valuedvrrrrrs s@   "    z!Configurable.class_get_trait_helpcCst||dS)z4Get the help string for a single trait and print it.N)printrw)r@rgrrrclass_print_helpDszConfigurable.class_print_helpclassest.Sequence[type[HasTraits]]type[Configurable]cCsT|}|jdus J|D]}t|tr'||vr'|jdd|jd|ur'|}q |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`. NTrM)r+mror<r"Zclass_own_traitsr1)r@rxrZ defining_clsr(rrr_defining_classIs zConfigurable._defining_class"t.Sequence[type[HasTraits]] | Nonec Cs|ddd}d}ddd |jD}d |jd |d }|||g}|d }|r-|j}|s5t|dd}|rC||||dt|jdd D]k\}} | } |r^| | |} n|} | |ur| j ro||| j dt | jvr|d| |d| n| j r||| j ddd|d| jd||d|jd|d| |dqMd|S)zGet the config section for this class. Parameters ---------- classes : list, optional The list of other classes in the config file. Used to reduce redundant information. srir&cSs dt|d}d|ddS)z"return a commented, wrapped block.z Nz## rpz # )rarreplace)rrrrr>ssz,Configurable.class_config_section..czO#------------------------------------------------------------------------------rUcss |] }t|tr|jVqdSrjr;rkrrrrm{sz4Configurable.class_config_section..z# rnz) configuration description__doc__rTrMrz# Choices: %sz# Default: %srprrz # See also: r|z# c.z = N)rrir&ri)rarqrrrr1 default_valuerYrFrbrWrrrvtypersplit) r@rr>breakerZparent_classesrrZdescr+rxZ default_reprdefining_classrrrclass_config_sectionhs<      z!Configurable.class_config_sectionc Csg}|j}t|jddD]v\}}|jj}|jsq|d|j}d|vr/|d|7}n|d|7}||z|}Wn t yKd}Ynw|durrt |dkr^|ddd }| d d }|t d ||d |j pvd}|t t||d qd|S)zwGenerate rST documentation for this class' config options. Excludes traits defined on parent classes. TrMr|rz : Nrrrz\nz\\nzDefault: ``%s``rzNo descriptionrp)rrbrrrWr9r+Zinfo_rstrFrrr_rrrvrra) r@r classnamertrxttypeZtermlinerrvrrrclass_config_rst_docs4          z!Configurable.class_config_rst_doc)r$r%r&r')r&r:)rErr&r%)NN)rErrDrJrKrLr&r'r/)r)rr&r'rj)rgrhr&ri)rxryrgrhrzr{r&ri)rgrhr&r')rxryrrr&r)rrr&ri)r&ri)rrrr rr)r(r3 classmethodrDrGr5r r rerfrwrsrrrr __classcell__rrr8rr"5s8  H   5 8 ;r"c@sJeZdZdZedddZeddd d Zeddd d Z dddZ dS)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 instanceF)rvr#r]proposalrr& LoggerTypecCsDt|jtjtjfstj|jjd|jdt ddt t |jS)Nz..log should be a Logger or LoggerAdapter, got r|rQ) rXvalueloggingLogger LoggerAdapterrrSr9rrTtcastr)r7rrrr _validate_logs z!LoggingConfigurable._validate_logcCs@t|jtr|jdus Jttj|jjSddlm}| S)Nr)r]) rXr(r\rrrrr]Z traitletsZ get_logger)r7r]rrr _log_defaults  z LoggingConfigurable._log_defaultlogging.Handler | NonecCs@|jsdSt|jtjr|jn|jj}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. Nhandlersr)r]rXrrloggerrYr)r7rrrr_get_log_handlers  z$LoggingConfigurable._get_log_handlerN)rrr&r)r&r)r&r) rrrrrr]rrr rrrrrrr\s   r\CTSingletonConfigurable)boundc@sLeZdZdZdZedddZeddd ZedddZedddZ dS)rzA 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. Nr&4t.Generator[type[SingletonConfigurable], None, None]ccs6|D]}t||rt|tr|tkr|VqdS)zfWalk the cls.mro() for parent classes that are also singletons For use in instance() N)rr<rr@subclassrrr _walk_mros zSingletonConfigurable._walk_mror'cCs0|sdS|D] }t|j|rd|_q dS)z5unset _instance for this class and singleton parents.N) initializedrrX _instancerrrrclear_instances  z$SingletonConfigurable.clear_instancer@type[CT]argsr%r$rcOs\|jdur||i|}|D]}||_qt|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 retrieved 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 instantiated as singleton: )rrrXr!rr)r@rr$rgrrrrinstance)s     zSingletonConfigurable.instanceboolcCst|do |jduS)zHas an instance been created?rN)hasattrrr?rrrrUsz!SingletonConfigurable.initialized)r&r)r&r')r@rrr%r$r%r&r)r&r) rrrrrrrrrrrrrrrs   +).r __future__rrtypingrcopyrtextwraprZtraitlets.traitletsrrrrr r r r r rZtraitlets.utilsrZtraitlets.utils.bunchrZtraitlets.utils.textrrloaderrrrr TYPE_CHECKINGUnionrrrrrr!r"r\TypeVarrrrrrrs.   0  1