U
    b                     @  s  U d dl mZ d dlmZmZmZmZmZmZm	Z	m
Z
mZmZ d dlmZ d dlmZmZ erd dlmZ ee Zedeegef dZi Zded	< d
ddddZdFddddddZdd
dddZdddddZdddddZed dd!d"d#Zed$d$d!d%d#Zeddd!d&d#Zeddd!d'd#Zd(d)d!d*d#Zed+d,d-d.d/Z edd0d-d1d/Z d2d3d-d4d/Z d5d6d7d8d9d:Z!d5d;d<d=d>d?Z"d@dAdAdBdCdDZ#dES )G    )annotations)
TYPE_CHECKINGAnyCallableHashableIterableLiteralMutableMappingSequenceTypeVaroverload)import_optional_dependency)
is_integeris_list_like)ExcelWriterusecols_func)boundz"MutableMapping[str, ExcelWriter_t]_writersExcelWriter_tNone)klassreturnc                 C  s0   t | std| j}t|ts$t| t|< dS )z
    Add engine to the excel writer registry.io.excel.

    You must use this method to integrate with ``to_excel``.

    Parameters
    ----------
    klass : ExcelWriter
    z&Can only register callables as enginesN)callable
ValueErrorZengine
isinstancestrAssertionErrorr   )r   engine_name r   9/tmp/pip-unpacked-wheel-ck39h295/pandas/io/excel/_util.pyregister_writer    s
    
r    readerr   zLiteral[('reader', 'writer')])extmoder   c                 C  s`   dddddd}dddddd}|dks,t |dkrTtd	d
d}|rLd	|d< ||  S ||  S dS )a  
    Return the default reader/writer for the given extension.

    Parameters
    ----------
    ext : str
        The excel file extension for which to get the default engine.
    mode : str {'reader', 'writer'}
        Whether to get the default engine for reading or writing.
        Either 'reader' or 'writer'

    Returns
    -------
    str
        The default engine for the extension.
    ZopenpyxlZpyxlsbZxlrdZodf)xlsxZxlsmZxlsbZxlsZodsZxlwt)r!   writerr%   
xlsxwriterwarn)errorsr$   N)r   r   )r"   r#   Z_default_readersZ_default_writersr&   r   r   r   get_default_engine2   s&    r)   )r   r   c              
   C  sD   z
t |  W S  tk
r> } ztd|  d|W 5 d }~X Y nX d S )NzNo Excel writer '')r   KeyErrorr   )r   errr   r   r   
get_writer\   s    
r-   int)xr   c                 C  sd   d}|    D ]J}t|}|tdk s4|tdkrBtd|  |d | td d }q|d S )ai  
    Convert Excel column name like 'AB' to 0-based column index.

    Parameters
    ----------
    x : str
        The Excel column name to convert to a 0-based column index.

    Returns
    -------
    num : int
        The column index corresponding to the name.

    Raises
    ------
    ValueError
        Part of the Excel column name was invalid.
    r   AZzInvalid column name:       )upperstripordr   )r/   indexccpr   r   r   
_excel2numc   s    r:   z	list[int])areasr   c                 C  s^   g }|  dD ]J}d|krJ| d}|tt|d t|d d  q|t| q|S )a  
    Convert comma separated list of column names and ranges to indices.

    Parameters
    ----------
    areas : str
        A string containing a sequence of column ranges (or areas).

    Returns
    -------
    cols : list
        A list of 0-based column indices.

    Examples
    --------
    >>> _range2cols('A:E')
    [0, 1, 2, 3, 4]
    >>> _range2cols('A,C,Z:AB')
    [0, 2, 25, 26, 27]
    ,:r   r3   )splitextendranger:   append)r;   colsrngZrngsr   r   r   _range2cols   s    
&rD   zstr | list[int])usecolsr   c                 C  s   d S Nr   rE   r   r   r   maybe_convert_usecols   s    rH   z	list[str]c                 C  s   d S rF   r   rG   r   r   r   rH      s    c                 C  s   d S rF   r   rG   r   r   r   rH      s    c                 C  s   d S rF   r   rG   r   r   r   rH      s    z1str | list[int] | list[str] | usecols_func | Nonez+None | list[int] | list[str] | usecols_funcc                 C  s2   | dkr| S t | rtdt| tr.t| S | S )a  
    Convert `usecols` into a compatible format for parsing in `parsers.py`.

    Parameters
    ----------
    usecols : object
        The use-columns object to potentially convert.

    Returns
    -------
    converted : object
        The compatible format of `usecols`.
    Nz}Passing an integer for `usecols` is no longer supported.  Please pass in a list of int from 0 to `usecols` inclusive instead.)r   r   r   r   rD   rG   r   r   r   rH      s    
ztuple[int, int]zLiteral[True])freeze_panesr   c                 C  s   d S rF   r   rI   r   r   r   validate_freeze_panes   s    rK   zLiteral[False]c                 C  s   d S rF   r   rJ   r   r   r   rK      s    ztuple[int, int] | Noneboolc                 C  s6   | d k	r2t | dkr*tdd | D r*dS tddS )N   c                 s  s   | ]}t |tV  qd S rF   )r   r.   ).0itemr   r   r   	<genexpr>   s    z(validate_freeze_panes.<locals>.<genexpr>TzLfreeze_panes must be of form (row, column) where row and column are integersF)lenallr   rJ   r   r   r   rK      s    zlist[Hashable]z
list[bool]z!tuple[list[Hashable], list[bool]])rowcontrol_rowr   c                 C  sf   | d }t dt| D ]F}|| s*| | }| | dksB| | dkrL|| |< qd||< | | }q| |fS )a  
    Forward fill blank entries in row but only inside the same parent index.

    Used for creating headers in Multiindex.

    Parameters
    ----------
    row : list
        List of items in a single row.
    control_row : list of bool
        Helps to determine if particular column is in same parent index as the
        previous value. Used to stop propagation of empty cells between
        different indexes.

    Returns
    -------
    Returns changed row and control_row
    r   r3    NF)r@   rQ   )rS   rT   lastir   r   r   fill_mi_header   s    

rX   zint | Sequence[int]z&tuple[Hashable | None, list[Hashable]])rS   	index_colr   c                 C  sp   t |r t|tstt|}nt|tr.t|}| | }|dkrFdn|}|| d| dg | |d d  fS )a  
    Pop the header name for MultiIndex parsing.

    Parameters
    ----------
    row : list
        The data row to parse for the header name.
    index_col : int, list
        The index columns for our data. Assumed to be non-null.

    Returns
    -------
    header_name : str
        The extracted header name.
    trimmed_row : list
        The original data row with the header name removed.
    rU   Nr3   )r   r   r   r   max)rS   rY   rW   header_namer   r   r   pop_header_name  s    
r\   zdict[str, Any] | Nonedict)engine_kwargskwargsr   c                 C  s$   | dkri }n|   }|| |S )a  
    Used to combine two sources of kwargs for the backend engine.

    Use of kwargs is deprecated, this function is solely for use in 1.3 and should
    be removed in 1.4/2.0. Also _base.ExcelWriter.__new__ ensures either engine_kwargs
    or kwargs must be None or empty respectively.

    Parameters
    ----------
    engine_kwargs: dict
        kwargs to be passed through to the engine.
    kwargs: dict
        kwargs to be psased through to the engine (deprecated)

    Returns
    -------
    engine_kwargs combined with kwargs
    N)copyupdate)r^   r_   resultr   r   r   combine_kwargs7  s
    
rc   N)r!   )$
__future__r   typingr   r   r   r   r   r   r	   r
   r   r   Zpandas.compat._optionalr   Zpandas.core.dtypes.commonr   r   Zpandas.io.excel._baser   typer   objectr   r   __annotations__r    r)   r-   r:   rD   rH   rK   rX   r\   rc   r   r   r   r   <module>   s>    0* !#"