B <[?@sdZddlmZmZddlmZddlZddlmZm Z m Z ddl m Z m Z mZmZmZddlmZmZmZGd d d eZGd d d eZGd dde ZGdddeZGdddeZdS)z/A base class for objects that are configurable.)print_functionabsolute_import)deepcopyN)ConfigLazyConfigValue_is_section_key) HasTraitsInstanceobserveobserve_compatdefault)indentdedentwrap_paragraphsc@s eZdZdS)ConfigurableErrorN)__name__ __module__ __qualname__rrfsz.Configurable.section_names..)reversed__mro__)r*r)r*r section_namescszConfigurable.section_namescCs`|g}|jr||j|t}x6|D].}x(|D]}||r8|||q8Wq*W|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_configrr.Z _has_sectionmerge)r"cfgZcfgs my_configr)Zsnamerrrr0js   zConfigurable._find_my_configNc Cs@|dkr|jdd}|dkr$|}||}|x|D]\}}||krt|trrt||}||}t ||t |qDt |sDt|t sDddl m}t|tr|jj} ndd} |||} dj||jjd } t| d kr| d j| dd 7} n(t| d kr&| d jdt| d 7} | | qDWWdQRXdS)z load traits from a Config objectNT)rr)get_close_matchescSstj|ddS)N ) stacklevel)warningswarn)msgrrrsz+Configurable._load_config..z5Config option `{option}` not recognized by `{klass}`.)Zoptionklassrz Did you mean `{matches}`?)matchesz# Did you mean one of: `{matches}`?z, )traitsr.r0Zhold_trait_notificationsr isinstancergetattrZ get_valuer!rrrZdifflibr4LoggingConfigurablelogZwarningformatr&rlenjoinsorted) r"r2r.r=r3nameZ config_valueinitialr4r8r<r9rrrrs2          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. T)r)r=r.N)r=r.rnew)r"Zchanger=r.rrr_config_changeds zConfigurable._config_changedcCs&t|j|_|||j|dS)z%Update config and load the new valuesN)rrrr1)r"rrrr update_configs  zConfigurable.update_configcCs|dkst||stg}|d|j|t|ddx6t|jddD]\}}|||}||qVWd |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. Nz %s optionsr-T)r ) r>AssertionErrorr/rrCrE class_traitsr class_get_trait_helprD)r*instZ final_helpkvhelprrrclass_get_helps zConfigurable.class_get_helpcCs|dkst||stg}d|j|j|jjf}|||dk r`|tdt||jdn^y |}Wnt k rd}YnX|dk rt |dkr|ddd}|td|dd |jjkr|td |j f|j }|d krd t|d }|t|dd |S)zGet the help string for a single trait. If `inst` is given, it's current trait values will be used in place of the class default. Nz --%s.%s=<%s>z Current: %r@=z...z Default: %sEnumz Choices: %rrLL)r>rMrrFr&r/rr?default_value_repr ExceptionrCvaluesrSrDr)r*traitrPlinesheaderdvrrSrrrrOs*      z!Configurable.class_get_trait_helpcCst||dS)z4Get the help string for a single trait and print it.N)printrT)r*rPrrrclass_print_helpszConfigurable.class_print_helpc Csdd}d}ddd|jD}d|j|f}|||dg}|d }|rT|j}|sdt|d d}|r||||dxTt|j d d  D]<\}}|||j |d |j|| f|dqWd|S)z#Get the config class config sectioncSs dt|d}d|ddS)z"return a commented, wrapped block.z Nz## rLz # )rDrreplace)srrrr)sz,Configurable.class_config_section..czO#------------------------------------------------------------------------------,css|] }|jVqdS)N)r)r(prrr sz4Configurable.class_config_section..z# %s(%s) configurationrYZ description__doc__T)rz #c.%s.%s = %srL) rD __bases__rrNrZ default_valuer?r/rEclass_own_traitsr rSr[) r*r)ZbreakerZparent_classesrfr_ZdescrFr^rrrclass_config_sections$   z!Configurable.class_config_sectionc Cs"g}|j}x t|jddD]\}}|jj}|d|j}d|krh|dddd|jD7}n |d|7}||y | }Wnt k rd }YnX|d k rt |d kr|d d d }| d d}|d||d|j pd}|tt|d|dq"Wd|S)zwGenerate rST documentation for this class' config options. Excludes traits defined on parent classes. T)r.rXz : |css|]}t|VqdS)N)repr)r(xrrrri0sz4Configurable.class_config_rst_doc..NrVrWz...z\nz\\nz Default: ``%s``rYzNo descriptionrUrL)rrErlr r&rFrDr]r/r[r\rCrerSrr) r*r_Z classnamerQr^ZttypeZtermlinerarSrrrclass_config_rst_doc s.          z!Configurable.class_config_rst_doc)NN)N)N)N)rrrr rrrr classmethodr.r0rr r rIrJrTrOrcrmrr __classcell__rr)r&rr!s"   =  '    rc@s(eZdZdZedZedddZdS)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. zlogging.LoggerrAcCsddlm}|S)Nr)rA)Z traitletsrAZ get_logger)r"rArrr _log_defaultTs z LoggingConfigurable._log_defaultN)rrrrjr rAr rurrrrr@Lsr@c@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. Nccs8x2|D]&}t||r t|tr |tkr |Vq WdS)zfWalk the cls.mro() for parent classes that are also singletons For use in instance() N)mror'rv)r*subclassrrr _walk_mrods   zSingletonConfigurable._walk_mrocCs4|s dSx"|D]}t|j|rd|_qWdS)z>unset _instance for this class and singleton parents. N) initializedryr> _instance)r*rxrrrclear_instanceqs  z$SingletonConfigurable.clear_instancecOsP|jdkr,|||}x|D] }||_qWt|j|r>|jStd|jdS)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 NzAMultiple incompatible subclass instances of %s are being created.)r{ryr>rr)r*argsr#rPrxrrrinstance}s    zSingletonConfigurable.instancecCst|do|jdk S)zHas an instance been created?r{N)hasattrr{)r*rrrrzsz!SingletonConfigurable.initialized) rrrrjr{rsryr|r~rzrrrrrvZs  -rv)rjZ __future__rrcopyrr7loaderrrrZtraitlets.traitletsr r r r r Zipython_genutils.textrrrr\rrrr@rvrrrrs -