o
    gnc                     @  s  U d Z ddlmZ ddlmZmZ ddlZddlmZm	Z	m
Z
mZmZmZ ddlZddlmZmZ ddlmZ erAddlmZmZ G d	d
 d
eZG dd deZi Zded< i Zded< i Zded< dgZded< G dd deeZ duddZ!dvdwd!d"Z"dxd$d%Z#dydzd*d+Z$dvd{d,d-Z%d|d.d/Z&G d0d1 d1Z'G d2d3 d3ee Z(d4Z)d5Z*d6Z+d7Z,e(e"e)a-e(e#e*a.e(e%e,Z/e(e$e+Z0e'eZ1G d8d9 d9eZ2	&		d}d~dBdCa3			dddGdHZ4ddIdJZ5ddLdMZ6ddNdOZ7ddPdQZ8ddRdSZ9ddTdUZ:ddVdWZ;ddYdZZ<dddadbZ=eddedfZ>ddjdkZ?ddldmZ@ddndoZAddqdrZBe?eCZDe?eEZFe?eGZHe?eIZJe@eIeKfZLddsdtZMdS )a  
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)ContextDecoratorcontextmanagerN)TYPE_CHECKINGAnyCallableGeneric
NamedTuplecast)FT)find_stack_level)	GeneratorIterablec                   @  s.   e Zd ZU ded< ded< ded< ded< dS )DeprecatedOptionstrkey
str | Nonemsgrkeyremoval_verN__name__
__module____qualname____annotations__ r   r   W/var/www/html/ecg_monitoring/venv/lib/python3.10/site-packages/pandas/_config/config.pyr   Q   s
   
 r   c                   @  s6   e Zd ZU ded< ded< ded< ded< ded	< d
S )RegisteredOptionr   r   objectdefvaldocCallable[[object], Any] | None	validatorCallable[[str], Any] | NonecbNr   r   r   r   r   r   X   s   
 r   zdict[str, DeprecatedOption]_deprecated_optionszdict[str, RegisteredOption]_registered_optionsdict[str, Any]_global_configall	list[str]_reserved_keysc                   @  s   e Zd ZdZdS )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)r   r   r   __doc__r   r   r   r   r-   m   s    r-   patr   silentboolreturnc                 C  sf   t | }t|dkr|st|  tdt|  t|dkr#td|d }|s-t| t|}|S )Nr   zNo such keys(s):    zPattern matched multiple keys)_select_optionslen_warn_if_deprecatedr-   repr_translate_key)r/   r0   keysr   r   r   r   _get_single_key   s   r:   Fr   c                 C  s   t | |}t|\}}|| S N)r:   	_get_root)r/   r0   r   rootkr   r   r   _get_option   s   
r?   Nonec               	   O  s  t | }|r|d dkrtd|dd}|r(tt| }td| dt| d d d | dd d D ]G\}}t||}t	|}|rN|j
rN|
| t|\}	}
||	|
< |jr~|rytjd	d
 || W d    n1 ssw   Y  q7|| q7d S )N   r   z4Must provide an even number of non-keyword argumentsr0   Fz2_set_option() got an unexpected keyword argument ""r3   T)record)r5   
ValueErrorpopnextiterr9   	TypeErrorzipr:   _get_registered_optionr#   r<   r%   warningscatch_warnings)argskwargsnargsr0   kwargr>   vr   or=   k_rootr   r   r   _set_option   s.   &



rT    T_print_descr   c                 C  sD   t | }t|dkrtdddd |D }|r t| d S |S )Nr   No such keys(s)
c                 S     g | ]}t |qS r   )_build_option_description.0r>   r   r   r   
<listcomp>       z$_describe_option.<locals>.<listcomp>)r4   r5   r-   joinprint)r/   rV   r9   sr   r   r   _describe_option   s   rb   c                 C  sf   t | }t|dkrtdt|dkr"t| dk r"| dkr"td|D ]}t|t| j|d q$d S )Nr   rW   r3      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 valuer0   )r4   r5   r-   rD   rT   r'   r    )r/   r0   r9   r>   r   r   r   _reset_option   s    re   c                 C  s   t | dd}t|jS NTrd   )r:   rJ   r    )r/   r   r   r   r   get_default_val   s   
rg   c                   @  sD   e Zd ZU dZded< ddd	d
ZdddZdddZdddZdS )DictWrapperz/provide attribute-style access to a nested dictr(   drU   prefixr   r2   r@   c                 C  s    t | d| t | d| d S )Nri   rj   )r   __setattr__)selfri   rj   r   r   r   __init__   s   zDictWrapper.__init__r   valr   c                 C  sP   t | d}|r|d7 }||7 }|| jv r$t| j| ts$t|| d S td)Nrj   .z.You can only set the value of existing options)r   __getattribute__ri   
isinstancedictrT   r-   )rl   r   rn   rj   r   r   r   rk      s   zDictWrapper.__setattr__c              
   C  st   t | d}|r|d7 }||7 }z
t | d| }W n ty+ } ztd|d }~ww t|tr6t||S t|S )Nrj   ro   ri   zNo such option)r   rp   KeyErrorr-   rq   rr   rh   r?   )rl   r   rj   rQ   errr   r   r   __getattr__   s   


zDictWrapper.__getattr__r+   c                 C  s   t | j S r;   )listri   r9   )rl   r   r   r   __dir__   s   zDictWrapper.__dir__N)rU   )ri   r(   rj   r   r2   r@   )r   r   rn   r   r2   r@   r   r   )r2   r+   )	r   r   r   r.   r   rm   rk   ru   rw   r   r   r   r   rh      s   
 

rh   c                   @  s.   e Zd ZdddZdd
dZedddZdS )CallableDynamicDocfuncCallable[..., T]doc_tmplr   r2   r@   c                 C  s   || _ || _d S r;   )__doc_tmpl____func__)rl   rz   r|   r   r   r   rm     s   
zCallableDynamicDoc.__init__r   c                 O  s   | j |i |S r;   )r~   )rl   rM   kwdsr   r   r   __call__  s   zCallableDynamicDoc.__call__c                 C  s,   t ddd}ttt }| jj||dS )Nr*   F)rV   )	opts_desc	opts_list)rb   pp_options_listrv   r'   r9   r}   format)rl   r   r   r   r   r   r.     s   zCallableDynamicDoc.__doc__N)rz   r{   r|   r   r2   r@   )r2   r   )r2   r   )r   r   r   rm   r   propertyr.   r   r   r   r   ry     s
    

ry   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
-----
Please reference the :ref:`User Guide <options>` 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 <options>` 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 <options>` 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 <options>` for more information.

The available options with its descriptions:

{opts_desc}

Examples
--------
>>> pd.reset_option('display.max_columns')  # doctest: +SKIP
c                   @  s.   e Zd ZdZdddZdddZddd	Zd
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
    r2   r@   c                 G  sL   t |d dkst |dk rtdtt|d d d |dd d | _d S )NrA   r   z>Need to invoke as option_context(pat, val, [(pat, val), ...]).r3   )r5   rD   rv   rI   ops)rl   rM   r   r   r   rm     s
   (zoption_context.__init__c                 C  s4   dd | j D | _| j D ]\}}t||dd qd S )Nc                 S  s   g | ]
\}}|t |fqS r   )r?   )r\   r/   rn   r   r   r   r]     s    z,option_context.__enter__.<locals>.<listcomp>Trd   )r   undorT   )rl   r/   rn   r   r   r   	__enter__  s   zoption_context.__enter__c                 G  s,   | j r| j D ]\}}t||dd qd S d S rf   )r   rT   )rl   rM   r/   rn   r   r   r   __exit__  s
   zoption_context.__exit__Nr2   r@   )r   r   r   r.   rm   r   r   r   r   r   r   r     s
    

r   r   r    r   r!   r#   r"   r%   r$   c                 C  sT  ddl }ddl}|  } | tv rtd|  d| tv r$td|  d|r*|| | d}|D ] }td|j	 d |sEt
| d	||rQt
| d
q1t}	d}
t|dd D ]$\}}t|	tsvt|
jd|d| d||	vr~i |	|< |	| }	q^t|	tst|
jd|dd d||	|d < t| ||||dt| < dS )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.

    r   NOption '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)r   r    r!   r#   r%   )keywordtokenizelowerr'   r-   r,   splitrematchNamerD   	iskeywordr)   	enumeraterq   rr   r   r_   r   )r   r    r!   r#   r%   r   r   pathr>   cursorr   ipr   r   r   register_option  s<   





r   r   r   r   c                 C  s6   |   } | tv rtd|  dt| |||t| < dS )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.
    r   z)' has already been defined as deprecated.N)r   r&   r-   r   )r   r   r   r   r   r   r   deprecate_option6  s   'r   c                   s8    t v r gS tt  } dkr|S  fdd|D S )zb
    returns a list of keys matching `pat`

    if pat=="all", returns all registered options
    r*   c                   s    g | ]}t  |t jr|qS r   )r   searchIr[   r/   r   r   r]   x       z#_select_options.<locals>.<listcomp>)r'   sortedr9   )r/   r9   r   r   r   r4   i  s   r4   tuple[dict[str, Any], str]c                 C  s4   |  d}t}|d d D ]}|| }q||d fS )Nro   r   )r   r)   )r   r   r   r   r   r   r   r<   {  s
   

r<   c                 C  s   |   } | tv S )z4Returns True if the given option has been deprecated)r   r&   r   r   r   r   _is_deprecated  s   r   c                 C  s$   zt |  }W |S  ty   Y dS w )z
    Retrieves the metadata for a deprecated option, if `key` is deprecated.

    Returns
    -------
    DeprecatedOption (namedtuple) if key is deprecated, None otherwise
    N)r&   rs   r   ri   r   r   r   _get_deprecated_option  s   
r   c                 C  s
   t | S )z
    Retrieves the option metadata if `key` is a registered option.

    Returns
    -------
    RegisteredOption (namedtuple) if key is deprecated, None otherwise
    )r'   getr   r   r   r   rJ     s   
rJ   c                 C  s   t | }|r|jp
| S | S )z
    if key id deprecated and a replacement key defined, will return the
    replacement key, otherwise returns `key` as - is
    )r   r   r   r   r   r   r8     s   
r8   c                 C  s   t | }|rB|jrtj|jtt d dS d|  d}|jr&|d|j 7 }|jr3|d|j d7 }n|d7 }tj|tt d dS d	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)r   r   rK   warnFutureWarningr   r   r   )r   ri   r   r   r   r   r6     s$   r6   r>   c                 C  s   t | }t| }|  d}|jr|d|j d7 }n|d7 }|r3|d|j dt| d d7 }|rJ|jp9d}|d	7 }|d
| d7 }|d7 }|S )zCBuilds a formatted description of a registered option and prints it rX   zNo description available.z
    [default: z] [currently: T]rU   z
    (Deprecatedz, use `z
` instead.))	rJ   r   r!   r_   stripr   r    r?   r   )r>   rR   ri   ra   r   r   r   r   rZ     s   

rZ   P   r9   Iterable[str]widthint_printc           
        s   ddl m} ddlm dfd
d}g }dd t| D }|r(||d|7 }dd | D } |t| dd D ]\ } fddt|D }|| |7 }q8d|}	|r\t|	 dS |	S )z@Builds a concise listing of available options, grouped by prefixr   )groupby)wrapnamer   ksr   r2   r+   c                   sP   | rd|  d nd}d | |ddd}|r&|d r&| r&|d d	 |d< |S )
Nz- z.[rU   z, z  F)initial_indentsubsequent_indentbreak_long_wordsr   r   )r_   )r   r   pfxls)r   r   r   r   pp  s   zpp_options_list.<locals>.ppc                 S  s   g | ]}| d dk r|qS ro   r   findr\   xr   r   r   r]         z#pp_options_list.<locals>.<listcomp>rU   c                 S  s   g | ]}| d dkr|qS r   r   r   r   r   r   r]     r   c                 S  s   | d |  d S Nro   )rfindr   r   r   r   <lambda>  s    z!pp_options_list.<locals>.<lambda>c                   s    g | ]}|t  d  d qS )r3   N)r5   r   )r>   r   r   r]     r   rX   N)r   r   r   r   r2   r+   )	itertoolsr   textwrapr   r   rv   r_   r`   )
r9   r   r   r   r   r   singlesgr   ra   r   )r>   r   r   r   r     s   
r   rj   Generator[None, None, None]c                 #  s\    d fdd}t }t}t}|ta|ta|t a zdV  W |a|a|a dS |a|a|a w )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.
    rz   r   r2   c                   s   d fdd}t t|S )Nr   r   c                   s$    d|  } |g|R i |S r   r   )r   rM   r   pkey)rz   rj   r   r   inner+  s   z*config_prefix.<locals>.wrap.<locals>.innerrx   )r
   r   )rz   r   rj   )rz   r   r   *  s   
zconfig_prefix.<locals>.wrapN)rz   r   r2   r   )r   
get_option
set_option)rj   r   _register_optionr?   rT   r   r   r   config_prefix  s    r   _type	type[Any]Callable[[Any], None]c                   s   d fdd}|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`

    r2   r@   c                   s    t |  krtd  dd S )NzValue must have type 'r   )typerD   r   r   r   r   r   Q  s   zis_type_factory.<locals>.innerNr   r   r   r   r   r   r   is_type_factoryC  s   r   c                   sH   t  ttfrt  dtt nd  dd fdd}|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`

    |r   r2   r@   c                   s   t |  std d S )NzValue must be an instance of )rq   rD   r   r   	type_reprr   r   r   k  s   
z"is_instance_factory.<locals>.innerNr   )rq   tuplerv   r_   mapr   r   r   r   r   is_instance_factoryX  s   r   c                   s0   dd D  dd D d fdd}|S )	Nc                 S  s   g | ]}t |r|qS r   callabler\   cr   r   r   r]   s      z%is_one_of_factory.<locals>.<listcomp>c                 S  s   g | ]}t |s|qS r   r   r   r   r   r   r]   t  r   r2   r@   c                   s`    vr,t  fddD s.dd D }d|}d| }tr(|d7 }t|d S d S )Nc                 3  s    | ]}| V  qd S r;   r   r   r   r   r   	<genexpr>x  s    z3is_one_of_factory.<locals>.inner.<locals>.<genexpr>c                 S  rY   r   )r   )r\   lvalr   r   r   r]   y  r^   z4is_one_of_factory.<locals>.inner.<locals>.<listcomp>r   zValue must be one of z or a callable)anyr_   r5   rD   )r   uvals	pp_valuesr   	callableslegal_valuesr   r   r   v  s   

z is_one_of_factory.<locals>.innerr   r   )r   r   r   r   r   is_one_of_factoryr  s   
r   valuec                 C  s.   | du rdS t | tr| dkrdS d}t|)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
    Nr   z+Value must be a nonnegative integer or None)rq   r   rD   )r   r   r   r   r   is_nonnegative_int  s   
r   c                 C  s   t | stddS )z

    Parameters
    ----------
    `obj` - the object to be checked

    Returns
    -------
    validator - returns True if object is callable
        raises ValueError otherwise.

    zValue must be a callableT)r   rD   )objr   r   r   is_callable  s   r   )r/   r   r0   r1   r2   r   )F)r/   r   r0   r1   r2   r   r   )rU   T)r/   r   rV   r1   r2   r   )r/   r   r0   r1   r2   r@   )r/   r   )rU   NN)r   r   r    r   r!   r   r#   r"   r%   r$   r2   r@   )NNN)
r   r   r   r   r   r   r   r   r2   r@   )r/   r   r2   r+   )r   r   r2   r   )r   r   r2   r1   rx   )r   r   r2   r   )r>   r   r2   r   )r   F)r9   r   r   r   r   r1   )rj   r   r2   r   )r   r   r2   r   )r2   r   )r   r   r2   r@   )r2   r1   )Nr.   
__future__r   
contextlibr   r   r   typingr   r   r   r   r	   r
   rK   pandas._typingr   r   pandas.util._exceptionsr   collections.abcr   r   r   r   r&   r   r'   r)   r,   AttributeErrorrs   r-   r:   r?   rT   rb   re   rg   rh   ry   _get_option_tmpl_set_option_tmpl_describe_option_tmpl_reset_option_tmplr   r   reset_optiondescribe_optionoptionsr   r   r   r4   r<   r   r   rJ   r8   r6   rZ   r   r   r   r   r   r   r   is_intr1   is_boolfloatis_floatr   is_strbytesis_textr   r   r   r   r   <module>   s    2 	

 
0'/(
&


$M
3






&
6


