MhncL%SrSSKJr SSKJrJr SSKrSSKJrJ r J r J r J r J r SSKrSSKJrJr SSKJr \(aSSKJrJr "S S \ 5r"S S \ 5r0rS \S'0rS\S'0rS\S'S/rS\S'"SS\\5r S9Sjr!S:S;Sjjr"SSjjr$S:S?Sjjr%S@Sjr&"SS5r'"S S!\ \5r(S"r)S#r*S$r+S%r,\("\"\)5q-\("\#\*5q.\("\%\,5r/\("\$\+5r0\'"\5r1"S&S'\5r2SASBS(jjq3SCSDS)jjr4SES*jr5SFS+jr6SGS,jr7SHS-jr8SHS.jr9SIS/jr:SGS0jr;SJS1jrSNS4jr?SOS5jr@SOS6jrASPS7jrB\?"\C5rD\?"\E5rF\?"\G5rH\?"\I5rJ\@"\I\K45rLSQS8jrMg)Ra 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) TYPE_CHECKINGAnyCallableGeneric NamedTuplecast)FT)find_stack_level) GeneratorIterablec>\rSrSr%S\S'S\S'S\S'S\S'Srg ) DeprecatedOptionQstrkey str | Nonemsgrkey removal_verN__name__ __module__ __qualname____firstlineno____annotations____static_attributes__rG/var/www/html/env/lib/python3.13/site-packages/pandas/_config/config.pyrrQs H O r"rcH\rSrSr%S\S'S\S'S\S'S\S'S \S 'S rg ) RegisteredOptionXrrobjectdefvaldocCallable[[object], Any] | None validatorCallable[[str], Any] | NonecbrNrrr"r#r%r%Xs H N H--##r"r%zdict[str, DeprecatedOption]_deprecated_optionszdict[str, RegisteredOption]_registered_optionsdict[str, Any]_global_configall list[str]_reserved_keysc\rSrSrSrSrg) OptionErrormz Exception raised for pandas.options. Backwards compatible with KeyError checks. Examples -------- >>> pd.options.context Traceback (most recent call last): OptionError: No such option rN)rrrr__doc__r!rr"r#r6r6ms r"r6c[U5n[U5S:Xa)U(d [U5 [S[ U535e[U5S:a [S5eUSnU(d [U5 [ U5nU$)NrzNo such keys(s): zPattern matched multiple keys)_select_optionslen_warn_if_deprecatedr6repr_translate_key)patsilentkeysrs r#_get_single_keyrCss 3 D 4yA~  $-d3i[9:: 4y1}9:: q'C C  C Jr"c:[X5n[U5up4X4$N)rC _get_root)r@rArrootks r# _get_optionrIs # &CnGD 7Nr"c[U5nU(a US-S:wa [S5eURSS5nU(a1[[ UR 555n[ SUS35e[USSS2USSS25HupV[XS5n[U5nU(a"UR(aURU5 [U5upXiU 'UR(dMhU(a0[R"S S 9 URU5 SSS5 MURU5 M g!,(df  M=f) Nrz4Must provide an even number of non-keyword argumentsrAFz2_set_option() got an unexpected keyword argument ""r:T)record)r< ValueErrorpopnextiterrB TypeErrorziprC_get_registered_optionr+rFr-warningscatch_warnings) argskwargsnargsrAkwargrHvrorGk_roots r# _set_optionr^s IE EAINOPPZZ% (F T&++-()LUGSTUVVD1ItADqDz*a( "3 '  KKN!~ V 444,,D9DDI:9S !+:9s D>> E c[U5n[U5S:Xa [S5eSRUVs/sHn[ U5PM sn5nU(a [ U5 gU$s snf)NrNo such keys(s) )r;r<r6join_build_option_descriptionprint)r@ _print_descrBrHss r#_describe_optionrgs] 3 D 4yA~+,, >A,Q/>?A a H ?sA&c[U5n[U5S:Xa [S5e[U5S:a [U5S:aUS:wa [S5eUHn[ U[ UR US9 M! g)Nrr`r:r2zYou must specify at least 4 characters when resetting multiple keys, use the special keyword "all" to reset all the options to their default valuerA)r;r<r6rNr^r/r()r@rArBrHs r# _reset_optionrksu 3 D 4yA~+,, 4y1}SA#, D  A*1-44VDr"c@[USS9n[U5R$NTrj)rCrTr()r@rs r#get_default_valrns #d +C !# & - --r"cP\rSrSr%SrS\S'S S SjjrS SjrSSjrSSjr S r g ) DictWrapperz/provide attribute-style access to a nested dictr0dc`[RUSU5 [RUSU5 g)Nrrprefix)r' __setattr__)selfrrrts r#__init__DictWrapper.__init__s&4a(462r"c[RUS5nU(aUS- nX1- nXR;a.[URU[5(d [ X25 g[ S5e)Nrt.z.You can only set the value of existing options)r'__getattribute__rr isinstancedictr^r6)rvrvalrts r#ruDictWrapper.__setattr__sZ((x8  cMF  &&=DFF3K!>!>  $NO Or"c[RUS5nU(aUS- nX!- n[RUS5Un[ U[ 5(a [ X25$[U5$![an[S5UeSnAff=f)NrtrzrrzNo such option)r'r{KeyErrorr6r|r}rprI)rvrrtr[errs r# __getattr__DictWrapper.__getattr__s((x8  cMF  9''c237A a  q) )v& &  9./S 8 9sA,, B6 BBcH[URR55$rE)listrrrB)rvs r#__dir__DictWrapper.__dir__sDFFKKM""r"rN))rrr0rtrreturnNone)rrr~rrrrr)rr3) rrrrr8r rwrurrr!rr"r#rprps 93 P '#r"rpc<\rSrSrSSjrSSjr\S Sj5rSrg) CallableDynamicDoci cX lXlgrE __doc_tmpl____func__)rvfuncdoc_tmpls r#rwCallableDynamicDoc.__init__ s $ r"c&UR"U0UD6$rE)r)rvrWkwdss r#__call__CallableDynamicDoc.__call__s}}d+d++r"c[SSS9n[[[R 555nUR R XS9$)Nr2F)re) opts_desc opts_list)rgpp_options_listrr/rBrformat)rvrrs r#r8CallableDynamicDoc.__doc__sA$U> #D)<)A)A)C$DE   '')'QQr"rN)rzCallable[..., T]rrrr)rr )rr) rrrrrwrpropertyr8r!rr"r#rr s",RRr"ra 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} Examples -------- >>> pd.get_option('display.max_columns') # doctest: +SKIP 4 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} Examples -------- >>> pd.set_option('display.max_columns', 4) >>> df = pd.DataFrame([[1, 2, 3, 4, 5], [6, 7, 8, 9, 10]]) >>> df 0 1 ... 3 4 0 1 2 ... 4 5 1 6 7 ... 9 10 [2 rows x 5 columns] >>> pd.reset_option('display.max_columns') 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} Examples -------- >>> pd.describe_option('display.max_columns') # doctest: +SKIP display.max_columns : int If max_cols is exceeded, switch to truncate view... 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} Examples -------- >>> pd.reset_option('display.max_columns') # doctest: +SKIP c6\rSrSrSrSSjrSSjrSSjrSrg) option_contextia& Context manager to temporarily set options in the `with` statement context. You need to invoke as ``option_context(pat, val, [(pat, val), ...])``. Examples -------- >>> from pandas import option_context >>> with option_context('display.max_rows', 10, 'display.max_columns', 5): ... pass c [U5S-S:wd[U5S:a [S5e[[USSS2USSS255Ulg)NrKrz>Need to invoke as option_context(pat, val, [(pat, val), ...]).r:)r<rNrrSops)rvrWs r#rwoption_context.__init__sS t9q=A TQP D1ItADqDz23r"cURVVs/sHupU[U54PM snnUlURHup[XSS9 M gs snnfrm)rrIundor^)rvr@r~s r# __enter__option_context.__enter__sH=AXXFXc;s+,XF HC  .!GsAcfUR(a URHup#[X#SS9 M ggrm)rr^)rvrWr@r~s r#__exit__option_context.__exit__s( 99 IICT2& r")rrNrr) rrrrr8rwrrr!rr"r#rrs 4/ 3r"rc ,SSKnSSKnUR5nU[;a[ SUS35eU[ ;a[ SUS35eU(aU"U5 UR S5nUHan[R"SUR-S-U5(d[US 35eURU5(dMU[US 35e [n S n [USS 5HQup[U [5(d*[ U R!SR#USU 5S 95eX;a0X'Xn MS [U [5(d*[ U R!SR#USS 5S 95eXUS '[%XX#US9[U'g)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 keyrz^$z is not a valid identifierz is a python keywordz5Path prefix to option '{option}' is already an option)option)rr(r)r+r-)keywordtokenizelowerr/r6r4splitrematchNamerN iskeywordr1 enumerater|r}rrbr%) rr(r)r+r-rrpathrHcursorrips r#register_optionrs> ))+C !!HSE)FGHH nHSE)<=>>& 99S>D xxhmm+c1155s"<=> >   Q  s"678 8  F AC$s)$&$''cjjbq0BjCD D ?FI % fd # ##**CHHT#2Y,?*@AA48 0 C r"c|UR5nU[;a[SUS35e[XX#5[U'g)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.r6r)rrrrs r#deprecate_optionr6s@N ))+C !!HSE)RSTT/$Lr"cU[;aU/$[[R55nUS:XaU$UVs/sH1n[R"X[R 5(dM/UPM3 sn$s snf)zV returns a list of keys matching `pat` if pat=="all", returns all registered options r2)r/sortedrBrsearchI)r@rBrHs r#r;r;is_ !!u  %**, -D e|  7t!ryy6At 77 7s .A2)A2c\URS5n[nUSSHnX#nM X!S4$)Nrzr)rr1)rrrrs r#rFrF{s8 99S>D F #2Y 8 r"c4UR5nU[;$)z4Returns True if the given option has been deprecated)rr.rs r#_is_deprecatedrs ))+C % %%r"c:[UnU$![a gf=f)z Retrieves the metadata for a deprecated option, if `key` is deprecated. Returns ------- DeprecatedOption (namedtuple) if key is deprecated, None otherwise N)r.rrrrs r#_get_deprecated_optionrs,  $ s c,[RU5$)z Retrieves the option metadata if `key` is a registered option. Returns ------- RegisteredOption (namedtuple) if key is deprecated, None otherwise )r/getrs r#rTrTs  " "3 ''r"cT[U5nU(aUR=(d U$U$)zv if key id deprecated and a replacement key defined, will return the replacement key, otherwise returns `key` as - is )rrrs r#r?r?s$ s#Avv} r"c[U5nU(aUR(a-[R"UR[[ 5S9 gSUS3nUR (aUSUR 3- nUR(aUSURS3- nOUS- n[R"U[[ 5S9 gg ) 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)rrrUwarn FutureWarningrrr)rrrrs r#r=r=s s#A 55 MM+- cU/*C}}1!--AAvvxz::88 MM#}9I9K L r"c[U5n[U5nUS3nUR(a<USRURR 5R S55- nOUS- nU(a USUR S[US5S3- nU(a(UR=(d SnUS - nUS US 3- nUS - nU$) zCBuilds a formatted description of a registered option and prints it razNo description available.z [default: z] [currently: T]rz (Deprecatedz, use `z ` instead.)) rTrr)rbstriprr(rIr)rHr\rrrfrs r#rcrcsq!Aq!A #QAuu TYYquu{{}**40 11 (( z At8L7MQ OOvv|   wtfJ '' S Hr"c^^ SSKJn SSKJm S UU 4Sjjn/n[ U5Vs/sHofR S5S:dMUPM nnU(a XT"SU5- nUVs/sHofR S5S:dMUPM nnU"[ U5S5H8up[ U 5Vs/sHof[U5S-S PM n nXT"X5- nM: S RU5n U(a [U 5 g U $s snfs snfs snf) z@Builds a concise listing of available options, grouped by prefixr)groupby)wrapc>U(aSU-S-OSnT"SRU5TUSSS9nU(aUS(aU(a USS -US'U$) Nz- z.[rz, z F)initial_indentsubsequent_indentbreak_long_wordsrr)rb)namekspfxlswidthrs r#pppp_options_list..ppsY$(dTkD b  IIbM ""   "R&TVc\BrF r"rzrc*USURS5$Nrz)rfind)xs r#!pp_options_list..s.AGGCL0Ar"r:Nra)rrr Iterable[str]rr3) itertoolsrtextwraprrfindrr<rbrd) rBr_printrrrrsinglesrHgrrfrs ` @r#rrs!  B ,:,Q&&+/q,G: bWo 0t!vvc{a/AtD 0t &AB'+Aw /w!A ow / biC " A  a; 10sC:C:!C?=C?*Dc#^# SU4Sjjn[n[n[nU"[5qU"[5qU"[5qSv UqUqUqg!UqUqUqf=f7f)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. c8>^SUU4Sjjn[[U5$)Nc*>TSU3nT"U/UQ70UD6$rr)rrWrpkeyrrts r#inner*config_prefix..wrap..inner+s(XQse$D,t,t, ,r"r)r r )rrrts` r#rconfig_prefix..wrap*s - -Au~r"N)rr rr )r get_option set_option)rtr_register_optionrIr^s` r# config_prefixr sd<'KKj!Jj!J?+O+   *!  *s?AAAAAc^SU4SjjnU$)z 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` cB>[U5T:wa[STS35eg)NzValue must have type 'r)typerN)r_types r#ris_type_factory..innerQs) 7e 5eWA>? ? r"rr)rrs` r#is_type_factoryrCs@ Lr"c^^[T[[45(a+[T5mSR[ [ T55mOSTS3mSUU4SjjnU$)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` |rcD>[UT5(d[ST35eg)NzValue must be an instance of )r|rN)rr type_reprs r#r"is_instance_factory..innerks(!U##^TT;al[U4SjT55(dQTVs/sHn[U5PM nnSRU5nSU3n[T5(aUS- n[ U5eggs snf)Nc32># UH o"T5v M g7frEr).0crs r# 3is_one_of_factory..inner..xs/YqttYsr zValue must be one of z or a callable)anyrrbr<rN)rlvaluvals pp_valuesr callables legal_valuess` r#r is_one_of_factory..innervsx L /Y////;<|tT|<HHUO -i[9y>>++C o% 0 !r?sp0d# 5 z$z$46054605"$##G # .( $$@  E". $#$#` R R %N-^&P"L -= >  -= > !-1CD $%57LM n % 3%3H04&* H H H H. H $ H  HZ" ,M ,M ,M ,M ,M  ,Mf8$&  ( < 0L/+/+l*4"6   $  5 !   sEl +r"