U
    |h+A                     @   s  d Z ddlmZ ddlZddlZddlZddlZddlZddlZddl	Z	ddl
Z
ddlZddlZddlZddlmZmZ ddlmZ ddlmZmZmZ ddlmZ dd	lmZ ed
dZG dd deZdd ZG dd dedZ G dd de!Z"G dd de e"Z#dS )z.Storage providers backends for Memory caching.    )PicklingErrorN)ABCMetaabstractmethod   )concurrency_safe_rename)mkdirpmemstr_to_bytes
rm_subdirs)format_time)numpy_pickleCacheItemInfozpath size last_accessc                   @   s   e Zd ZdZdS )CacheWarningz:Warning to capture dump failures except for PicklingError.N)__name__
__module____qualname____doc__ r   r   :/tmp/pip-unpacked-wheel-9qhk7zno/joblib/_store_backends.pyr      s   r   c                 C   s,   t t }d||t }|| | |S )z>Writes an object into a unique file in a concurrency-safe way.z{}.thread-{}-pid-{})id	threadingcurrent_threadformatosgetpid)Zobject_to_writefilename
write_funcZ	thread_idtemporary_filenamer   r   r   concurrency_safe_write   s      
r   c                   @   sp   e Zd ZdZdZedd Zedd Zedd Zed	d
 Z	edd Z
edd Zede fddZdS )StoreBackendBasezaHelper Abstract Base Class which defines all methods that
       a StorageBackend must implement.Nc                 C   s   dS )a  Opens an item on the store and return a file-like object.

        This method is private and only used by the StoreBackendMixin object.

        Parameters
        ----------
        f: a file-like object
            The file-like object where an item is stored and retrieved
        mode: string, optional
            the mode in which the file-like object is opened allowed valued are
            'rb', 'wb'

        Returns
        -------
        a file-like object
        Nr   )selffmoder   r   r   
_open_item/   s    zStoreBackendBase._open_itemc                 C   s   dS )a  Checks if an item location exists in the store.

        This method is private and only used by the StoreBackendMixin object.

        Parameters
        ----------
        location: string
            The location of an item. On a filesystem, this corresponds to the
            absolute path, including the filename, of a file.

        Returns
        -------
        True if the item exists, False otherwise
        Nr   r   locationr   r   r   _item_existsB   s    zStoreBackendBase._item_existsc                 C   s   dS )a-  Moves an item from src to dst in the store.

        This method is private and only used by the StoreBackendMixin object.

        Parameters
        ----------
        src: string
            The source location of an item
        dst: string
            The destination location of an item
        Nr   )r   srcdstr   r   r   
_move_itemS   s    zStoreBackendBase._move_itemc                 C   s   dS )zCreates a location on the store.

        Parameters
        ----------
        location: string
            The location in the store. On a filesystem, this corresponds to a
            directory.
        Nr   r#   r   r   r   create_locationa   s    z StoreBackendBase.create_locationc                 C   s   dS )zClears a location on the store.

        Parameters
        ----------
        location: string
            The location in the store. On a filesystem, this corresponds to a
            directory or a filename absolute path
        Nr   r#   r   r   r   clear_locationl   s    zStoreBackendBase.clear_locationc                 C   s   dS )zReturns the whole list of items available in the store.

        Returns
        -------
        The list of items identified by their ids (e.g filename in a
        filesystem).
        Nr   r   r   r   r   	get_itemsw   s    zStoreBackendBase.get_itemsr   c                 C   s   dS )a  Configures the store.

        Parameters
        ----------
        location: string
            The base location used by the store. On a filesystem, this
            corresponds to a directory.
        verbose: int
            The level of verbosity of the store
        backend_options: dict
            Contains a dictionary of named parameters used to configure the
            store backend.
        Nr   )r   r$   verbosebackend_optionsr   r   r   	configure   s    zStoreBackendBase.configure)r   r   r   r   r$   r   r"   r%   r(   r)   r*   r,   dictr/   r   r   r   r   r   )   s    







	r   )	metaclassc                   @   s   e Zd ZdZd&ddZd'ddZdd	 Zd
d Zdd Zdd Z	dd Z
dd Zdd Zd(ddZdd Zdd Zdd Zd)ddZd*d d!Zd"d# Zd$d% ZdS )+StoreBackendMixina  Class providing all logic for managing the store in a generic way.

    The StoreBackend subclass has to implement 3 methods: create_location,
    clear_location and configure. The StoreBackend also has to provide
    a private _open_item, _item_exists and _move_item methods. The _open_item
    method has to have the same signature as the builtin open and return a
    file-like object.
    r   Nc              	   C   s4  t jj| jf| }|dkr|dk	r:dtt | nd}t j|d }|dk	rd|krddd	 |d  D }|d
|7 }d||}	|dk rt	d|	 nt	d|	| t
| dsdn| j}
t j|d}| |std| |
dkr"| |d}t|}W 5 Q R X ntj||
d}|S )z:Load an item from the store given its id as a list of str.r   Nz{: <16} r   Z
input_argsz, c                 s   s   | ]}d j | V  qdS )z{}={}N)r   .0itemr   r   r   	<genexpr>   s   z.StoreBackendMixin.load_item.<locals>.<genexpr>z({})z[Memory]{}: Loading {}
   z{0}...z{0} from {1}	mmap_mode
output.pklzANon-existing item (may have been cleared).
File %s does not existrb)r9   )r   pathjoinr$   r   r
   timebasenameitemsprinthasattrr9   r%   KeyErrorr"   r   load)r   call_idr-   	timestampmetadata	full_pathZ	ts_string	signaturekwargsmsgr9   r   r    r6   r   r   r   	load_item   s:    



zStoreBackendMixin.load_itemc              
      s   zht jj jf| } |s* | t j|d}|dkrLtd|   fdd} ||| W n6 tk
r } zt	
d| dt W 5 d}~X Y nX dS )	z;Dump an item in the store at the id given as a list of str.r:   r8   zPersisting in %sc                    sj     |dT}ztj| | jd W n6 tk
rZ } ztd| dt W 5 d }~X Y nX W 5 Q R X d S )Nwb)compresszjUnable to cache to disk: failed to pickle output. In version 1.5 this will raise an exception. Exception: .)r"   r   dumprN   r   warningswarnFutureWarning)to_writedest_filenamer    er+   r   r   r      s    
z/StoreBackendMixin.dump_item.<locals>.write_funcz`Unable to cache to disk. Possibly a race condition in the creation of the directory. Exception: rO   N)r   r<   r=   r$   r%   r)   rA   _concurrency_safe_write	ExceptionrQ   rR   r   )r   rE   r6   r-   	item_pathr   r   rV   r   r+   r   	dump_item   s    


zStoreBackendMixin.dump_itemc                 C   s,   t jj| jf| }| |r(| | dS )z1Clear the item at the id, given as a list of str.Nr   r<   r=   r$   r%   r*   )r   rE   rY   r   r   r   
clear_item   s    
zStoreBackendMixin.clear_itemc                 C   s,   t jj| jf| }t j|d}| |S )z<Check if there is an item at the id, given as a list of str.r:   )r   r<   r=   r$   r%   )r   rE   rY   r   r   r   r   contains_item   s    zStoreBackendMixin.contains_itemc                 C   s   dt jj| jf| iS )zReturn information about item.r$   r   r<   r=   r$   r   rE   r   r   r   get_item_info   s    zStoreBackendMixin.get_item_infoc              
   C   sr   z\t jj| jf| }t j|d}| |d$}t| dW  5 Q R  W S Q R X W n   i  Y S X dS )z"Return actual metadata of an item.metadata.jsonr;   utf-8N)	r   r<   r=   r$   r"   jsonloadsreaddecode)r   rE   rY   r   r    r   r   r   get_metadata   s    ,zStoreBackendMixin.get_metadatac                    s\   zJt jj jf| } | t j|d} fdd} ||| W n   Y nX dS )z Store metadata of a computation.ra   c              	      s2     |d}|t| d W 5 Q R X d S )NrM   rb   )r"   writerc   dumpsencode)rT   rU   r    r+   r   r   r      s    z4StoreBackendMixin.store_metadata.<locals>.write_funcN)r   r<   r=   r$   r)   rW   )r   rE   rG   rY   r   r   r   r+   r   store_metadata   s    
z StoreBackendMixin.store_metadatac                 C   s   t jj| jf| }| |S )z,Check cached function is available in store.)r   r<   r=   r$   Zobject_existsr   rE   	func_pathr   r   r   contains_path  s    zStoreBackendMixin.contains_pathc                 C   s,   t jj| jf| }| |r(| | dS )z0Clear all items with a common path in the store.Nr[   rl   r   r   r   
clear_path  s    
zStoreBackendMixin.clear_pathc              	   C   sj   t jj| jf| }| |s(| | |dk	rft j|d}| |d}||d W 5 Q R X dS )&Store the code of the cached function.Nfunc_code.pyrM   rb   )	r   r<   r=   r$   r%   r)   r"   rh   rj   )r   rE   	func_coderm   r   r    r   r   r   store_cached_func_code  s    

z(StoreBackendMixin.store_cached_func_codec              
   C   s^   t jj| jf|d }z4| |d}| dW  5 Q R  W S Q R X W n    Y nX dS )rp   rq   r;   rb   N)rq   )r   r<   r=   r$   r"   re   rf   )r   rE   r   r    r   r   r   get_cached_func_code  s    &z&StoreBackendMixin.get_cached_func_codec                 C   s   dt jj| jf| iS )z?Return information related to the cached function if it exists.r$   r^   r_   r   r   r   get_cached_func_info&  s    z&StoreBackendMixin.get_cached_func_infoc                 C   s   |  | j dS )zClear the whole store content.N)r*   r$   r+   r   r   r   clear*  s    zStoreBackendMixin.clearc              	   C   sZ   |  |||}|D ]B}| jdkr.td| z| |j W q tk
rR   Y qX qdS )zX
        Remove the store's oldest files to enforce item, byte, and age limits.
        r8   zDeleting item {0}N)_get_items_to_deleter-   rA   r   r*   r<   OSError)r   bytes_limititems_limit	age_limititems_to_deleter6   r   r   r   enforce_store_limits.  s      
z&StoreBackendMixin.enforce_store_limitsc                 C   s.  t |trt|}|  }|s"g S tdd |D }|dk	rF|| }nd}|dk	r`t|| }nd}|dk	rtdd |D }tj | }	nd}	|dkr|dkr|	dks||	krg S |j	t
dd g }
d}d}|D ]P}||kr||kr|	dks|	|jk r q*|
| ||j7 }|d7 }q|
S )	zW
        Get items to delete to keep the store under size, file, & age limits.
        c                 s   s   | ]}|j V  qd S N)sizer4   r   r   r   r7   Q  s     z9StoreBackendMixin._get_items_to_delete.<locals>.<genexpr>Nr   c                 s   s   | ]}|j V  qd S r~   )last_accessr4   r   r   r   r7   ^  s     r   )keyr   )
isinstancestrr   r,   sumlenmindatetimenowsortoperator
attrgetterr   appendr   )r   ry   rz   r{   r@   r   Zto_delete_sizeZto_delete_itemsZ
older_itemdeadliner|   Zsize_so_farZitems_so_farr6   r   r   r   rw   D  sV    




z&StoreBackendMixin._get_items_to_deletec                 C   s   t |||}| || dS )z7Writes an object into a file in a concurrency-safe way.N)r   r(   )r   rT   r   r   r   r   r   r   rW     s
     z)StoreBackendMixin._concurrency_safe_writec                 C   s   dj | jj| jdS )z/Printable representation of the store location.z#{class_name}(location="{location}"))
class_namer$   )r   	__class__r   r$   r+   r   r   r   __repr__  s     zStoreBackendMixin.__repr__)r   NN)r   )N)NN)NN)r   r   r   r   rL   rZ   r\   r]   r`   rg   rk   rn   ro   rs   rt   ru   rv   r}   rw   rW   r   r   r   r   r   r2      s,   	
"


	   
   
;r2   c                   @   sN   e Zd ZdZeeZeejj	Z
eeZdd Zdd Zdd Zdd
dZd	S )FileSystemStoreBackendz7A StoreBackend used with local or network file systems.c                 C   s&   || j krt| ntj|dd dS )zDelete location on store.T)ignore_errorsN)r$   r	   shutilrmtreer#   r   r   r   r*     s    

z%FileSystemStoreBackend.clear_locationc                 C   s   t | dS )zCreate object location on storeN)r   r#   r   r   r   r)     s    z&FileSystemStoreBackend.create_locationc           	         s   g }t | jD ]\ }}tdt j }|rt j d}zt j|}W n@ t	k
r   zt j }W n t	k
r   Y Y qY nX Y nX t
j
|}z( fdd|D }tdd |D }W n t	k
r   Y qY nX |t || q|S )z7Returns the whole list of items available in the store.z[a-f0-9]{32}r:   c                    s   g | ]}t j |qS r   )r   r<   r=   r5   fndirpathr   r   
<listcomp>  s   z4FileSystemStoreBackend.get_items.<locals>.<listcomp>c                 s   s   | ]}t j|V  qd S r~   )r   r<   getsizer   r   r   r   r7     s   z3FileSystemStoreBackend.get_items.<locals>.<genexpr>)r   walkr$   rematchr<   r?   r=   getatimerx   r   fromtimestampr   r   r   )	r   r@   _	filenamesZis_cache_hash_dirZoutput_filenamer   Zfull_filenamesdirsizer   r   r   r,     s8    



z FileSystemStoreBackend.get_itemsr   Nc                 C   sn   |dkri }|| _ tj| j s*t| j  |dd| _|d}| jr^|dk	r^tjddd || _	|| _
dS )zsConfigure the store backend.

        For this backend, valid store options are 'compress' and 'mmap_mode'
        NrN   Fr9   zSCompressed items cannot be memmapped in a filesystem store. Option will be ignored.   )
stacklevel)r$   r   r<   existsr   getrN   rQ   rR   r9   r-   )r   r$   r-   r.   r9   r   r   r   r/     s    

z FileSystemStoreBackend.configure)r   N)r   r   r   r   staticmethodopenr"   r   r<   r   r%   r   r(   r*   r)   r,   r/   r   r   r   r   r     s   $r   )$r   pickler   r   r   os.pathr   rc   r   r>   rQ   collectionsr   r   abcr   r   Z	backportsr   Zdiskr   r   r	   loggerr
   r3   r   
namedtupler   Warningr   r   r   objectr2   r   r   r   r   r   <module>   s4   
i z