Wh`>UdZddlmZddlmZmZddlZddlmZm Z m Z m Z m Z m Z mZddlZddlmZmZddlmZGdd e ZGd d e ZiZd ed <iZded<iZded<dgZded<GddeeZdZdZd[d\dZ d]d!Z!d^d_d&Z"d[d`d'Z#dad(Z$Gd)d*Z%Gd+d,e eZ&d-Z'd.Z(d/Z)d0Z*e&e e'a+e&e!e(a,e&e#e*a-e&e"e)Z.e%eZ/Gd1d2eZ0 dbdcd;a1 ddded?Z2dfd@Z3dgdBZ4dhdCZ5didDZ6didEZ7djdFZ8dhdGZ9dkdIZ:dldmdNZ;edndPZdpdVZ?dqdXZ@e=eAZBe=eCZDe=eEZFe=eGZHe>eGeIfZJdrdYZKdS)sa The config module holds package-wide configurables and provides a uniform API for working with them. Overview ======== This module supports the following requirements: - options are referenced using keys in dot.notation, e.g. "x.y.option - z". - keys are case-insensitive. - functions should accept partial/regex keys, when unambiguous. - options can be registered by modules at import time. - options can be registered at init-time (via core.config_init) - options have a default value, and (optionally) a description and validation function associated with them. - options can be deprecated, in which case referencing them should produce a warning. - deprecated options can optionally be rerouted to a replacement so that accessing a deprecated option reroutes to a differently named option. - options can be reset to their default value. - all option can be reset to their default value at once. - all options in a certain sub - namespace can be reset at once. - the user can set / get / reset or ask for the description of an option. - a developer can register and mark an option as deprecated. - you can register a callback to be invoked when the option value is set or reset. Changing the stored value is considered misuse, but is not verboten. Implementation ============== - Data is stored using nested dictionaries, and should be accessed through the provided API. - "Registered options" and "Deprecated options" have metadata associated with them, which are stored in auxiliary dictionaries keyed on the fully-qualified key, e.g. "x.y.z.option". - the config_init module is imported by the package's __init__.py file. placing any register_option() calls there will ensure those options are available as soon as pandas is loaded. If you use register_option in a module, it will only be available after that module is imported, which you should be aware of. - `config_prefix` is a context_manager (for use with the `with` keyword) which can save developers some typing, see the docstring. ) annotations)ContextDecoratorcontextmanagerN)AnyCallableGenericIterableIterator NamedTuplecast)FT)find_stack_levelc8eZdZUded<ded<ded<ded<dS)DeprecatedOptionstrkey str | Nonemsgrkey removal_verN__name__ __module__ __qualname____annotations__[/var/www/html/movieo_spanner_bot/venv/lib/python3.11/site-packages/pandas/_config/config.pyrrLs< HHHOOOrrcBeZdZUded<ded<ded<ded<ded <d S) RegisteredOptionrrobjectdefvaldocCallable[[object], Any] | None validatorCallable[[str], Any] | NonecbNrrrrr!r!SsE HHHNNN HHH----######rr!zdict[str, DeprecatedOption]_deprecated_optionszdict[str, RegisteredOption]_registered_optionsdict[str, Any]_global_configall list[str]_reserved_keysceZdZdZdS) OptionErrorz^ Exception raised for pandas.options. Backwards compatible with KeyError checks. N)rrr__doc__rrrr1r1hsrr1patrsilentboolreturnc>t|}t|dkr0|st|tdt |t|dkrtd|d}|st|t |}|S)NrzNo such keys(s): zPattern matched multiple keys)_select_optionslen_warn_if_deprecatedr1repr_translate_key)r3r4keysrs r_get_single_keyr?ts 3  D 4yyA~~ %  $ $ $9d3ii99::: 4yy1}}9::: q'C !C     C JrFrcVt||}t|\}}||SN)r? _get_root)r3r4rrootks r _get_optionrEs+ #v & &CnnGD! 7NrNonect|}|r |dzdkrtd|dd}|r:t|d}t d|dt |ddd|dddD]\}}t||}t|}|r|j r| |t|\} }|| |<|j rZ|rCtj d 5| |dddn #1swxYwY| |dS) Nrz4Must provide an even number of non-keyword argumentsr4Fz2_set_option() got an unexpected keyword argument ""r8T)record)r: ValueErrorpoplistr> TypeErrorzipr?_get_registered_optionr&rBr(warningscatch_warnings) argskwargsnargsr4kwargrDvrorCs r _set_optionrYs IIE QEAINNOPPPZZ% ( (F WV[[]]##A&UUUUUVVVD1ItADqDz**1a(( "3 ' '    KKNNNC..aQ 4  ,D999DDIIIS !sD77D; >D; T _print_descrct|}t|dkrtddd|D}|rt |dS|S)NrNo such keys(s) c,g|]}t|Sr)_build_option_description).0rDs r z$_describe_option..s!>>>A,Q//>>>r)r9r:r1joinprint)r3r[r>ss r_describe_optionrfsj 3  D 4yyA~~+,,, >>>>>??A at Hrc,t|}t|dkrtdt|dkr(t|dkr|dkrtd|D]$}t |t |j|%dS)Nrr]r8r-zYou must specify at least 4 characters when resetting multiple keys, use the special keyword "all" to reset all the options to their default valuer4)r9r:r1rKrYr*r#)r3r4r>rDs r _reset_optionrjs 3  D 4yyA~~+,,, 4yy1}}SA#,, D   EEA*1-4VDDDDDEErcLt|d}t|jSNTri)r?rPr#)r3rs rget_default_valrms% #d + + +C !# & & --rc4eZdZdZddd Zdd ZddZddZdS) DictWrapperz/provide attribute-style access to a nested dictrZdr+prefixrr6rFcvt|d|t|d|dS)Nrprq)r" __setattr__)selfrprqs r__init__zDictWrapper.__init__s84a(((4622222rrvalrct|d}|r|dz }||z }||jvr2t|j|tst ||dSt d)Nrq.z.You can only set the value of existing options)r"__getattribute__rp isinstancedictrYr1)rtrrvrqs rrszDictWrapper.__setattr__sw((x88   cMF#  $&==DF3K!>!>=  $ $ $ $ $NOO OrcBt|d}|r|dz }||z } t|d|}n"#t$r}td|d}~wwxYwt |t rt ||St|S)NrqrxrpzNo such option)r"ryKeyErrorr1rzr{rorE)rtrrqrWerrs r __getattr__zDictWrapper.__getattr__s((x88   cMF#  9''c2237AA 9 9 9.//S 8 9 a   'q&)) )v&& &s!A A*A%%A* Iterable[str]cNt|jSrA)rMrpr>)rts r__dir__zDictWrapper.__dir__sDFKKMM"""rN)rZ)rpr+rqrr6rF)rrrvrr6rFrr)r6r)rrrr2rursrrrrrroross9933333 P P P P ' ' ' '######rroc6eZdZd dZd d Zedd Zd S)CallableDynamicDocfuncCallable[..., T]doc_tmplrr6rFc"||_||_dSrA) __doc_tmpl____func__)rtrrs rruzCallableDynamicDoc.__init__s$ rrc|j|i|SrA)r)rtrSkwdss r__call__zCallableDynamicDoc.__call__st}d+d+++rctdd}ttt}|j||S)Nr-F)r[) opts_desc opts_list)rfpp_options_listrMr*r>rformat)rtrrs rr2zCallableDynamicDoc.__doc__ sR$U>>> #D)<)A)A)C)C$D$DEE  '')y'QQQrN)rrrrr6rF)r6r)r6r)rrrrurpropertyr2rrrrrsb,,,,RRRXRRRrra get_option(pat) Retrieves the value of the specified option. Available options: {opts_list} Parameters ---------- pat : str Regexp which should match a single option. Note: partial matches are supported for convenience, but unless you use the full option name (e.g. x.y.z.option_name), your code may break in future versions if new options with similar names are introduced. Returns ------- result : the value of the option Raises ------ OptionError : if no such option exists Notes ----- Please reference the :ref:`User Guide ` for more information. The available options with its descriptions: {opts_desc} a set_option(pat, value) Sets the value of the specified option. Available options: {opts_list} Parameters ---------- pat : str Regexp which should match a single option. Note: partial matches are supported for convenience, but unless you use the full option name (e.g. x.y.z.option_name), your code may break in future versions if new options with similar names are introduced. value : object New value of option. Returns ------- None Raises ------ OptionError if no such option exists Notes ----- Please reference the :ref:`User Guide ` for more information. The available options with its descriptions: {opts_desc} a describe_option(pat, _print_desc=False) Prints the description for one or more registered options. Call with no arguments to get a listing for all registered options. Available options: {opts_list} Parameters ---------- pat : str Regexp pattern. All matching keys will have their description displayed. _print_desc : bool, default True If True (default) the description(s) will be printed to stdout. Otherwise, the description(s) will be returned as a unicode string (for testing). Returns ------- None by default, the description(s) as a unicode string if _print_desc is False Notes ----- Please reference the :ref:`User Guide ` for more information. The available options with its descriptions: {opts_desc} a} reset_option(pat) Reset one or more options to their default value. Pass "all" as argument to reset all options. Available options: {opts_list} Parameters ---------- pat : str/regex If specified only options matching `prefix*` will be reset. Note: partial matches are supported for convenience, but unless you use the full option name (e.g. x.y.z.option_name), your code may break in future versions if new options with similar names are introduced. Returns ------- None Notes ----- Please reference the :ref:`User Guide ` for more information. The available options with its descriptions: {opts_desc} c*eZdZdZddZddZddZdS) option_contexta Context manager to temporarily set options in the `with` statement context. You need to invoke as ``option_context(pat, val, [(pat, val), ...])``. Examples -------- >>> with option_context('display.max_rows', 10, 'display.max_columns', 5): ... pass r6rFc t|dzdkst|dkrtdtt|ddd|ddd|_dS)NrHrz>Need to invoke as option_context(pat, val, [(pat, val), ...]).r8)r:rKrMrOops)rtrSs rruzoption_context.__init__sm t99q=A  TQP D1ItADqDz2233rcpd|jD|_|jD]\}}t||ddS)Nc:g|]\}}|t|dfS)Tri)rE)rar3rvs rrbz,option_context.__enter__..s.SSShc3c;s48889SSSrTri)rundorY)rtr3rvs r __enter__zoption_context.__enter__sPSS$(SSS  / /HC S . . . . . / /rcV|jr|jD]\}}t||ddSdSrl)rrY)rtrSr3rvs r__exit__zoption_context.__exit__sM 9 3 I 3 3SCT22222 3 3 3 3rNr6rF)rrrr2rurrrrrrrsZ  4444//// 333333rrrr#r"r$r&r%r(r'c ddl}ddl}|}|tvrt d|d|t vrt d|d|r |||d}|D][}tjd|j zdz|st|d | |rt|d \t} d } t|dd D]i\} } t| ts>t | d|d|  | | vri| | <| | } jt| ts>t | d|dd  || |d <t%|||||t|<dS)a Register an option in the package-wide pandas config object Parameters ---------- key : str Fully-qualified key, e.g. "x.y.option - z". defval : object Default value of the option. doc : str Description of the option. validator : Callable, optional Function of a single argument, should raise `ValueError` if called with a value which is not a legal value for the option. cb a function of a single argument "key", which is called immediately after an option value is set/reset. key is the full name of the option. Raises ------ ValueError if `validator` is specified and `defval` is not a valid value. rNOption 'z' has already been registeredz' is a reserved keyrx^$z is not a valid identifierz is a python keywordz5Path prefix to option '{option}' is already an option)option)rr#r$r&r()keywordtokenizelowerr*r1r/splitrematchNamerK iskeywordr, enumeraterzr{rrcr!) rr#r$r&r(rrpathrDcursorrips rregister_optionrs>NNNOOO ))++C !!!GSGGGHHH n=S===>>> & 99S>>D 99xhm+c1155 ?===>> >   Q   977788 8 9F AC$ss)$$1&$'' Ecjjbqb0B0BjCCDD D F??F1I fd # #B#**CHHT#2#Y,?,?*@@AAAF48 0 C9   rrrrc|}|tvrtd|dt||||t|<dS)a Mark option `key` as deprecated, if code attempts to access this option, a warning will be produced, using `msg` if given, or a default message if not. if `rkey` is given, any access to the key will be re-routed to `rkey`. Neither the existence of `key` nor that if `rkey` is checked. If they do not exist, any subsequence access will fail as usual, after the deprecation warning is given. Parameters ---------- key : str Name of the option to be deprecated. must be a fully-qualified option name (e.g "x.y.z.rkey"). msg : str, optional Warning message to output when the key is referenced. if no message is given a default message will be emitted. rkey : str, optional Name of an option to reroute access to. If specified, any referenced `key` will be re-routed to `rkey` including set/get/reset. rkey must be a fully-qualified option name (e.g "x.y.z.rkey"). used by the default message if no `msg` is specified. removal_ver : str, optional Specifies the version in which this option will be removed. used by the default message if no `msg` is specified. Raises ------ OptionError If the specified key has already been deprecated. rz)' has already been defined as deprecated.N)rr)r1r)rrrrs rdeprecate_optionrsWN ))++C !!!SSSSSTTT/S$ LLrctvrgStt}dkr|Sfd|DS)zb returns a list of keys matching `pat` if pat=="all", returns all registered options r-cTg|]$}tj|tj"|%Sr)rsearchI)rarDr3s rrbz#_select_options..Rs. 7 7 7!rya66 7A 7 7 7r)r*sortedr>)r3r>s` rr9r9Cs\ !!!u  %**,, - -D e|| 7 7 7 7t 7 7 77rtuple[dict[str, Any], str]cx|d}t}|ddD] }||} ||dfS)Nrxr)rr,)rrrrs rrBrBUsG 99S>>D F #2#Y 48 rc<|}|tvS)z4Returns True if the given option has been deprecated)rr)rs r_is_deprecatedr]s ))++C % %%rcD t|}|S#t$rYdSwxYw)z Retrieves the metadata for a deprecated option, if `key` is deprecated. Returns ------- DeprecatedOption (namedtuple) if key is deprecated, None otherwise N)r)r}rrps r_get_deprecated_optionrcs<  $ tts  c6t|S)z Retrieves the option metadata if `key` is a registered option. Returns ------- RegisteredOption (namedtuple) if key is deprecated, None otherwise )r*getrs rrPrPss  " "3 ' ''rc:t|}|r |jp|S|S)z if key id deprecated and a replacement key defined, will return the replacement key, otherwise returns `key` as - is )rrrs rr=r=~s* s##Av} rcPt|}|r|jr.tj|jtt n]d|d}|jr |d|jz }|jr|d|jdz }n|dz }tj|tt dSd S) z Checks if `key` is a deprecated option and if so, prints a warning. Returns ------- bool - True if `key` is deprecated, False otherwise. ) stacklevel'z' is deprecatedz and will be removed in z, please use 'z ' instead.z, please refrain from using it.TF)rrrQwarn FutureWarningrrr)rrprs rr;r;s s##A 5 M M+--      +c***C} BA!-AAAv 9:::::88 M#}9I9K9K L L L Lt 5rrDcht|}t|}|d}|jrC|d|jdz }n|dz }|r|d|jdt|ddz }|r|jpd}|d z }|d |d z }|d z }|S) zCBuilds a formatted description of a registered option and prints it r^zNo description available.z [default: z] [currently: T]rZz (Deprecatedz, use `z ` instead.)) rPrr$rcstriprr#rEr)rDrXrprers rr`r`sq!!Aq!!A Au) TYYqu{{}}**400 1 11 ((P O O O At8L8L O O OOv|   't ' ' '' S HrPr>r_printc ddlm}ddlm d fd }g}d t |D}|r||d |z }d |D}|t |dD]/\ } fdt |D}|| |z }0d|} |rt| dS| S)z@Builds a concise listing of available options, grouped by prefixr)groupby)wrapnamerksrr6r.c|rd|zdznd}d||dd}|r|dr|r|dd z|d<|S) Nz- z.[rZz, z F)initial_indentsubsequent_indentbreak_long_wordsrr)rc)rrpfxlswidthrs rppzpp_options_list..pps|$(0dTkD  b T IIbMM ""      ""R& "T "Vc\BrF rcDg|]}|ddk|Srxrfindraxs rrbz#pp_options_list..s':::Q!&&++//q///rrZcDg|]}|ddk|Srrrs rrbz#pp_options_list..s, 0 0 0!qvvc{{a//A///rc<|d|dSNrx)rfind)rs rz!pp_options_list..s.AGGCLL.0ArcDg|]}|tdzdS)r8N)r:)rarrDs rrbz#pp_options_list..s+ / / /!aA o / / /rr^N)rrrrr6r.) itertoolsrtextwraprrrMrcrd) r>rrrrrsinglesgrrerDrs ` @@rrrs#!!!!!!       B::&,,:::G bbWoo 0 0t 0 0 0Dt &A&ABB1 / / / /tAww / / / bbBii " A  arIterator[None]c#Kdfd }t}t}t}|ta|ta|ta dV|a|a|adS#|a|a|awxYw)a contextmanager for multiple invocations of API with a common prefix supported API functions: (register / get / set )__option Warning: This is not thread - safe, and won't work properly if you import the API functions into your module using the "from x import y" construct. Example ------- import pandas._config.config as cf with cf.config_prefix("display.font"): cf.register_option("color", "red") cf.register_option("size", " 5 pt") cf.set_option(size, " 6 pt") cf.get_option(size) ... etc' will register options "display.font.color", "display.font.size", set the value of "display.font.size"... and so on. rr r6c>dfd }tt|S)Nrrc*d|}|g|Ri|Srr)rrSrpkeyrrqs rinnerz*config_prefix..wrap..inners6$$s$$D4,t,,,t,, ,rr)r r )rrrqs` rrzconfig_prefix..wraps7 - - - - - - -Au~~rN)rr r6r )r get_option set_option)rqr_register_optionrErYs` r config_prefixrs<'KKj!!Jj!!Jd?++O+   *!  *****s AA$_type type[Any]Callable[[Any], None]cdfd }|S)a Parameters ---------- `_type` - a type to be compared against (e.g. type(x) == `_type`) Returns ------- validator - a function of a single argument x , which raises ValueError if type(x) is not equal to `_type` r6rFcTt|krtdddS)NzValue must have type 'r)typerK)rrs rrzis_type_factory..inner+s6 77e  >e>>>?? ?  rrr)rrs` ris_type_factoryrs.@@@@@@ Lrctttfr8tdt t ndddfd }|S)z Parameters ---------- `_type` - the type to be checked against Returns ------- validator - a function of a single argument x , which raises ValueError if x is not an instance of `_type` |rr6rFcLt|stddS)NzValue must be an instance of )rzrK)rr type_reprs rrz"is_instance_factory..innerEs9!U## JHYHHII I J Jrr)rztuplerMrcmapr)rrrs` @ris_instance_factoryr2s%%''!e HHSe__--  LLL JJJJJJJ LrcHdDdDdfd }|S)Nc0g|]}t||Srcallableracs rrbz%is_one_of_factory..Ns#888qHQKK8888rc0g|]}t||Srr r s rrbz%is_one_of_factory..Os#???!8A;;?A???rr6rFcvrdtfdDsKdD}d|}d|}tr|dz }t|dSdS)Nc3.K|]}|VdSrAr)rar rs r z3is_one_of_factory..inner..Ts+//qqtt//////rc,g|]}t|Sr)r)ralvals rrbz4is_one_of_factory..inner..Us<<.innerQs L ////Y///// &<<|<<<HHUOO 9i99y>>,++C oo% !  & &rrr)rrrs` @ris_one_of_factoryrLsT88L888I??|???L & & & & & & & Lrvaluecf|dSt|tr|dkrdSd}t|)z Verify that value is None or a positive int. Parameters ---------- value : None or int The `value` to be checked. Raises ------ ValueError When the value is not None or is a negative integer Nrz+Value must be a nonnegative integer or None)rzintrK)rrs ris_nonnegative_intr_s? } E3   A:: F 7C S//rcBt|stddS)z Parameters ---------- `obj` - the object to be checked Returns ------- validator - returns True if object is callable raises ValueError otherwise. zValue must be a callableT)r rK)objs r is_callablers& C==53444 4r)r3rr4r5r6r)F)r3rr4r5r6rr)rZT)r3rr[r5r6r)r3rr4r5r6rF)r3r)rZNN) rrr#r"r$rr&r%r(r'r6rF)NNN) rrrrrrrrr6rF)r3rr6r.)rrr6r)rrr6r5r)rrr6r)rDrr6r)rF)r>rrr5)r6r)rrr6r)r6r)rr"r6rF)r6r5)Lr2 __future__r contextlibrrrtypingrrrr r r r rQpandas._typingr rpandas.util._exceptionsrrr!r)rr*r,r/AttributeErrorr}r1r?rErYrfrjrmror_get_option_tmpl_set_option_tmpl_describe_option_tmpl_reset_option_tmplrr reset_optiondescribe_optionoptionsrrrr9rBrrrPr=r;r`rrrrrrris_intr5is_boolfloatis_floatris_strbytesis_textrrrrr4sV000d#""""" 544444z$$$$$z$$$465555465555"$#####G####.($@      EEEEE$.... "#"#"#"#"#"#"#"#\ R R R R R R R R D"H DD  -= > >   -= > > !!-1CDD $$%57LMM +n % % 33333%333F04&* HHHHHZ" ,M,M,M,M,Mf8888$&&&&     ((((    <    0L/+/+/+/+l*4&6    /$   ?5 ! !     sEl + +r