a Pfnc@sUdZddlmZddlmZmZddlZddlmZm Z m Z m Z m Z m Z ddlZddlmZmZddlmZerddlmZmZGd d d e ZGd d d e ZiZd ed<iZded<iZded<dgZded<GdddeeZ ddddddZ!dpdddddd Z"d!d"d#d$Z#dqddd'd(d)d*Z$drddd!dd+d,Z%dd-d.d/Z&Gd0d1d1Z'Gd2d3d3e eZ(d4Z)d5Z*d6Z+d7Z,e(e"e)a-e(e#e*a.e(e%e,Z/e(e$e+Z0e'eZ1Gd8d9d9eZ2dsdd:dd;dd?a3dtdd'd'd'd!d@dAdBZ4dddCdDdEZ5ddFdGdHdIZ6dddGdJdKZ7ddLdMdNZ8ddLdOdPZ9dddGdQdRZ:dddGdSdTZ;dddUdVdWZdbdcdddedfZ?dcd"dgdhZ@dcd"didjZAd:d!dkdldmZBe?eCZDe?eEZFe?eGZHe?eIZJe@eIeKfZLdd"dndoZMdS)va 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@s.eZdZUded<ded<ded<ded<dS)DeprecatedOptionstrkey str | Nonemsgrkey removal_verN__name__ __module__ __qualname____annotations__rrN/var/www/ai-form-bot/venv/lib/python3.9/site-packages/pandas/_config/config.pyrQs rc@s6eZdZUded<ded<ded<ded<ded <d S) RegisteredOptionrrobjectdefvaldocCallable[[object], Any] | None validatorCallable[[str], Any] | NonecbNrrrrrrXs rzdict[str, DeprecatedOption]_deprecated_optionszdict[str, RegisteredOption]_registered_optionsdict[str, Any]_global_configall list[str]_reserved_keysc@seZdZdZdS) OptionErrorz Exception raised for pandas.options. Backwards compatible with KeyError checks. Examples -------- >>> pd.options.context Traceback (most recent call last): OptionError: No such option N)rrr__doc__rrrrr-msr-rbool)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)r0r1keysrrrr_get_single_keys  r:FrcCst||}t|\}}||SN)r: _get_root)r0r1rrootkrrr _get_options  r?Noner2c Ost|}|r|ddkr td|dd}|rPtt|}td|dt|ddd|dddD]\}}t||}t |}|r|j r| |t |\} } || | <|j rn|rt jd d | |Wdq1s0Yqn| |qndS) Nrz4Must provide an even number of non-keyword argumentsr1Fz2_set_option() got an unexpected keyword argument ""r3T)record)r5 ValueErrorpopnextiterr9 TypeErrorzipr:_get_registered_optionr#r<r%warningscatch_warnings) argskwargsnargsr1kwargr>vror=Zk_rootrrr _set_options& &    *rTTr)r0 _print_descr2cCsDt|}t|dkrtdddd|D}|r@t|dS|S)NrNo such keys(s) cSsg|] }t|qSr)_build_option_description.0r>rrr z$_describe_option..)r4r5r-joinprint)r0rVr9srrr_describe_options racCsft|}t|dkrtdt|dkrDt|dkrD|dkrDtd|D]}t|t|j|dqHdS)NrrWr3r*zYou must specify at least 4 characters when resetting multiple keys, use the special keyword "all" to reset all the options to their default valuer1)r4r5r-rErTr'r )r0r1r9r>rrr _reset_options  rdr0cCst|dd}t|jSNTrc)r:rKr )r0rrrrget_default_vals rgc@s\eZdZUdZded<ddddddd Zdd dd d d ZddddZddddZdS) DictWrapperz/provide attribute-style access to a nested dictr(drUrr@)riprefixr2cCs t|d|t|d|dS)Nrirj)r __setattr__)selfrirjrrr__init__szDictWrapper.__init__r)rvalr2cCsRt|d}|r|d7}||7}||jvrFt|j|tsFt||ntddS)Nrj.z.You can only set the value of existing options)r__getattribute__ri isinstancedictrTr-)rlrrnrjrrrrks  zDictWrapper.__setattr__rc Cst|d}|r|d7}||7}zt|d|}Wn.tyb}ztd|WYd}~n d}~00t|trxt||St|SdS)NrjrorizNo such option)rrpKeyErrorr-rqrrrhr?)rlrrjrRerrrrr __getattr__s    zDictWrapper.__getattr__r+rAcCst|jSr;)listrir9)rlrrr__dir__szDictWrapper.__dir__N)rU) rrrr.rrmrkrvrxrrrrrhs  rhc@s>eZdZddddddZddd d Zeddd d Zd S)CallableDynamicDoczCallable[..., T]rr@)funcdoc_tmplr2cCs||_||_dSr;) __doc_tmpl____func__)rlrzr{rrrrm szCallableDynamicDoc.__init__r rAcOs|j|i|Sr;)r})rlrNkwdsrrr__call__szCallableDynamicDoc.__call__cCs,tddd}ttt}|jj||dS)Nr*F)rV) opts_desc opts_list)rapp_options_listrwr'r9r|format)rlrrrrrr.s zCallableDynamicDoc.__doc__N)rrrrmrpropertyr.rrrrry srya 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 c@s:eZdZdZddddZddddZdddd Zd S) option_contextaF 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 r@rAcGsLt|ddkst|dkr$tdtt|ddd|ddd|_dS)NrBrz>Need to invoke as option_context(pat, val, [(pat, val), ...]).r3)r5rErwrJops)rlrNrrrrms zoption_context.__init__cCs4dd|jD|_|jD]\}}t||ddqdS)NcSsg|]\}}|t|fqSr)r?)r[r0rnrrrr\r]z,option_context.__enter__..Trc)rundorT)rlr0rnrrr __enter__szoption_context.__enter__cGs(|jr$|jD]\}}t||ddq dSrf)rrT)rlrNr0rnrrr__exit__szoption_context.__exit__N)rrrr.rmrrrrrrrs rrr"r$)rr r!r#r%r2c 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 keyro^$z is not a valid identifierz is a python keywordz5Path prefix to option '{option}' is already an option)option)rr r!r#r%)keywordtokenizelowerr'r-r,splitrematchNamerE iskeywordr) enumeraterqrrrr^r) rr r!r#r%rrpathr>cursorriprrrregister_options:       r)rrrrr2cCs6|}|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)rrrrrrrdeprecate_option6s'r)r0r2cs8tvrgStt}dkr&|Sfdd|DS)zb returns a list of keys matching `pat` if pat=="all", returns all registered options r*cs g|]}t|tjr|qSr)rsearchIrZrerrr\xr]z#_select_options..)r'sortedr9)r0r9rrerr4is  r4ztuple[dict[str, Any], str])rr2cCs4|d}t}|ddD] }||}q||dfS)Nror)rr))rrrrrrrr<{s   r<cCs|}|tvS)z4Returns True if the given option has been deprecated)rr&rsrrr_is_deprecatedsrrscCs*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&rtrrirrr_get_deprecated_options   rcCs t|S)z Retrieves the option metadata if `key` is a registered option. Returns ------- RegisteredOption (namedtuple) if key is deprecated, None otherwise )r'getrsrrrrKsrKcCst|}|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)rrrrrrr8s r8cCst|}|r|jr(tj|jttdnVd|d}|jrJ|d|j7}|jrd|d|jd7}n|d7}tj|ttddSd 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)rrrLwarn FutureWarningr rr)rrirrrrr6s" r6)r>r2cCst|}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 rXzNo description available.z [default: z] [currently: T]rUz (Deprecatedz, use `z ` instead.)) rKrr!r^striprr r?r)r>rSrir`rrrrrYs  rYP Iterable[str]int)r9width_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)wraprrr+)nameksr2csP|rd|dnd}d||ddd}|rL|drL|rL|dd |d<|S) Nz- z.[rUz, z F)initial_indentsubsequent_indentbreak_long_wordsrr)r^)rrpfxls)rrrrppszpp_options_list..ppcSsg|]}|ddkr|qSrorfindr[xrrrr\r]z#pp_options_list..rUcSsg|]}|ddkr|qSrrrrrrr\r]cSs|d|dSNro)rfindrrrrr]z!pp_options_list..cs g|]}|tddqS)r3N)r5r)r>rrr\r]rXN) itertoolsrtextwraprrrwr^r_) r9rrrrrZsinglesgrr`r)r>rrrrs     rzGenerator[None, None, None])rjr2c#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 )rzr2csddfdd }tt|S)Nrrscs$d|}|g|Ri|Srr)rrNr~pkey)rzrjrrinner+sz*config_prefix..wrap..inner)r r )rzrrj)rzrr*szconfig_prefix..wrapN)r get_option set_option)rjrZ_register_optionr?rTrrr config_prefix srz type[Any]zCallable[[Any], None])_typer2csddfdd }|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@rAcs t|krtdddS)NzValue must have type 'r)typerErrrrrQs zis_type_factory..innerrrrrrris_type_factoryCsrcsLtttfr(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@rAcst|stddS)NzValue must be an instance of )rqrErrZ type_reprrrrks z"is_instance_factory..inner)rqtuplerwr^maprrrrris_instance_factoryXs  rcs4ddDddDddfdd }|S)NcSsg|]}t|r|qSrcallabler[crrrr\sr]z%is_one_of_factory..cSsg|]}t|s|qSrrrrrrr\tr]r@rAcs\vrXtfddDsXddD}d|}d|}trP|d7}t|dS)Nc3s|]}|VqdSr;rrrrr xr]z3is_one_of_factory..inner..cSsg|] }t|qSr)r)r[Zlvalrrrr\yr]z4is_one_of_factory..inner..rzValue must be one of z or a callable)anyr^r5rE)rZuvalsZ pp_valuesrZ callables legal_valuesrrrvs  z is_one_of_factory..innerr)rrrrris_one_of_factoryrs r)valuer2cCs2|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)rqrrE)rrrrris_nonnegative_ints 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)rrE)objrrr is_callables r)F)rUT)F)rUNN)NNN)rF)Nr. __future__r contextlibrrrtypingrrrrr r rLZpandas._typingr r Zpandas.util._exceptionsr collections.abcrrrrr&rr'r)r,AttributeErrorrtr-r:r?rTrardrgrhryZ_get_option_tmplZ_set_option_tmplZ_describe_option_tmplZ_reset_option_tmplrrZ reset_optionZdescribe_optionoptionsrrrr4r<rrrKr8r6rYrrrrrrrZis_intr/Zis_boolfloatZis_floatrZis_strbytesZis_textrrrrrs~2        0'/(&    $M3  &6