U f/e\@sUdZddlmZddlmZddlmZmZddlZddl m Z m Z m Z m Z ddlZddlmZedd Zed d ZiZd ed <iZded<iZded<dgZded<GdddeeZddddddZdmdddddZd d!d"d#Zdnddd&d'd(Zdoddd dd)d*Zdd+d,d-Z Gd.d/d/Z!Gd0d1d1Z"d2Z#d3Z$d4Z%d5Z&e"ee#a'e"ee$a(e"ee&a)e"ee%Z*e!eZ+Gd6d7d7eZ,dpdd8dd9d:d d;dd>d d?d@dAZ.dddBdCdDZ/ddEdFdGdHZ0dddFdIdJZ1ddKdLdMZ2ddKdNdOZ3dddFdPdQZ4dddFdRdSZ5dddTdUdVZ6drdXddYdZd[Z7ed\d]Z8d^d_d`dadbZ9d_d!dcddZ:d_d!dedfZ;dgd dhdidjZe9e?Z@e9eAZBe9eCZDe:eCeEfZFdd!dkdlZGdS)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) namedtuple)ContextDecoratorcontextmanagerN)AnyCallableIterablecast)FDeprecatedOptionzkey msg rkey removal_verRegisteredOptionzkey defval doc validator cbzdict[str, DeprecatedOption]_deprecated_optionszdict[str, RegisteredOption]_registered_optionsdict[str, Any]_global_configall list[str]_reserved_keysc@seZdZdZdS) OptionErrorzU Exception for pandas.options, backwards compatible with KeyError checks N)__name__ __module__ __qualname____doc__rr9/tmp/pip-unpacked-wheel-tiezk1ph/pandas/_config/config.pyrUsrstrbool)patsilentreturncCsft|}t|dkr2|s t|tdt|t|dkrFtd|d}|sZt|t|}|S)NrzNo such keys(s): zPattern matched multiple keys)_select_optionslen_warn_if_deprecatedrrepr_translate_key)rrkeyskeyrrr_get_single_key`s  r(F)rrcCst||}t|\}}||SN)r( _get_root)rrr'rootkrrr _get_optionrs  r-Nonerc Ost|}|r|ddkr td|dd}|rPt|d}td|dt|ddd|dddD]z\}}t||}t|}|r|j r| |t |\} }|| |<|j rn|rt j d d | |W5QRXqn| |qndS) Nrz4Must provide an even number of non-keyword argumentsrFz2_set_option() got an unexpected keyword argument ""r T)record)r" ValueErrorpoplistr& TypeErrorzipr(_get_registered_option validatorr*cbwarningscatch_warnings) argskwargsnargsrkwargr,vr'or+rrr _set_optionzs& &    rCT)r _print_desccCsFt|}t|dkrtdddd|D}|r>t|n|SdS)NrNo such keys(s) css|]}t|VqdSr))_build_option_description.0r,rrr sz#_describe_option..)r!r"rjoinprint)rrEr&srrr_describe_options  rOcCsft|}t|dkrtdt|dkrDt|dkrD|dkrDtd|D]}t|t|j|dqHdS)NrrFr rzYou 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!r"rr3rCrdefval)rrr&r,rrr _reset_options  rSrcCst|dd}t|jSNTrQ)r(r8rR)rr'rrrget_default_vals rVc@sPeZdZdZddddddZddd d d d Zdd ddZddddZdS) DictWrapperz/provide attribute-style access to a nested dictrDrr)dprefixcCs t|d|t|d|dS)NrXrY)object __setattr__)selfrXrYrrr__init__szDictWrapper.__init__rr.)r'valrcCsRt|d}|r|d7}||7}||jkrFt|j|tsFt||ntddS)NrY.z.You can only set the value of existing options)rZ__getattribute__rX isinstancedictrCr)r\r'r^rYrrrr[s  zDictWrapper.__setattr__r'c Cst|d}|r|d7}||7}zt|d|}Wn,tk r`}ztd|W5d}~XYnXt|trvt||St|SdS)NrYr_rXzNo such option)rZr`KeyErrorrrarbrWr-)r\r'rYrAerrrrr __getattr__s   zDictWrapper.__getattr__ Iterable[str]r/cCst|jSr))r5rXr&)r\rrr__dir__szDictWrapper.__dir__N)rD)rrrrr]r[rfrhrrrrrWs  rWc@s(eZdZddZddZeddZdS)CallableDynamicDoccCs||_||_dSr)) __doc_tmpl____func__)r\funcZdoc_tmplrrrr]szCallableDynamicDoc.__init__cOs |j||Sr))rk)r\r=kwdsrrr__call__szCallableDynamicDoc.__call__cCs,tddd}ttt}|jj||dS)NrF)rE) opts_desc opts_list)rOpp_options_listr5rr&rjformat)r\rorprrrrs zCallableDynamicDoc.__doc__N)rrrr]rnpropertyrrrrrrisria; 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 not 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): ... ... cGsLt|ddkst|dkr$tdtt|ddd|ddd|_dS)Nr0rz>Need to invoke as option_context(pat, val, [(pat, val), ...]).r )r"r3r5r7ops)r\r=rrrr]s zoption_context.__init__cCs4dd|jD|_|jD]\}}t||ddqdS)NcSs g|]\}}|t|ddfqS)TrQ)r-)rJrr^rrr sz,option_context.__enter__..TrQ)ruundorC)r\rr^rrr __enter__szoption_context.__enter__cGs(|jr$|jD]\}}t||ddq dSrU)rwrC)r\r=rr^rrr__exit__szoption_context.__exit__N)rrrrr]rxryrrrrrts rtrZzCallable[[Any], Any] | NonezCallable[[str], Any] | None)r'rRdocr9r:rc CsVddl}ddl}|}|tkr0td|d|tkrHtd|d|rT|||d}|D]@}td|j d|st |d | |rbt |d qbt } d } t |dd D]H\} } t| tst| jd|d| d | | kri| | <| | } 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 keyr_^$z is not a valid identifierz is a python keywordz5Path prefix to option '{option}' is already an option)option)r'rRrzr9r:)keywordtokenizelowerrrrsplitrematchNamer3 iskeywordr enumeraterarbrrrLr ) r'rRrzr9r:rrpathr,cursormsgiprrrregister_optionsB      rz str | None)r'rrkeyrcCs6|}|tkr 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 : 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. r{z)' has already been defined as deprecated.N)rr rr )r'rr removal_verrrrdeprecate_options$r)rrcs8tkrgStt}dkr&|Sfdd|DS)zb returns a list of keys matching `pat` if pat=="all", returns all registered options rcs g|]}t|tjr|qSr)rsearchIrIrTrrrv2sz#_select_options..)rsortedr&)rr&rrTrr!#s  r!ztuple[dict[str, Any], str])r'rcCs4|d}t}|ddD] }||}q||dfS)Nr_r~)rr)r'rrrrrrr*5s   r*cCs|}|tkS)z4Returns True if the given option has been deprecated)rr rcrrr_is_deprecated=srrccCs,z t|}Wntk r"YdSX|SdS)z Retrieves the metadata for a deprecated option, if `key` is deprecated. Returns ------- DeprecatedOption (namedtuple) if key is deprecated, None otherwise N)r rdr'rXrrr_get_deprecated_optionCs  rcCs t|S)z Retrieves the option metadata if `key` is a registered option. Returns ------- RegisteredOption (namedtuple) if key is deprecated, None otherwise )rgetrcrrrr8Ssr8cCst|}|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)rrrrrrr%^s r%cCst|}|r|jr,t|jt|jtnPd|d}|jrN|d|j7}|jrh|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)rrrMr;warn FutureWarningrr)r'rXrrrrr#js   r#)r,rcCst|}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 rGzNo description available.z [default: z] [currently: T]rDz (Deprecatedz, use `z ` instead.)) r8rrzrLstriprrRr-r)r,rBrXrNrrrrrHs  rHPrg)r&_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)wraprrgr)nameksrcsP|rd|dnd}d||ddd}|rL|drL|rL|dd |d<|S) Nz- z.[rDz, z F)initial_indentsubsequent_indentbreak_long_wordsr~r)rL)rrpfxls)widthrrrppszpp_options_list..ppcSsg|]}|ddkr|qSr_rfindrJxrrrrvsz#pp_options_list..rDcSsg|]}|ddkr|qSrrrrrrrvscSs|d|dSNr_)rfindrrrrz!pp_options_list..cs g|]}|tddqS)r N)r"r)r,rrrvsrGN) itertoolsrtextwraprrr5rLrM) r&rrrrrZsinglesgrrNr)r,rrrrqs     rqc#sNdddfdd }t}t}t}|ta|ta|tadV|a|a|adS)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 )rlrcsddfdd }tt|S)Nrrccsd|}|f||Srr)r'r=rmZpkey)rlrYrrinnersz*config_prefix..wrap..inner)r r )rlrrY)rlrrszconfig_prefix..wrapN)r get_option set_option)rYrZ_register_optionr-rCrrr config_prefixsrz type[Any]zCallable[[Any], None])_typercsddfdd }|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)typer3rrrrrs zis_type_factory..innerrrrrrris_type_factorysrcsLtttfr(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 )rar3rrZ type_reprrrr s z"is_instance_factory..inner)ratupler5rLmaprrrrris_instance_factory s  rcs4ddDddDddfdd }|S)NcSsg|]}t|r|qSrcallablerJcrrrrv)sz%is_one_of_factory..cSsg|]}t|s|qSrrrrrrrv*sr.r/cs\krXtfddDsXddD}d|}d|}trP|d7}t|dS)Nc3s|]}|VqdSr)rrrrrrK/sz3is_one_of_factory..inner..cSsg|] }t|qSr)r)rJZlvalrrrrv0sz4is_one_of_factory..inner..rzValue must be one of z or a callable)anyrLr"r3)rZuvalsZ pp_valuesrZ callables legal_valuesrrr,s  z is_one_of_factory..innerr)rrrrris_one_of_factory's rz int | None)valuercCs2|dkr 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)raintr3)rrrrris_nonnegative_int:s 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)rr3)objrrr is_callable\s r)F)rDT)F)rDNN)NNN)rF)Hr __future__r collectionsr contextlibrrrtypingrrrr r;Zpandas._typingr r r r __annotations__rrrAttributeErrorrdrr(r-rCrOrSrVrWriZ_get_option_tmplZ_set_option_tmplZ_describe_option_tmplZ_reset_option_tmplrrZ reset_optionZdescribe_optionoptionsrtrrr!r*rrr8r%r#rHrqrrrrrrZis_intrZis_boolfloatZis_floatrZis_strbytesZis_textrrrrrsz2          . "     #L0  & 4