o ȷe R@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@ eZdZdS)ConfigurableErrorN__name__ __module__ __qualname__rrT/var/www/ideatree/venv/lib/python3.10/site-packages/traitlets/config/configurable.pyr rc@r)MultipleInstanceErrorNrrrrrr$rrcseZdZeediZedddZfddZeddZ d d Z dd d Z e de ddZddZed ddZedddZed ddZeddZed ddZeddZZS)! Configurablerz*traitlets.config.configurable.ConfigurableT) allow_nonec sdd}|durdddur|jd<||_dd}tjditfdd}|||dur@||_n||j| |D] }t |||qMdS)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 |jdSdS)zRecord traits set by both config and kwargs. They will need to be overridden again after loading config. N)nameadd)changeconfig_override_nameskwargsrrnotice_config_overrideZs z5Configurable.__init__..notice_config_overrider) popgetr!r super__init__setr _load_config unobservesetattr)selfr'r r!r(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__r8rr8r section_nameszs zConfigurable.section_namescCsX|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_configrr= _has_sectionmerge)r1cfgcfgs my_configr7snamerrrr?s   zConfigurable._find_my_configNc Csf|dur |jdd}|dur|}||}||D]\}}||vrMt|tr8t||}||}n t|t rD|||}t ||t |q t |st|t sddlm}t|trf|jj} ndd} |||} dj||jjd } t| d kr| d | dd 7} nt| d kr| d jdt| d7} | | q WddS1swYdS)z load traits from a Config objectNTr!r)get_close_matchescSstj|ddS)N ) stacklevel)warningswarn)msgrrrsz+Configurable._load_config..z5Config option `{option}` not recognized by `{klass}`.)optionklassrz Did you mean `z`?z# Did you mean one of: `{matches}`?, )matches)traitsr=r?hold_trait_notificationsitems isinstancergetattr get_valuerr0rrrdifflibrGLoggingConfigurablelogwarningformatr3rlenjoinsorted) r1rBr=rRrDr" config_valueinitialrGrKrQrLrrrr.sB              "zConfigurable._load_configr!cCs*|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. TrF)rRr=N)rRr=r.new)r1r$rRr=rrr_config_changeds zConfigurable._config_changedcCs&t|j|_|||j|dS)z%Update config and load the new valuesN)rr!r.rA)r1r!rrr update_configs  zConfigurable.update_configcCs|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, it's current trait values will be used in place of class defaults. NrPcss|]}|jVqdSN)rr6prrr sz.Configurable.class_get_help..(z ) optionsr-TrF ) rUr^ __bases__r>rr]r_ class_traitsrTclass_get_trait_help)r9inst final_help base_classes_vhelprrrclass_get_helps   zConfigurable.class_get_helpc 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||jn-z|}Wn tyd}Ynw|durt|dkr|ddd }| t d|d |S)aGet the helptext string for a single trait. :param inst: If given, it's 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=<>rkLEnumz Choices: %sz Current: @=z Default: %s)rUrr"rrmetadatar*r3lowerr>rtr^rr inforVdefault_value_repr Exceptionr]) r9traitrohelptextlinesheaderrw sample_valuedvrrrrrns@        z!Configurable.class_get_trait_helpcCst||dS)z4Get the help string for a single trait and print it.N)printru)r9rorrrclass_print_help1szConfigurable.class_print_helpcCsF|}|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`. TrFN)mror5rclass_own_traitsr*r")r9rclasses defining_clsr rrr_defining_class6s zConfigurable._defining_classc Cszdd}d}ddd|jD}d|jd|d }|||g}|d }|r,|j}|s4t|d d }|rB||||d t|jd d D]k\}} | } |r]| | |} n|} | |ur| j rn||| j dt | jvr~|d| |d| n| j r||| j ddd|d| jd||d|jd|d| |d qLd|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## rkz # )r^rreplace)srrrr7]sz,Configurable.class_config_section..czO#------------------------------------------------------------------------------rPcss |] }t|tr|jVqdSrer4rfrrrrhesz4Configurable.class_config_section..z# riz) configuration description__doc__r|TrFr~z# Choices: %sz# Default: %srkrrz # See also: rvz# c.z = )r^rlrrmr* default_valuerVr>r_rTrrrttypersplit) r9rr7breakerparent_classesrrdescr"r default_reprdefining_classrrrclass_config_sectionRs<      z!Configurable.class_config_sectionc Csg}|j}t|jddD]r\}}|jj}|d|j}d|vr+|d|7}n|d|7}||z|}Wn t yGd}Ynw|durnt |dkrZ|ddd }| d d }|t d ||d |j prd}|t t||d qd|S)zwGenerate rST documentation for this class' config options. Excludes traits defined on parent classes. TrFrvr~z : Nrrryz\nz\\nzDefault: ``%s``r|zNo descriptionrk)rr_rmrTr3r"info_rstr>rrr]rr rtrr^) r9r classnamerrrttypetermlinerrtrrrclass_config_rst_docs0          z!Configurable.class_config_rst_doc)NNre)rrrrrr!r r, classmethodr=r?r.r r rcrdrurnrrrr __classcell__rrr2rr-s0   H  .   3   ;rc@sBeZdZdZeddZedddZedddZ d d Z d S) rYzA 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)rtrZcCs6t|jtjtjfst|jjd|jd|jS)Nz..log should be a Logger or LoggerAdapter, got rv) rUvalueloggingLogger LoggerAdapterrJrKr3r)r1proposalrrr _validate_logs z!LoggingConfigurable._validate_logcCs(t|jtr |jjSddlm}|S)Nr)rZ)rUr rYrZ traitlets get_logger)r1rZrrr _log_defaults  z LoggingConfigurable._log_defaultcCs2|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)rZrUrrloggerrVr)r1rrrr_get_log_handlers    z$LoggingConfigurable._get_log_handlerN) rrrrrrZr rr rrrrrrrYs    rYc@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. Nccs6|D]}t||rt|tr|tkr|VqdS)zfWalk the cls.mro() for parent classes that are also singletons For use in instance() N)rr5rr9subclassrrr _walk_mros zSingletonConfigurable._walk_mrocCs0|sdS|D] }t|j|rd|_q dS)z5unset _instance for this class and singleton parents.N) initializedrrU _instancerrrrclear_instances  z$SingletonConfigurable.clear_instancecOsX|jdur||i|}|D]}||_qt|j|r|jStd|jt|jjf)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)rrrUrrr)r9argsr'rorrrrinstance s   zSingletonConfigurable.instancecCst|do |jduS)zHas an instance been created?rN)hasattrrr8rrrr5sz!SingletonConfigurable.initialized) rrrrrrrrrrrrrrrs   +r)rrrJcopyrtextwraprtraitlets.traitletsrrrrrr r r r traitlets.utils.textr rloaderrrrrrrrrrYrrrrrs   ,  ,