B Y0d\@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_optionszdict[str, Any]_global_configallz list[str]_reserved_keysc@seZdZdZdS) OptionErrorzU Exception for pandas.options, backwards compatible with KeyError checks N)__name__ __module__ __qualname____doc__rrG/var/www/html/venv/lib/python3.7/site-packages/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|\}}||S)N)r& _get_root)rrr%rootkrrr _get_optionrs  r*None)rc Ost|}|r|ddkr td|dd}|rPt|d}td|dxt|ddd|dddD]z\}}t||}t|}|r|j r| |t |\} }|| |<|j rp|rt j d d | |WdQRXqp| |qpWdS) Nrz4Must provide an even number of non-keyword argumentsrFz2_set_option() got an unexpected keyword argument ""rT)record)r ValueErrorpoplistr$ TypeErrorzipr&_get_registered_option validatorr'cbwarningscatch_warnings) argskwargsnargsrkwargr)vr%or(rrr _set_optionzs& (    r?T)r _print_desccCsFt|}t|dkrtdddd|D}|r>t|n|SdS)NrzNo such keys(s) css|]}t|VqdS)N)_build_option_description).0r)rrr sz#_describe_option..)rr rjoinprint)rrAr$srrr_describe_options  rIcCsjt|}t|dkrtdt|dkrDt|dkrD|dkrDtdx |D]}t|t|j|dqJWdS)NrzNo such keys(s)rrzYou must specify at least 4 characters when resetting multiple keys, use the special keyword "all" to reset all the options to their default value)r)rr rr/r?rdefval)rrr$r)rrr _reset_options   rL)rcCst|dd}t|jS)NT)r)r&r4rK)rr%rrrget_default_vals rMc@sPeZdZdZddddddZddd d d d Zdd ddZddddZdS) DictWrapperz/provide attribute-style access to a nested dictr@zdict[str, Any]r)dprefixcCs t|d|t|d|dS)NrOrP)object __setattr__)selfrOrPrrr__init__szDictWrapper.__init__rr+)r%valrcCsRt|d}|r|d7}||7}||jkrFt|j|tsFt||ntddS)NrP.z.You can only set the value of existing options)rQ__getattribute__rO isinstancedictr?r)rSr%rUrPrrrrRs  zDictWrapper.__setattr__)r%c Cst|d}|r|d7}||7}yt|d|}Wn,tk r`}ztd|Wdd}~XYnXt|trvt||St|SdS)NrPrVrOzNo such option)rQrWKeyErrorrrXrYrNr*)rSr%rPr=errrrr __getattr__s   zDictWrapper.__getattr__z Iterable[str])rcCst|jS)N)r1rOr$)rSrrr__dir__szDictWrapper.__dir__N)r@)rrrrrTrRr\r]rrrrrNs  rNc@s(eZdZddZddZeddZdS)CallableDynamicDoccCs||_||_dS)N) __doc_tmpl____func__)rSfuncZdoc_tmplrrrrTszCallableDynamicDoc.__init__cOs |j||S)N)r`)rSr9kwdsrrr__call__szCallableDynamicDoc.__call__cCs,tddd}ttt}|jj||dS)NrF)rA) opts_desc opts_list)rIpp_options_listr1rr$r_format)rSrdrerrrrs zCallableDynamicDoc.__doc__N)rrrrTrcpropertyrrrrrr^sr^a; 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)Nr,rz>Need to invoke as option_context(pat, val, [(pat, val), ...]).r)r r/r1r3ops)rSr9rrrrTszoption_context.__init__cCs8dd|jD|_x |jD]\}}t||ddqWdS)NcSs g|]\}}|t|ddfqS)T)r)r*)rDrrUrrr sz,option_context.__enter__..T)r)rjundor?)rSrrUrrr __enter__szoption_context.__enter__cGs,|jr(x |jD]\}}t||ddqWdS)NT)r)rlr?)rSr9rrUrrr__exit__szoption_context.__exit__N)rrrrrTrmrnrrrrris rirQzCallable[[Any], Any] | NonezCallable[[str], Any] | None)r%rKdocr5r6rc Cs`ddl}ddl}|}|tkr0td|d|tkrHtd|d|rT|||d}xH|D]@}td|j d|st |d | |rdt |d qdWt } d } x^t |dd D]J\} } t| tst| jd|d| d | | kri| | <| | } qWt| ts:t| 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. rNzOption 'z' has already been registeredz' is a reserved keyrV^$z is not a valid identifierz is a python keywordz5Path prefix to option '{option}' is already an option)option)r%rKror5r6)keywordtokenizelowerrrrsplitrematchNamer/ iskeywordr enumeraterXrYrgrFr ) r%rKror5r6rtrupathr)cursormsgiprrrregister_options8        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. zOption 'z)' has already been defined as deprecated.N)rvr 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)rxsearchI)rDr))rrrrk2sz#_select_options..)rsortedr$)rr$r)rrr#s  rztuple[dict[str, Any], str])r%rcCs8|d}t}x|ddD] }||}qW||dfS)NrVrr)rwr)r%r}r~rrrrr'5s   r'cCs|}|tkS)z4Returns True if the given option has been deprecated)rvr )r%rrr_is_deprecated=sr)r%cCs*y t|}Wntk r dSX|SdS)z Retrieves the metadata for a deprecated option, if `key` is deprecated. Returns ------- DeprecatedOption (namedtuple) if key is deprecated, None otherwise N)r rZ)r%rOrrr_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 )rget)r%rrrr4Ssr4cCst|}|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)rr)r%rOrrrr#^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)rrrGr7warn FutureWarningrr)r%rOrrrrr!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 rBzNo description available.z [default: z] [currently: T]r@z (Deprecatedz, use `z ` instead.)) r4rrorFstriprwrKr*r)r)r>rOrHrrrrrCs  rCPz Iterable[str])r$_printc sddlm}ddlmddddfdd }g}d d t|D}|rX||d |7}d d |D}xB|t|ddD],\}fdd t|D}|||7}qzWd|} |rt| n| SdS)z@Builds a concise listing of available options, grouped by prefixr)groupby)wraprz Iterable[str]z list[str])nameksrcsP|rd|dnd}d||ddd}|rL|drL|rL|dd |d<|S) Nz- z.[r@z, z F)initial_indentsubsequent_indentbreak_long_wordsrrr)rF)rrpfxls)widthrrrppszpp_options_list..ppcSsg|]}|ddkr|qS)rVr)find)rDxrrrrksz#pp_options_list..r@cSsg|]}|ddkr|qS)rVr)r)rDrrrrrkscSs|d|dS)NrV)rfind)rrrrz!pp_options_list..cs g|]}|tddqS)rN)r )rDr)r)rrrksrBN) itertoolsrtextwraprrr1rFrG) r$rrrrrZsinglesgrrHr)r)rrrrfs     rfc#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 )rarcsddfdd }tt|S)Nr)r%csd|}|f||S)NrVr)r%r9rbpkey)rarPrrinnersz*config_prefix..wrap..inner)r r )rar)rP)rarrszconfig_prefix..wrapN)r get_option set_option)rPrZ_register_optionr*r?r)rPr 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+)rcs t|krtdddS)NzValue must have type 'r)typer/)r)rrrrs zis_type_factory..innerr)rrr)rris_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+)rcst|stddS)NzValue must be an instance of )rXr/)r)r type_reprrrr s z"is_instance_factory..inner)rXtupler1rFmapr)rrr)rrris_instance_factory s  rcs4ddDddDddfdd }|S)NcSsg|]}t|r|qSr)callable)rDcrrrrk)sz%is_one_of_factory..cSsg|]}t|s|qSr)r)rDrrrrrk*sr+)rcs\krXtfddDsXddD}d|}d|}trP|d7}t|dS)Nc3s|]}|VqdS)Nr)rDr)rrrrE/sz3is_one_of_factory..inner..cSsg|] }t|qSr)r)rDZlvalrrrrk0sz4is_one_of_factory..inner..rzValue must be one of z or a callable)anyrFr r/)rZuvalsZ pp_valuesr) callables legal_values)rrr,s  z is_one_of_factory..innerr)rrr)rrris_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)rXintr/)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)rr/)objrrr is_callable\s r)F)r@T)F)r@NN)NNN)rF)Hr __future__r collectionsr contextlibrrrxtypingrrrr r7Zpandas._typingr r r r __annotations__rrrAttributeErrorrZrr&r*r?rIrLrMrNr^Z_get_option_tmplZ_set_option_tmplZ_describe_option_tmplZ_reset_option_tmplrrZ reset_optionZdescribe_optionoptionsrirrrr'rrr4r#r!rCrfrrrrrrZis_intrZis_boolfloatZis_floatrZis_strbytesZis_textrrrrr1sp          .-"     #G/  & 5