a oEb(]@sUdZddlmZddlmZmZddlZddlmZm Z m Z m Z m Z ddl Z ddlmZGddde ZGd d d e ZiZd ed <iZd ed<iZded<dgZded<GdddeeZddddddZdkdddddZdd d!d"Zdlddd%d&d'Zdmddddd(d)Zdd*d+d,ZGd-d.d.Z Gd/d0d0Z!d1Z"d2Z#d3Z$d4Z%e!ee"a&e!ee#a'e!ee%a(e!ee$Z)e eZ*Gd5d6d6eZ+dndd7dd8d9dd:d;d<a,dodd=d=d=dd>d?d@Z-dddAdBdCZ.ddDdEdFdGZ/dddEdHdIZ0ddJdKdLZ1ddJdMdNZ2dddEdOdPZ3dddEdQdRZ4dddSdTdUZ5dpdWddXdYdZZ6ed[d\Z7d]d^d_d`daZ8d^d dbdcZ9d^d dddeZ:d7ddfdgdhZ;e8e<Z=e8e>Z?e8e@ZAe8eBZCe9eBeDfZEdd didjZFdS)qa 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)AnyCallableIterable NamedTuplecast)Fc@s.eZdZUded<ded<ded<ded<dS)DeprecatedOptionstrkey str | Nonemsgrkey removal_verN__name__ __module__ __qualname____annotations__rrU/home/ja/django-apps/lartica_env/lib/python3.9/site-packages/pandas/_config/config.pyr Fs r c@s6eZdZUded<ded<ded<ded<ded <d S) RegisteredOptionr r objectdefvaldocCallable[[object], Any] | None validatorCallable[[str], Any] | NonecbNrrrrrrMs rzdict[str, DeprecatedOption]_deprecated_optionszdict[str, RegisteredOption]_registered_optionsdict[str, Any]_global_configall list[str]_reserved_keysc@seZdZdZdS) OptionErrorzV Exception for pandas.options, backwards compatible with KeyError checks. N)rrr__doc__rrrrr(bsr(r bool)patsilentreturncCsft|}t|dkr2|s t|tdt|t|dkrFtd|d}|sZt|t|}|S)NrzNo such keys(s): zPattern matched multiple keys)_select_optionslen_warn_if_deprecatedr(repr_translate_key)r+r,keysr rrr_get_single_keyms  r5F)r+r,cCst||}t|\}}||SN)r5 _get_root)r+r,r rootkrrr _get_options  r:Noner-c Ost|}|r|ddkr td|dd}|rPt|d}td|dt|ddd|dddD]\}}t||}t|}|r|j r| |t |\} }|| |<|j rn|rt j d d | |Wdq1s0Yqn| |qndS) Nrz4Must provide an even number of non-keyword argumentsr,Fz2_set_option() got an unexpected keyword argument ""r.T)record)r0 ValueErrorpoplistr4 TypeErrorzipr5_get_registered_optionrr7r warningscatch_warnings) argskwargsnargsr,kwargr9vr or8rrr _set_options& &    *rNT)r+ _print_desccCsFt|}t|dkrtdddd|D}|r>t|n|SdS)NrNo such keys(s) cSsg|] }t|qSr)_build_option_description.0r9rrr z$_describe_option..)r/r0r(joinprint)r+rPr4srrr_describe_options  r[cCsft|}t|dkrtdt|dkrDt|dkrD|dkrDtd|D]}t|t|j|dqHdS)NrrQr.r%zYou must specify at least 4 characters when resetting multiple keys, use the special keyword "all" to reset all the options to their default valuer,)r/r0r(r@rNr"r)r+r,r4r9rrr _reset_options  r^r+cCst|dd}t|jSNTr])r5rEr)r+r rrrget_default_vals rac@sPeZdZdZddddddZddd d d d Zdd ddZddddZdS) DictWrapperz/provide attribute-style access to a nested dictrOr#r )dprefixcCs t|d|t|d|dS)Nrcrd)r __setattr__)selfrcrdrrr__init__szDictWrapper.__init__rr;)r valr-cCsRt|d}|r|d7}||7}||jvrFt|j|tsFt||ntddS)Nrd.z.You can only set the value of existing options)r__getattribute__rc isinstancedictrNr()rfr rhrdrrrres  zDictWrapper.__setattr__r c Cst|d}|r|d7}||7}zt|d|}Wn.tyb}ztd|WYd}~n d}~00t|trxt||St|SdS)NrdrirczNo such option)rrjKeyErrorr(rkrlrbr:)rfr rdrLerrrrr __getattr__s    zDictWrapper.__getattr__ Iterable[str]r<cCst|jSr6)rBrcr4)rfrrr__dir__szDictWrapper.__dir__N)rO)rrrr)rgrerprrrrrrrbs  rbc@s(eZdZddZddZeddZdS)CallableDynamicDoccCs||_||_dSr6) __doc_tmpl____func__)rffuncZdoc_tmplrrrrgszCallableDynamicDoc.__init__cOs|j|i|Sr6)ru)rfrHkwdsrrr__call__szCallableDynamicDoc.__call__cCs,tddd}ttt}|jj||dS)Nr%F)rP) opts_desc opts_list)r[pp_options_listrBr"r4rtformat)rfryrzrrrr)s zCallableDynamicDoc.__doc__N)rrrrgrxpropertyr)rrrrrssrsa; 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 ----- The available options with its descriptions: {opts_desc} aG 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 ----- 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 ----- The available options with its descriptions: {opts_desc} a5 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 ----- The available options with its descriptions: {opts_desc} c@s(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 cGsLt|ddkst|dkr$tdtt|ddd|ddd|_dS)Nr=rz>Need to invoke as option_context(pat, val, [(pat, val), ...]).r.)r0r@rBrDops)rfrHrrrrgs zoption_context.__init__cCs4dd|jD|_|jD]\}}t||ddqdS)NcSs g|]\}}|t|ddfqS)Tr])r:)rUr+rhrrrrVrWz,option_context.__enter__..Tr])rundorN)rfr+rhrrr __enter__szoption_context.__enter__cGs(|jr$|jD]\}}t||ddq dSr`)rrN)rfrHr+rhrrr__exit__szoption_context.__exit__N)rrrr)rgrrrrrrr~s r~rrr)r rrrr r-c CsVddl}ddl}|}|tvr0td|d|tvrHtd|d|rT|||d}|D]@}td|j d|st |d | |rbt |d qbt } d } t |dd D]H\} } t| tst| jd|d| d | | vri| | <| | } qt| ts0t| jd|dd d || |d <t|||||dt|<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 keyri^$z is not a valid identifierz is a python keywordz5Path prefix to option '{option}' is already an option)option)r rrrr )keywordtokenizelowerr"r(r'splitrematchNamer@ iskeywordr$ enumeraterkrlr|rXr) r rrrr rrpathr9cursorriprrrregister_options:       rr)r rrrr-cCs6|}|tvr td|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!r(r )r rrrrrrdeprecate_options'r)r+r-cs8tvrgStt}dkr&|Sfdd|DS)zb returns a list of keys matching `pat` if pat=="all", returns all registered options r%cs g|]}t|tjr|qSr)rsearchIrTr_rrrVBrWz#_select_options..)r"sortedr4)r+r4rr_rr/3s  r/ztuple[dict[str, Any], str])r r-cCs4|d}t}|ddD] }||}q||dfS)Nrir)rr$)r rrrrrrr7Es   r7cCs|}|tvS)z4Returns True if the given option has been deprecated)rr!rmrrr_is_deprecatedMsrrmcCs*z t|}Wnty YdS0|SdS)z Retrieves the metadata for a deprecated option, if `key` is deprecated. Returns ------- DeprecatedOption (namedtuple) if key is deprecated, None otherwise N)r!rnr rcrrr_get_deprecated_optionSs   rcCs t|S)z Retrieves the option metadata if `key` is a registered option. Returns ------- RegisteredOption (namedtuple) if key is deprecated, None otherwise )r"getrmrrrrEcsrEcCst|}|r|jp|S|SdS)z if key id deprecated and a replacement key defined, will return the replacement key, otherwise returns `key` as - is N)rrrrrrr3ns r3cCszt|}|rv|jr"t|jtnPd|d}|jrD|d|j7}|jr^|d|jd7}n|d7}t|tdSdS) z Checks if `key` is a deprecated option and if so, prints a warning. Returns ------- bool - True if `key` is deprecated, False otherwise. 'z' is deprecatedz and will be removed in z, please use 'z ' instead.z, please refrain from using it.TF)rrrFwarn FutureWarningrr)r rcrrrrr1zs  r1)r9r-cCst|}t|}|d}|jr<|d|jd7}n|d7}|rf|d|jdt|dd7}|r|jprd}|d 7}|d |d 7}|d 7}|S) zCBuilds a formatted description of a registered option and prints it rRzNo description available.z [default: z] [currently: T]rOz (Deprecatedz, use `z ` instead.)) rErrrXstriprrr:r)r9rMrcrZrrrrrSs  rSPrq)r4_printc sddlm}ddlmddddfdd }g}d d t|D}|rX||d |7}d d |D}|t|ddD],\}fdd t|D}|||7}qxd|} |rt| n| SdS)z@Builds a concise listing of available options, grouped by prefixr)groupby)wrapr rqr&)nameksr-csP|rd|dnd}d||ddd}|rL|drL|rL|dd |d<|S) Nz- z.[rOz, z F)initial_indentsubsequent_indentbreak_long_wordsrr)rX)rrpfxls)widthrrrppszpp_options_list..ppcSsg|]}|ddkr|qSrirfindrUxrrrrVrWz#pp_options_list..rOcSsg|]}|ddkr|qSrrrrrrrVrWcSs|d|dSNri)rfindrrrrrWz!pp_options_list..cs g|]}|tddqS)r.N)r0r)r9rrrVrWrRN) itertoolsrtextwraprrrBrXrY) r4rrrrrZsinglesgrrZr)r9rrrr{s     r{c#sbdddfdd }t}t}t}|ta|ta|tazdVW|a|a|an|a|a|a0dS)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. r )rvr-csddfdd }tt|S)Nr rmcs$d|}|g|Ri|Srr)r rHrwpkey)rvrdrrinnersz*config_prefix..wrap..inner)r r )rvrrd)rvrrszconfig_prefix..wrapN)r get_option set_option)rdrZ_register_optionr:rNrrr config_prefixsrz type[Any]zCallable[[Any], None])_typer-csddfdd }|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` r;r<cs t|krtdddS)NzValue must have type 'r)typer@rrrrrs zis_type_factory..innerrrrrrris_type_factory srcsLtttfr(tdttn ddddfdd }|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` |rr;r<cst|stddS)NzValue must be an instance of )rkr@rrZ type_reprrrr1s z"is_instance_factory..inner)rktuplerBrXmapr rrrris_instance_factorys  rcs4ddDddDddfdd }|S)NcSsg|]}t|r|qSrcallablerUcrrrrV:rWz%is_one_of_factory..cSsg|]}t|s|qSrrrrrrrV;rWr;r<cs\vrXtfddDsXddD}d|}d|}trP|d7}t|dS)Nc3s|]}|VqdSr6rrrrr @rWz3is_one_of_factory..inner..cSsg|] }t|qSr)r )rUZlvalrrrrVArWz4is_one_of_factory..inner..rzValue must be one of z or a callable)anyrXr0r@)rZuvalsZ pp_valuesrZ callables legal_valuesrrr=s  z is_one_of_factory..innerr)rrrrris_one_of_factory8s r)valuer-cCs2|dur dSt|tr"|dkr"dSd}t|dS)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)rkintr@)rrrrris_nonnegative_intKs rcCst|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)rr@)objrrr is_callablems r)F)rOT)F)rONN)NNN)rF)Gr) __future__r contextlibrrrtypingrrrrr rFZpandas._typingr r rr!rr"r$r'AttributeErrorrnr(r5r:rNr[r^rarbrsZ_get_option_tmplZ_set_option_tmplZ_describe_option_tmplZ_reset_option_tmplrrZ reset_optionZdescribe_optionoptionsr~rrr/r7rrrEr3r1rSr{rrrrrrZis_intr*Zis_boolfloatZis_floatr Zis_strbytesZis_textrrrrrsx2       . "     #M3  & 6