a lcR@sdZddlZddlZddlmZddlmZddlmZm Z m Z m Z m Z m Z mZmZmZddlmZmZddlmZmZmZmZGd d d eZGd d d eZGd dde ZGdddeZGdddeZdS)z/A base class for objects that are configurable.N)deepcopy)dedent) Any ContainerDict HasTraitsInstancedefaultobserveobserve_compatvalidate)indentwrap_paragraphs)ConfigDeferredConfigLazyConfigValue_is_section_keyc@s eZdZdS)ConfigurableErrorN__name__ __module__ __qualname__rrY/var/www/html/django/DPS/env/lib/python3.9/site-packages/traitlets/config/configurable.pyr src@s eZdZdS)MultipleInstanceErrorNrrrrrr$srcseZdZeediZedddZfddZeddZ d d Z dd d Z e de ddZddZed ddZed!ddZed"ddZeddZed#ddZeddZZS)$ Configurablerz*traitlets.config.configurable.ConfigurableT) allow_nonec sdd}|dur4dddur.|jd<||_dd}tjfitfdd}|||dur||_n ||j| |D]}t |||qdS)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. parentNconfigcs|jvr|jdS)zRecord traits set by both config and kwargs. They will need to be overridden again after loading config. N)nameadd)changeZconfig_override_nameskwargsrrnotice_config_overrideZs z5Configurable.__init__..notice_config_override) popgetrrsuper__init__setr _load_configZ unobservesetattr)selfr$rrr%r  __class__r#rr)2s       zConfigurable.__init__csfddtjDS)zreturn section names as a listcs&g|]}t|trt|r|jqSr issubclassrr).0cclsrr }sz.Configurable.section_names..)reversed__mro__r4rr4r section_nameszs zConfigurable.section_namescCsX|g}|jr||j|t}|D]*}|D]}||r4|||q4q(|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. )rappend_find_my_configrr9Z _has_sectionmerge)r-cfgZcfgs my_configr3Zsnamerrrr;s   zConfigurable._find_my_configNc Csn|dur|jdd}|dur$|}||}| |D]\}}||vrt|trtt||}||}nt|t r|||}t ||t |qBt |sBt|t sBddlm}t|tr|jj} ndd} |||} dj||jjd } t| d kr| d | dd 7} n(t| d kr@| d jdt| d7} | | qBWdn1s`0YdS)z load traits from a Config objectNTrr)get_close_matchescSstj|ddS)N ) stacklevel)warningswarn)msgrrrz+Configurable._load_config..z5Config option `{option}` not recognized by `{klass}`.)optionklassrz Did you mean `z`?z# Did you mean one of: `{matches}`?, )matches)traitsr9r;Zhold_trait_notificationsitems isinstancergetattr get_valuerr,rrrdifflibr@LoggingConfigurablelogwarningformatr/rlenjoinsorted) r-r=r9rLr>r Z config_valueinitialr@rDrKrErrrr+s<            zConfigurable._load_configrcCs*|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. Tr?)rLr9N)rLr9r+new)r-r"rLr9rrr_config_changeds zConfigurable._config_changedcCs&t|j|_|||j|dS)z%Update config and load the new valuesN)rrr+r<)r-rrrr update_configs  zConfigurable.update_configcCs|dust||sJg}ddd|jD}||jd|d|t|ddt|jd d D]\}}| ||}||qrd |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. NrJcss|] }|jVqdSN)rr2prrr rGz.Configurable.class_get_help..(z ) optionsr-Tr? ) rNrW __bases__r:rrVrX class_traitsrMclass_get_trait_help)r5instZ final_helpZ base_classes_vhelprrrclass_get_helps  zConfigurable.class_get_helpc Cs|dust||sJg}d|jd|j}t|ttfr|jdd}t|trZd}nd|jj}|dkr|d|d }q|d |d }n|d |jjd }| ||dur|j }|d krd t |d}| t |d|jjvr | t d||dur4| t dt||jn`z |}WntyXd}Yn0|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--. multiplicityr:z=z <%s-item-1>=... z=<>rcLEnumz Choices: %sz Current: @=z Default: %s)rNrr rrmetadatar'r/lowerr:rjrWrr inforOdefault_value_repr ExceptionrV) r5traitrgZhelptextlinesheaderrmZ sample_valuedvrrrrrfs>       z!Configurable.class_get_trait_helpcCst||dS)z4Get the help string for a single trait and print it.N)printrk)r5rgrrrclass_print_help1szConfigurable.class_print_helpcCsF|}|D]4}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`. Tr?N)mror1rZclass_own_traitsr'r )r5r|classesZ defining_clsrrrr_defining_class6s zConfigurable._defining_classc Cs~dd}d}ddd|jD}d|jd|d }|||g}|d }|rX|j}|sht|d d }|r||||d t|jd d D]\}} | } |r| | |} n|} | |ur| j r||| j dt | jvr|d| |d| n<| j r2||| j ddd|d| jd||d|jd|d| |d qd|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. cSs dt|d}d|ddS)z"return a commented, wrapped block.z Nz## rcz # )rWrreplace)srrrr3]sz,Configurable.class_config_section..czO#------------------------------------------------------------------------------rJcss|]}t|tr|jVqdSr]r0r^rrrr`erGz4Configurable.class_config_section..z# raz) configuration description__doc__rrTr?rtz# Choices: %sz# Default: %srcrrz # See also: rlz# c.z = )rWrdrrer' default_valuerOr:rXrMrzrrjtyperysplit) r5rr3breakerZparent_classesrr}descr r|Z default_reprdefining_classrrrclass_config_sectionRs<      z!Configurable.class_config_sectionc Csg}|j}t|jddD]\}}|jj}|d|j}d|vrV|d|7}n |d|7}||z |}Wnt yd}Yn0|durt |dkr|ddd }| d d }|t d ||d |j pd}|t t||d qd|S)zwGenerate rST documentation for this class' config options. Excludes traits defined on parent classes. Tr?rlrtz : Nrurvroz\nz\\nzDefault: ``%s``rrzNo descriptionrc)rrXrerMr/r Zinfo_rstr:rzr{rVrr rjrrW) r5r} classnamerhr|ttypeZtermlinerrjrrrclass_config_rst_docs.          z!Configurable.class_config_rst_doc)NN)N)NN)N)N)rrrrrrrr) classmethodr9r;r+r r r[r\rkrfrrrr __classcell__rrr.rr-s.   H  .   3   ;rc@sBeZdZdZeddZedddZedddZ d d Z d S) rRzA 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)rjrScCs6t|jtjtjfs0t|jjd|jd|jS)Nz..log should be a Logger or LoggerAdapter, got rl) rNvalueloggingLogger LoggerAdapterrCrDr/r)r-Zproposalrrr _validate_logs z!LoggingConfigurable._validate_logcCs(t|jtr|jjSddlm}|S)Nr)rS)rNrrRrSZ traitletsZ get_logger)r-rSrrr _log_defaults  z LoggingConfigurable._log_defaultcCs2|j}t|tjr|j}t|dds(dS|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)rSrNrrloggerrOr)r-rrrr_get_log_handlers   z$LoggingConfigurable._get_log_handlerN) rrrrrrSr rr rrrrrrrRs   rRc@sDeZdZdZdZeddZeddZeddZed d Z 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. Nccs4|D]&}t||rt|tr|tkr|VqdS)zfWalk the cls.mro() for parent classes that are also singletons For use in instance() N)rr1rr5subclassrrr _walk_mros zSingletonConfigurable._walk_mrocCs0|s dS|D]}t|j|rd|_qdS)z5unset _instance for this class and singleton parents.N) initializedrrN _instancerrrrclear_instances   z$SingletonConfigurable.clear_instancecOs\|jdur,||i|}|D] }||_q t|j|r>|jStd|jt|jjfdS)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 NzHAn incompatible sibling of '%s' is already instanciated as singleton: %s)rrrNrrr)r5argsr$rgrrrrinstance s   zSingletonConfigurable.instancecCst|do|jduS)zHas an instance been created?rN)hasattrrr4rrrr5sz!SingletonConfigurable.initialized) rrrrrrrrrrrrrrrs   +r)rrrCcopyrtextwraprZtraitlets.traitletsrrrrrr r r r Ztraitlets.utils.textr rloaderrrrrr{rrrrRrrrrrs  ,  ,