3
Êb_`  ã               @   s†   d Z ddlZddlmZmZ ddlZddlmZ ddlm	Z
 ddlmZmZ dejfeeee edœd	d
„Zdeee dœdd„ZdS )z pickle compat é    N)ÚAnyÚOptional)ÚFilePathOrBuffer)Úpickle_compat)Úget_filepath_or_bufferÚ
get_handleÚinfer)ÚobjÚfilepath_or_bufferÚcompressionÚprotocolc       
      C   s´   t ||dd�\}}}}t|tƒ r.|dkr.d}t|d|dd�\}}|dk rPtj}z|jtj| |d�ƒ W d|jƒ  x|D ]}	|	jƒ  qxW |r®y|jƒ  W n t	k
r¬   Y nX X dS )	a  
    Pickle (serialize) object to file.

    Parameters
    ----------
    obj : any object
        Any python object.
    filepath_or_buffer : str, path object or file-like object
        File path, URL, or buffer where the pickled object will be stored.

        .. versionchanged:: 1.0.0
           Accept URL. URL has to be of S3 or GCS.

    compression : {'infer', 'gzip', 'bz2', 'zip', 'xz', None}, default 'infer'
        If 'infer' and 'path_or_url' is path-like, then detect compression from
        the following extensions: '.gz', '.bz2', '.zip', or '.xz' (otherwise no
        compression) If 'infer' and 'path_or_url' is not path-like, then use
        None (= no decompression).
    protocol : int
        Int which indicates which protocol should be used by the pickler,
        default HIGHEST_PROTOCOL (see [1], paragraph 12.1.2). The possible
        values for this parameter depend on the version of Python. For Python
        2.x, possible values are 0, 1, 2. For Python>=3.0, 3 is a valid value.
        For Python >= 3.4, 4 is a valid value. A negative value for the
        protocol parameter is equivalent to setting its value to
        HIGHEST_PROTOCOL.

        .. [1] https://docs.python.org/3/library/pickle.html
        .. versionadded:: 0.21.0

    See Also
    --------
    read_pickle : Load pickled pandas object (or any object) from file.
    DataFrame.to_hdf : Write DataFrame to an HDF5 file.
    DataFrame.to_sql : Write DataFrame to a SQL database.
    DataFrame.to_parquet : Write a DataFrame to the binary parquet format.

    Examples
    --------
    >>> original_df = pd.DataFrame({"foo": range(5), "bar": range(5, 10)})
    >>> original_df
       foo  bar
    0    0    5
    1    1    6
    2    2    7
    3    3    8
    4    4    9
    >>> pd.to_pickle(original_df, "./dummy.pkl")

    >>> unpickled_df = pd.read_pickle("./dummy.pkl")
    >>> unpickled_df
       foo  bar
    0    0    5
    1    1    6
    2    2    7
    3    3    8
    4    4    9

    >>> import os
    >>> os.remove("./dummy.pkl")
    Úwb)r   Úmoder   NF)r   Úis_textr   )r   )
r   Ú
isinstanceÚstrr   ÚpickleÚHIGHEST_PROTOCOLÚwriteÚdumpsÚcloseÚ
ValueError)
r	   r
   r   r   Ú	fp_or_bufÚ_Úshould_closeÚfÚfhÚ_f© r   ú2/tmp/pip-build-jkwsxyiy/pandas/pandas/io/pickle.pyÚ	to_pickle   s"    C
r    )r
   r   c       	   %   C   s  t | |d�\}}}}t|tƒ r,|dkr,d}t|d|dd�\}}z€y\tttf}y.tjdd�� tj	d	t
ƒ tj|ƒS Q R X W n |k
rš   tj|dd
�S X W n tk
r¼   tj|dd
�S X W d|jƒ  x|D ]}|jƒ  qÐW |�r
y|jƒ  W n tk
�r   Y nX X dS )a<  
    Load pickled pandas object (or any object) from file.

    .. warning::

       Loading pickled data received from untrusted sources can be
       unsafe. See `here <https://docs.python.org/3/library/pickle.html>`__.

    Parameters
    ----------
    filepath_or_buffer : str, path object or file-like object
        File path, URL, or buffer where the pickled object will be loaded from.

        .. versionchanged:: 1.0.0
           Accept URL. URL is not limited to S3 and GCS.

    compression : {'infer', 'gzip', 'bz2', 'zip', 'xz', None}, default 'infer'
        If 'infer' and 'path_or_url' is path-like, then detect compression from
        the following extensions: '.gz', '.bz2', '.zip', or '.xz' (otherwise no
        compression) If 'infer' and 'path_or_url' is not path-like, then use
        None (= no decompression).

    Returns
    -------
    unpickled : same type as object stored in file

    See Also
    --------
    DataFrame.to_pickle : Pickle (serialize) DataFrame object to file.
    Series.to_pickle : Pickle (serialize) Series object to file.
    read_hdf : Read HDF5 file into a DataFrame.
    read_sql : Read SQL query or database table into a DataFrame.
    read_parquet : Load a parquet object, returning a DataFrame.

    Notes
    -----
    read_pickle is only guaranteed to be backwards compatible to pandas 0.20.3.

    Examples
    --------
    >>> original_df = pd.DataFrame({"foo": range(5), "bar": range(5, 10)})
    >>> original_df
       foo  bar
    0    0    5
    1    1    6
    2    2    7
    3    3    8
    4    4    9
    >>> pd.to_pickle(original_df, "./dummy.pkl")

    >>> unpickled_df = pd.read_pickle("./dummy.pkl")
    >>> unpickled_df
       foo  bar
    0    0    5
    1    1    6
    2    2    7
    3    3    8
    4    4    9

    >>> import os
    >>> os.remove("./dummy.pkl")
    )r   r   NÚrbF)r   r   T)ÚrecordÚignore)Úencodingzlatin-1)r   r   r   r   ÚAttributeErrorÚImportErrorÚModuleNotFoundErrorÚwarningsÚcatch_warningsÚsimplefilterÚWarningr   ÚloadÚpcÚUnicodeDecodeErrorr   r   )	r
   r   r   r   r   r   r   Zexcs_to_catchr   r   r   r   Úread_pickled   s.    A

r/   )r   )Ú__doc__r   Útypingr   r   r(   Zpandas._typingr   Zpandas.compatr   r-   Zpandas.io.commonr   r   r   r   Úintr    r/   r   r   r   r   Ú<module>   s   U