B
    Y0d\                 @  s  U d Z ddlm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 ddlZddlmZ edd	Zed
d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ddddddZdmdddddZd d!d"d#Zdnddd&d'd(Zdoddd dd)d*Zdd+d,d-Z G d.d/ d/Z!G d0d1 d1Z"d2Z#d3Z$d4Z%d5Z&e"ee#a'e"ee$a(e"ee&a)e"ee%Z*e!eZ+G d6d7 d7eZ,dpdd8dd9d:d d;d<d=a-dqdd>d>d d?d@dAZ.dddBdCdDZ/ddEdFdGdHZ0dddFdIdJZ1ddKdLdMZ2ddKdNdOZ3dddFdPdQZ4dddFdRdSZ5dddTdUdVZ6drdXddYdZd[Z7ed\d] Z8d^d_d`dadbZ9d_d!dcddZ:d_d!dedfZ;dgd dhdidjZ<e9e=Z>e9e?Z@e9eAZBe9eCZDe:eCeEfZFdd!dkdlZGdS )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)ContextDecoratorcontextmanagerN)AnyCallableIterablecast)FDeprecatedOptionzkey msg rkey removal_verRegisteredOptionzkey defval doc validator cbzdict[str, DeprecatedOption]_deprecated_optionszdict[str, RegisteredOption]_registered_optionszdict[str, Any]_global_configallz	list[str]_reserved_keysc               @  s   e Zd ZdZdS )OptionErrorzU
    Exception for pandas.options, backwards compatible with KeyError
    checks
    N)__name__
__module____qualname____doc__ r   r   G/var/www/html/venv/lib/python3.7/site-packages/pandas/_config/config.pyr   U   s   r   strbool)patsilentreturnc             C  sf   t | }t|dkr2|s t|  tdt|  t|dkrFtd|d }|sZt| t|}|S )Nr   zNo such keys(s):    zPattern matched multiple keys)_select_optionslen_warn_if_deprecatedr   repr_translate_key)r   r   keyskeyr   r   r   _get_single_key`   s    r&   F)r   r   c             C  s   t | |}t|\}}|| S )N)r&   	_get_root)r   r   r%   rootkr   r   r   _get_optionr   s    
r*   None)r   c        
   
   O  s   t | }|r|d dkr td|dd}|rPt| d }td| dxt| d d d | dd d D ]z\}}t||}t|}|r|j	r|	| t
|\}	}||	|< |jrp|rtjd	d
 || W d Q R X qp|| qpW d S )N   r   z4Must provide an even number of non-keyword argumentsr   Fz2_set_option() got an unexpected keyword argument ""r   T)record)r    
ValueErrorpoplistr$   	TypeErrorzipr&   _get_registered_option	validatorr'   cbwarningscatch_warnings)
argskwargsnargsr   kwargr)   vr%   or(   r   r   r   _set_optionz   s&    (


r?    T)r   _print_descc             C  sF   t | }t|dkrtdddd |D }|r>t| n|S d S )Nr   zNo such keys(s)
c             s  s   | ]}t |V  qd S )N)_build_option_description).0r)   r   r   r   	<genexpr>   s    z#_describe_option.<locals>.<genexpr>)r   r    r   joinprint)r   rA   r$   sr   r   r   _describe_option   s    
rI   c             C  sj   t | }t|dkrtdt|dkrDt| dk rD| dkrDtdx |D ]}t|t| j|d qJW d S )Nr   zNo such keys(s)r      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)r   )r   r    r   r/   r?   r   defval)r   r   r$   r)   r   r   r   _reset_option   s     
rL   )r   c             C  s   t | dd}t|jS )NT)r   )r&   r4   rK   )r   r%   r   r   r   get_default_val   s    rM   c               @  sP   e Zd ZdZddddddZddd	d
ddZddddZddddZdS )DictWrapperz/provide attribute-style access to a nested dictr@   zdict[str, Any]r   )dprefixc             C  s    t | d| t | d| d S )NrO   rP   )object__setattr__)selfrO   rP   r   r   r   __init__   s    zDictWrapper.__init__r   r+   )r%   valr   c             C  sR   t | d}|r|d7 }||7 }|| jkrFt| j| tsFt|| ntdd S )NrP   .z.You can only set the value of existing options)rQ   __getattribute__rO   
isinstancedictr?   r   )rS   r%   rU   rP   r   r   r   rR      s    zDictWrapper.__setattr__)r%   c          
   C  s   t | d}|r|d7 }||7 }yt | d| }W n, tk
r` } ztd|W d d }~X Y nX t|trvt||S t|S d S )NrP   rV   rO   zNo such option)rQ   rW   KeyErrorr   rX   rY   rN   r*   )rS   r%   rP   r=   errr   r   r   __getattr__   s    

zDictWrapper.__getattr__zIterable[str])r   c             C  s   t | j S )N)r1   rO   r$   )rS   r   r   r   __dir__   s    zDictWrapper.__dir__N)r@   )r   r   r   r   rT   rR   r\   r]   r   r   r   r   rN      s
   rN   c               @  s(   e Zd Zdd Zdd Zedd ZdS )CallableDynamicDocc             C  s   || _ || _d S )N)__doc_tmpl____func__)rS   funcZdoc_tmplr   r   r   rT      s    zCallableDynamicDoc.__init__c             O  s   | j ||S )N)r`   )rS   r9   kwdsr   r   r   __call__   s    zCallableDynamicDoc.__call__c             C  s,   t ddd}ttt }| jj||dS )Nr   F)rA   )	opts_desc	opts_list)rI   pp_options_listr1   r   r$   r_   format)rS   rd   re   r   r   r   r      s    zCallableDynamicDoc.__doc__N)r   r   r   rT   rc   propertyr   r   r   r   r   r^      s   r^   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(   e Zd ZdZdd Zdd Zdd ZdS )	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):
    ...     ...
    c             G  sL   t |d dkst |dk r$tdtt|d d d |dd d | _d S )Nr,   r   z>Need to invoke as option_context(pat, val, [(pat, val), ...]).r   )r    r/   r1   r3   ops)rS   r9   r   r   r   rT     s    zoption_context.__init__c             C  s8   dd | j D | _x | j D ]\}}t||dd qW d S )Nc             S  s    g | ]\}}|t |d dfqS )T)r   )r*   )rD   r   rU   r   r   r   
<listcomp>  s    z,option_context.__enter__.<locals>.<listcomp>T)r   )rj   undor?   )rS   r   rU   r   r   r   	__enter__  s    zoption_context.__enter__c             G  s,   | j r(x | j D ]\}}t||dd qW d S )NT)r   )rl   r?   )rS   r9   r   rU   r   r   r   __exit__  s    zoption_context.__exit__N)r   r   r   r   rT   rm   rn   r   r   r   r   ri     s   
ri   rQ   zCallable[[Any], Any] | NonezCallable[[str], Any] | None)r%   rK   docr5   r6   r   c             C  s`  ddl }ddl}|  } | tkr0td|  d| tkrHtd|  d|rT|| | d}xH|D ]@}td|j	 d |st
| d	||rdt
| d
qdW t}	d}
x^t|dd D ]J\}}t|	tst|
jd|d| d||	kri |	|< |	| }	qW t|	ts:t|
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   NzOption '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%   rK   ro   r5   r6   )keywordtokenizelowerr   r   r   splitrematchNamer/   	iskeywordr   	enumeraterX   rY   rg   rF   r   )r%   rK   ro   r5   r6   rt   ru   pathr)   cursormsgipr   r   r   register_option  s8    




r   z
str | None)r%   r   rkeyr   c             C  s6   |   } | tk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 : 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.
    zOption 'z)' has already been defined as deprecated.N)rv   r   r   r   )r%   r   r   removal_verr   r   r   deprecate_option  s    $r   )r   r   c               s8    t k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   )rx   searchI)rD   r)   )r   r   r   rk   2  s    z#_select_options.<locals>.<listcomp>)r   sortedr$   )r   r$   r   )r   r   r   #  s    r   ztuple[dict[str, Any], str])r%   r   c             C  s8   |  d}t}x|d d D ]}|| }qW ||d fS )NrV   rr   )rw   r   )r%   r}   r~   r   r   r   r   r'   5  s
    
r'   c             C  s   |   } | tkS )z4Returns True if the given option has been deprecated)rv   r   )r%   r   r   r   _is_deprecated=  s    r   )r%   c             C  s*   yt |  }W n tk
r    dS X |S dS )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%   rO   r   r   r   _get_deprecated_optionC  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   get)r%   r   r   r   r4   S  s    r4   c             C  s   t | }|r|jp| S | S dS )z
    if key id deprecated and a replacement key defined, will return the
    replacement key, otherwise returns `key` as - is
    N)r   r   )r%   rO   r   r   r   r#   ^  s    
r#   c             C  s   t | }|r|jr,t|j t|jt nPd|  d}|jrN|d|j 7 }|jrh|d|j d7 }n|d7 }t|t 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.
    'z' is deprecatedz and will be removed in z, please use 'z
' instead.z, please refrain from using it.TF)r   r   rG   r7   warnFutureWarningr   r   )r%   rO   r   r   r   r   r!   j  s    
r!   )r)   r   c             C  s   t | }t| }|  d}|jr<|d|j d7 }n|d7 }|rf|d|j dt| d d7 }|r|jprd}|d	7 }|d
| d7 }|d7 }|S )zCBuilds a formatted description of a registered option and prints it rB   zNo description available.z
    [default: z] [currently: T]r@   z
    (Deprecatedz, use `z
` instead.))	r4   r   ro   rF   striprw   rK   r*   r   )r)   r>   rO   rH   r   r   r   r   rC     s    

rC   P   zIterable[str])r$   _printc       
        s   ddl m} ddlm ddddfdd	}g }d
d t| D }|rX||d|7 }dd | D } xB|t| dd D ],\ } fddt|D }|| |7 }qzW d|}	|rt|	 n|	S dS )z@Builds a concise listing of available options, grouped by prefixr   )groupby)wrapr   zIterable[str]z	list[str])nameksr   c               sP   | rd|  d nd}d | |ddd}|rL|d rL| rL|d d	 |d< |S )
Nz- z.[r@   z, z  F)initial_indentsubsequent_indentbreak_long_wordsrr   r   )rF   )r   r   pfxls)widthr   r   r   pp  s    zpp_options_list.<locals>.ppc             S  s   g | ]}| d dk r|qS )rV   r   )find)rD   xr   r   r   rk     s    z#pp_options_list.<locals>.<listcomp>r@   c             S  s   g | ]}| d dkr|qS )rV   r   )r   )rD   r   r   r   r   rk     s    c             S  s   | d |  d S )NrV   )rfind)r   r   r   r   <lambda>      z!pp_options_list.<locals>.<lambda>c               s    g | ]}|t  d  d qS )r   N)r    )rD   r   )r)   r   r   rk     s    rB   N)	itertoolsr   textwrapr   r   r1   rF   rG   )
r$   r   r   r   r   r   Zsinglesgr   rH   r   )r)   r   r   r   rf     s    

rf   c             #  sN   ddd fdd}t }t}t}|ta|ta|t a dV  |a|a|a dS )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
   )ra   r   c               s   dd fdd}t t|S )Nr   )r%   c               s    d|  } |f||S )NrV   r   )r%   r9   rb   pkey)ra   rP   r   r   inner  s    z*config_prefix.<locals>.wrap.<locals>.inner)r	   r
   )ra   r   )rP   )ra   r   r     s    zconfig_prefix.<locals>.wrapN)r   
get_option
set_option)rP   r   Z_register_optionr*   r?   r   )rP   r   config_prefix  s    r   z	type[Any]zCallable[[Any], None])_typer   c               s   d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`

    r+   )r   c               s    t |  krtd  dd S )NzValue must have type 'r   )typer/   )r   )r   r   r   r     s    zis_type_factory.<locals>.innerr   )r   r   r   )r   r   is_type_factory  s    r   c               sL   t  ttfr(t  dtt nd  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   r+   )r   c               s   t |  std d S )NzValue must be an instance of )rX   r/   )r   )r   	type_reprr   r   r      s    
z"is_instance_factory.<locals>.inner)rX   tupler1   rF   mapr   )r   r   r   )r   r   r   is_instance_factory  s    r   c               s4   dd D  dd D dd fdd}|S )Nc             S  s   g | ]}t |r|qS r   )callable)rD   cr   r   r   rk   )  s    z%is_one_of_factory.<locals>.<listcomp>c             S  s   g | ]}t |s|qS r   )r   )rD   r   r   r   r   rk   *  s    r+   )r   c               s\    krXt  fddD sXdd D }d|}d| }trP|d7 }t|d S )Nc             3  s   | ]}| V  qd S )Nr   )rD   r   )r   r   r   rE   /  s    z3is_one_of_factory.<locals>.inner.<locals>.<genexpr>c             S  s   g | ]}t |qS r   )r   )rD   Zlvalr   r   r   rk   0  s    z4is_one_of_factory.<locals>.inner.<locals>.<listcomp>r   zValue must be one of z or a callable)anyrF   r    r/   )r   ZuvalsZ	pp_valuesr   )	callableslegal_values)r   r   r   ,  s    

z is_one_of_factory.<locals>.innerr   )r   r   r   )r   r   r   is_one_of_factory'  s    r   z
int | None)valuer   c             C  s2   | dkrdS t | tr"| dkr"dS d}t|dS )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)rX   intr/   )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   r/   )objr   r   r   is_callable\  s    r   )F)r@   T)F)r@   NN)NNN)r   F)Hr   
__future__r   collectionsr   
contextlibr   r   rx   typingr   r   r   r	   r7   Zpandas._typingr
   r   r   r   __annotations__r   r   r   AttributeErrorrZ   r   r&   r*   r?   rI   rL   rM   rN   r^   Z_get_option_tmplZ_set_option_tmplZ_describe_option_tmplZ_reset_option_tmplr   r   Zreset_optionZdescribe_optionoptionsri   r   r   r   r'   r   r   r4   r#   r!   rC   rf   r   r   r   r   r   r   Zis_intr   Zis_boolfloatZis_floatr   Zis_strbytesZis_textr   r   r   r   r   <module>1   sp   

 .-" 



#  G/&5