4ii*%SrSSKJr SSKJr SSKrSSKJrJrJ r J r SSK r SSK J r SSKJr \(a SSKJrJrJr "S S \ 5r"S S \ 5r0rS \S'0rS\S'0rS\S'S/rS\S'"SS\\5rS2SjrS3SjqS4Sjq S5S6Sjjr!S7Sjr"S8Sjr#"SS5r$\$"\5r%\&RO\%S S!5 \S9S"j5r(S:S;S#jjq)S<S=S$jjr*S>S%jr+S?S&jr,S@S'jr-S@S(jr.SAS)jr/SBS*jr0SCS+jr1\SDS,j5r2SES-jr3SFS.jr4SGS/jr5SHS0jr6\3"\75r8\3"\95r:\3"\;5r<\3"\=5r>\4"\=\?45r@SIS1jrAS![>lBS![@lBS!\!lBS!\"lBS!\(lBg)Ja 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)contextmanagerN) TYPE_CHECKINGAny NamedTuplecast)F)find_stack_level)Callable GeneratorSequencecH\rSrSr%S\S'S\S'S\S'S\S'S\S 'S rg ) DeprecatedOptionJstrkey type[Warning]category str | Nonemsgrkey removal_verN__name__ __module__ __qualname____firstlineno____annotations____static_attributes__rW/var/www/html/dynamic-report/venv/lib/python3.13/site-packages/pandas/_config/config.pyrrJs H O r!rcH\rSrSr%S\S'S\S'S\S'S\S'S \S 'S rg ) RegisteredOptionRrrrdefvaldocCallable[[object], Any] | None validatorCallable[[str], Any] | NonecbrNrrr!r"r$r$Rs H K H--##r!r$zdict[str, DeprecatedOption]_deprecated_optionszdict[str, RegisteredOption]_registered_optionsdict[str, Any]_global_configall list[str]_reserved_keysc\rSrSrSrSrSrg) OptionErrorga Exception raised for pandas.options. Backwards compatible with KeyError checks. See Also -------- options : Access and modify global pandas settings. Examples -------- >>> pd.options.context Traceback (most recent call last): OptionError: No such option z pandas.errorsrN)rrrr__doc__r rr!r"r4r4gs !Jr!r4c[U5n[U5S:Xa[U5 [SU<35e[U5S:a [S5eUSn[U5 [ U5nU$)NrzNo such keys(s): zPattern matched multiple keys)_select_optionslen_warn_if_deprecatedr4_translate_key)patkeysrs r"_get_single_keyr?si 3 D 4yA~C -cW566 4y1}9:: q'C  C Jr!c:[U5n[U5up#X#$)aR Retrieve the value of the specified option. This method allows users to query the current value of a given option in the pandas configuration system. Options control various display, performance, and behavior-related settings within pandas. Parameters ---------- pat : str Regexp which should match a single option. .. warning:: 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 ------- Any The value of the option. Raises ------ OptionError : if no such option exists See Also -------- set_option : Set the value of the specified option or options. reset_option : Reset one or more options to their default value. describe_option : Print the description for one or more registered options. Notes ----- For all available options, please view the :ref:`User Guide ` or use ``pandas.describe_option()``. Examples -------- >>> pd.get_option("display.max_columns") # doctest: +SKIP 4 )r? _get_root)r=rrootks r" get_optionrDs#X # CnGD 7Nr!c [U5S:Xa;[US[5(a#[SUSR 555n[U5nU(a US-S:wa [ S5e[ USSS2USSS2SS9Hyup#[U5n[U5nU(a"UR(aURU5 [U5upgX6U'UR(dMhURU5 M{ g) al Set the value of the specified option or options. This method allows fine-grained control over the behavior and display settings of pandas. Options affect various functionalities such as output formatting, display limits, and operational behavior. Settings can be modified at runtime without requiring changes to global configurations or environment variables. Parameters ---------- *args : str | object | dict Arguments provided in pairs, which will be interpreted as (pattern, value), or as a single dictionary containing multiple option-value pairs. pattern: str Regexp which should match a single option value: object New value of option .. warning:: Partial pattern 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 No return value. Raises ------ ValueError if odd numbers of non-keyword arguments are provided TypeError if keyword arguments are provided OptionError if no such option exists See Also -------- get_option : Retrieve the value of the specified option. reset_option : Reset one or more options to their default value. describe_option : Print the description for one or more registered options. option_context : Context manager to temporarily set options in a ``with`` statement. Notes ----- For all available options, please view the :ref:`User Guide ` or use ``pandas.describe_option()``. Examples -------- Option-Value Pair Input: >>> 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") Dictionary Input: >>> pd.set_option({"display.max_columns": 4, "display.precision": 1}) >>> 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") >>> pd.reset_option("display.precision") r8rc36# UHoHo"v M M g7fNr.0itemkvs r" set_option..CODdRdROz4Must provide an even number of non-keyword argumentsNTstrict) r: isinstancedicttupleitems ValueErrorzipr?_get_registered_optionr)rAr+)argsnargsrCvroptrBk_roots r" set_optionr_sV 4yA~*T!Wd33CDGMMOCC IE EAINOPPD1ItADqDz$7a $S) 3== MM! !~ V 666 FF3K8r!c[U5n[U5S:Xa[SU<35eSRUVs/sHn[ U5PM sn5nU(a [ U5 gU$s snf)aK Print the description for one or more registered options. Call with no arguments to get a listing for all registered options. Parameters ---------- pat : str, default "" String or string regexp pattern. Empty string will return all options. For regexp strings, 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 string (for testing). Returns ------- None If ``_print_desc=True``. str If the description(s) as a string if ``_print_desc=False``. See Also -------- get_option : Retrieve the value of the specified option. set_option : Set the value of the specified option or options. reset_option : Reset one or more options to their default value. Notes ----- For all available options, please view the :ref:`User Guide `. Examples -------- >>> pd.describe_option("display.max_columns") # doctest: +SKIP display.max_columns : int If max_cols is exceeded, switch to truncate view... rNo such keys(s) for pat= N)r9r:r4join_build_option_descriptionprint)r= _print_descr>rCss r"describe_optionrh#sgR 3 D 4yA~5788 >A,Q/>?A a H ?sA*c[U5n[U5S:Xa[SU<35e[U5S:a [U5S:aUS:wa [S5eUH n[ U[ UR 5 M" g)ah Reset one or more options to their default value. This method resets the specified pandas option(s) back to their default values. It allows partial string matching for convenience, but users should exercise caution to avoid unintended resets due to changes in option names in future versions. Parameters ---------- pat : str/regex If specified only options matching ``pat*`` will be reset. Pass ``"all"`` as argument to reset all options. .. warning:: 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 No return value. See Also -------- get_option : Retrieve the value of the specified option. set_option : Set the value of the specified option or options. describe_option : Print the description for one or more registered options. Notes ----- For all available options, please view the :ref:`User Guide `. Examples -------- >>> pd.reset_option("display.max_columns") # doctest: +SKIP rrar8r0zYou must specify at least 4 characters when resetting multiple keys, use the special keyword "all" to reset all the options to their default valueN)r9r:r4rWr_r-r&r=r>rCs r" reset_optionrlXs}R 3 D 4yA~5788 4y1}SA#, D  1)!,334r!cB[U5n[U5R$rG)r?rYr&)r=rs r"get_default_valrns # C !# & - --r!cP\rSrSr%SrS\S'S S SjjrS SjrSSjrSSjr S r g ) DictWrapperiz/provide attribute-style access to a nested dictr.dc`[RUSU5 [RUSU5 g)Nrqprefix)object __setattr__)selfrqrss r"__init__DictWrapper.__init__s&4a(462r!c[RUS5nU(aUS- nX1- nXR;a.[URU[5(d [ X25 g[ S5e)Nrs.z.You can only set the value of existing options)rt__getattribute__rqrSrTr_r4)rvrvalrss r"ruDictWrapper.__setattr__sZ((x8  cMF  &&=DFF3K!>!> v #NO Or!c[RUS5nU(aUS- nX!- n[RUS5Un[ U[ 5(a [ X25$[U5$![an[S5UeSnAff=f)NrsrzrqzNo such option)rtr{KeyErrorr4rSrTrprD)rvrrsr\errs r" __getattr__DictWrapper.__getattr__s((x8  cMF  9''c237A a  q) )f% %  9./S 8 9sA,, B6 BBcH[URR55$rG)listrqr>)rvs r"__dir__DictWrapper.__dir__sDFFKKM""r!rN))rqr.rsrreturnNone)rrr|rrrrr)rr1) rrrrr6rrwrurrr rr!r"rprps 93 P &#r!rprpandasc '# [U5S:Xa;[US[5(a#[SUSR 555n[U5S-S:wd[U5S:a [ S5e[[ USSS2USSS2SS95nS n[S U55nUHup4[X45 M Sv UHup4[X45 M g!UHup4[X45 M f=f7f) a  Context manager to temporarily set options in a ``with`` statement. This method allows users to set one or more pandas options temporarily within a controlled block. The previous options' values are restored once the block is exited. This is useful when making temporary adjustments to pandas' behavior without affecting the global state. Parameters ---------- *args : str | object | dict An even amount of arguments provided in pairs which will be interpreted as (pattern, value) pairs. Alternatively, a single dictionary of {pattern: value} may be provided. Returns ------- None No return value. Yields ------ None No yield value. See Also -------- get_option : Retrieve the value of the specified option. set_option : Set the value of the specified option. reset_option : Reset one or more options to their default value. describe_option : Print the description for one or more registered options. Notes ----- For all available options, please view the :ref:`User Guide ` or use ``pandas.describe_option()``. Examples -------- >>> from pandas import option_context >>> with option_context("display.max_rows", 10, "display.max_columns", 5): ... pass >>> with option_context({"display.max_rows": 10, "display.max_columns": 5}): ... pass r8rc36# UHoHo"v M M g7frGrrHs r"rL!option_context..rNrOrPzMProvide an even amount of arguments as option_context(pat, val, pat, val...).NTrQrc3@# UHupU[U54v M g7frG)rD)rIr=r|s r"rLrs@Cc:c?+Cs)r:rSrTrUrVrWrXr_)rZopsundor=r|s r"option_contextrs^ 4yA~*T!Wd33CDGMMOCC 4y1}SY] 5  D1ItADqDz$7 8C(*D!@C@@HC s  HC s HC s sBC:,CC:C77C:c ,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-r4r2splitrematchNamerW iskeywordr/ enumeraterSrTformatrcr$) rr&r'r)r+rrpathrCcursorrips r"register_optionr s> ))+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#U5[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"). category : Warning Warning class for the deprecation. 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,r4r)rrrrrs r"deprecate_optionrTsBT ))+C !!HSE)RSTT/s+Vr!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 r0)r-sortedr>rsearchIrks r"r9r9s_ !!u  %**, -D e|  7t!ryy6At 77 7s .A2)A2c\URS5n[nUSSHnX#nM X!S4$)Nrzr)rr/)rrrrs r"rArAs8 99S>D F #2Y 8 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,rrrqs 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-get)rs r"rYrYs  " "3 ''r!cT[U5nU(aUR=(d U$U$)zv if `key` is 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(a3[R"URUR[ 5S9 gSUS3nUR (aUSUR 3- nUR(aUSURS3- nOUS- n[R"UUR[ 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)rrwarningswarnrr rr)rrqrs r"r;r;s s#A 55 MM +- &cU/*C}}1!--AAvvxz::88 MM +-   r!cT[U5n[U5nUS3nUR(a<USRURR 5R S55- nOUS- nU(as[ R"5 [ R"S[5 [ R"S[5 USURS[U5S3- nSSS5 U(a(UR=(d S nUS - nUS US 3- nUS - nU$!,(df  N?=f)zCBuilds a formatted description of a registered option and prints it rbzNo description available.ignorez [default: z] [currently: ]Nrz (Deprecatedz, use `z ` instead.))rYrr'rcstriprrcatch_warnings simplefilter FutureWarningDeprecationWarningr&rDr)rCorqrgrs r"rdrdsq!Aq!A #QAuu TYYquu{{}**40 11 ((  $ $ &  ! !(M :  ! !(,> ? #AHH:^JqM?!L LA'  vv|   wtfJ '' S H' &s AD D'c#^# 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$)Nrzr)rrZkwdspkeyfuncrss r"inner*config_prefix..wrap..inner*s(XQse$D,t,t, ,r!r)rr )rrrss` r"wrapconfig_prefix..wrap)s - -Au~r!N)rr rr )rrDr_)rsr_register_option _get_option _set_options` 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)typerW)x_types r"ris_type_factory..innerPs) 7e 5eWA>? ? r!rrr)rrs` r"is_type_factoryrBs@ Lr!c^^[T[5(a SR[[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 )rSrW)rr type_reprs r"r"is_instance_factory..inneris(!U##^TT;al[U4SjT55(dQTVs/sHn[U5PM nnSRU5nSU3n[T5(aUS- n[ U5eggs snf)Nc32># UH o"T5v M g7frGr)rIcrs r"rL3is_one_of_factory..inner..vs/YqttYsrzValue must be one of z or a callable)anyrrcr:rW)rlvaluvals pp_valuesr callables legal_valuess` r"r is_one_of_factory..innertsx L /Y////;<|tT|<HHUO -i[9y>>++C o% 0 !r sK0d#%  4z$z$46054605"$##G #!.(!0  0f^B2 j65r. $#$#N n %7L(3 @!@!L04&* H H H H. H $ H  H\" /W /W/W /W  /W  /W  /Wl8$  ( D </+/+l*2"6   $  5 !   sEl +&!  %" $r!