OwlCyberSecurity - MANAGER
Edit File: _datasource.cpython-38.pyc
U �p�]�c � @ s� d Z ddlmZmZmZ ddlZddlZddlZddlZddl Z ddl m Z ddl m Z eZdd� Zdd � Zd d � ZG d d � d e�Ze� Zdejddfdd�Ze d�G dd� de��ZG dd� de�ZdS )a" A file interface for handling local and remote data files. The goal of datasource is to abstract some of the file system operations when dealing with data files so the researcher doesn't have to know all the low-level details. Through datasource, a researcher can obtain and use a file with one function call, regardless of location of the file. DataSource is meant to augment standard python libraries, not replace them. It should work seamlessly with standard file IO operations and the os module. DataSource files can originate locally or remotely: - local files : '/home/guido/src/local/data.txt' - URLs (http, ftp, ...) : 'http://www.scipy.org/not/real/data.txt' DataSource files can also be compressed or uncompressed. Currently only gzip, bz2 and xz are supported. Example:: >>> # Create a DataSource, use os.curdir (default) for local storage. >>> from numpy import DataSource >>> ds = DataSource() >>> >>> # Open a remote file. >>> # DataSource downloads the file, stores it locally in: >>> # './www.google.com/index.html' >>> # opens the file and returns a file object. >>> fp = ds.open('http://www.google.com/') # doctest: +SKIP >>> >>> # Use the file as you normally would >>> fp.read() # doctest: +SKIP >>> fp.close() # doctest: +SKIP � )�division�absolute_import�print_functionN)�closing)� set_modulec C sD d| kr d| kr@t d| f ��n |dk r0t d��|dk r@t d��dS )z�Check mode and that encoding and newline are compatible. Parameters ---------- mode : str File open mode. encoding : str File encoding. newline : str Newline for text files. �t�bzInvalid mode: %rNz0Argument 'encoding' not supported in binary modez/Argument 'newline' not supported in binary mode)� ValueError��mode�encoding�newline� r �7/usr/lib/python3/dist-packages/numpy/lib/_datasource.py� _check_mode4 s r c C sD ddl }t|||� d|kr8tjdtdd� |�dd�}|�| |�S )aR Wrapper to open bz2 in text mode. Parameters ---------- fn : str File name mode : {'r', 'w'} File mode. Note that bz2 Text files are not supported. encoding : str Ignored, text bz2 files not supported in Python2. newline : str Ignored, text bz2 files not supported in Python2. r Nr z5Assuming latin1 encoding for bz2 text file in Python2� )� stacklevel� )�bz2r �warnings�warn�RuntimeWarning�replaceZBZ2File)�fnr r r r r r r �_python2_bz2openK s � r c C s� ddl }G dd� d|j�}t|||� |�dd�}t| ttf�rL|| |�}n,t| d�s`t| d�rp|d|| d �}ntd ��d|kr�t j |||d �S |S dS ) a� Wrapper to open gzip in text mode. Parameters ---------- fn : str, bytes, file File path or opened file. mode : str File mode. The actual files are opened as binary, but will decoded using the specified `encoding` and `newline`. encoding : str Encoding to be used when reading/writing as text. newline : str Newline to be used when reading/writing as text. r Nc @ s e Zd Zdd� ZdS )z#_python2_gzipopen.<locals>.GzipWrapc S s | � |�S �N)�read)�self�nr r r �read1w s z)_python2_gzipopen.<locals>.GzipWrap.read1N)�__name__� __module__� __qualname__r r r r r �GzipWrapv s r# r r r �write)Zfileobjz1filename must be a str or bytes object, or a file)r ) �gzipZGzipFiler r � isinstance�str�bytes�hasattr� TypeError�io� TextIOWrapper)r r r r r% r# Zgz_modeZ binary_filer r r �_python2_gzipopend s r- c @ s0 e Zd ZdZdd� Zdd� Zdd� Zdd � Zd S ) � _FileOpenersa Container for different methods to open (un-)compressed files. `_FileOpeners` contains a dictionary that holds one method for each supported file format. Attribute lookup is implemented in such a way that an instance of `_FileOpeners` itself can be indexed with the keys of that dictionary. Currently uncompressed files as well as files compressed with ``gzip``, ``bz2`` or ``xz`` compression are supported. Notes ----- `_file_openers`, an instance of `_FileOpeners`, is made available for use in the `_datasource` module. Examples -------- >>> import gzip >>> np.lib._datasource._file_openers.keys() [None, '.bz2', '.gz', '.xz', '.lzma'] >>> np.lib._datasource._file_openers['.gz'] is gzip.open True c C s d| _ d tji| _d S )NF)�_loadedr+ �open� _file_openers�r r r r �__init__� s z_FileOpeners.__init__c C s� | j r d S z2dd l}tjd dkr0|j| jd< n t| jd< W n tk rP Y nX z2dd l}tjd dkrx|j| jd< n t | jd< W n tk r� Y nX z$dd l }|j| jd< |j| jd< W n tt fk r� Y nX d| _ d S )Nr � z.bz2z.gzz.xzz.lzmaT) r/ r �sys� version_infor0 r1 r � ImportErrorr% r- �lzma�AttributeError)r r r% r8 r r r �_load� s. z_FileOpeners._loadc C s | � � t| j�� �S )a[ Return the keys of currently supported file openers. Parameters ---------- None Returns ------- keys : list The keys are None for uncompressed files and the file extension strings (i.e. ``'.gz'``, ``'.xz'``) for supported compression methods. )r: �listr1 �keysr2 r r r r< � s z_FileOpeners.keysc C s | � � | j| S r )r: r1 )r �keyr r r � __getitem__� s z_FileOpeners.__getitem__N)r r! r" �__doc__r3 r: r< r> r r r r r. � s !r. �rc C s t |�}|j| |||d�S )a� Open `path` with `mode` and return the file object. If ``path`` is an URL, it will be downloaded, stored in the `DataSource` `destpath` directory and opened from there. Parameters ---------- path : str Local file path or URL to open. mode : str, optional Mode to open `path`. Mode 'r' for reading, 'w' for writing, 'a' to append. Available modes depend on the type of object specified by path. Default is 'r'. destpath : str, optional Path to the directory where the source file gets downloaded to for use. If `destpath` is None, a temporary directory will be created. The default path is the current directory. encoding : {None, str}, optional Open text file with given encoding. The default encoding will be what `io.open` uses. newline : {None, str}, optional Newline to use when reading text file. Returns ------- out : file object The opened file. Notes ----- This is a convenience function that instantiates a `DataSource` and returns the file object from ``DataSource.open(path)``. �r r )� DataSourcer0 )�pathr �destpathr r Zdsr r r r0 � s %r0 Znumpyc @ s� e Zd ZdZejfdd�Zdd� Zdd� Zdd � Z d d � Z d d � Z dd� Z dd� Z dd� Zdd� Zdd� Zdd� Zd d d �ZdS ) rB a� DataSource(destpath='.') A generic data source file (file, http, ftp, ...). DataSources can be local files or remote files/URLs. The files may also be compressed or uncompressed. DataSource hides some of the low-level details of downloading the file, allowing you to simply pass in a valid file path (or URL) and obtain a file object. Parameters ---------- destpath : str or None, optional Path to the directory where the source file gets downloaded to for use. If `destpath` is None, a temporary directory will be created. The default path is the current directory. Notes ----- URLs require a scheme string (``http://``) to be used, without it they will fail:: >>> repos = np.DataSource() >>> repos.exists('www.google.com/index.html') False >>> repos.exists('http://www.google.com/index.html') True Temporary directories are deleted when the DataSource is deleted. Examples -------- :: >>> ds = np.DataSource('/home/guido') >>> urlname = 'http://www.google.com/' >>> gfile = ds.open('http://www.google.com/') >>> ds.abspath(urlname) '/home/guido/www.google.com/index.html' >>> ds = np.DataSource(None) # use with temporary file >>> ds.open('/home/guido/foobar.txt') <open file '/home/guido.foobar.txt', mode 'r' at 0x91d4430> >>> ds.abspath('/home/guido/foobar.txt') '/tmp/.../home/guido/foobar.txt' c C s6 |rt j�|�| _d| _nddl}|�� | _d| _dS )z2Create a DataSource with a local path at destpath.Fr NT)�osrC �abspath� _destpath� _istmpdest�tempfileZmkdtemp)r rD rI r r r r3 B s zDataSource.__init__c C s t | d�r | jr t�| j� d S )NrH )r) rH �shutilZrmtreerG r2 r r r �__del__L s zDataSource.__del__c C s t j�|�\}}|t�� kS )zNTest if the filename is a zip file by looking at the file extension. )rE rC �splitextr1 r< )r �filename�fname�extr r r �_iszipQ s zDataSource._iszipc C s d}|D ]}||kr dS qdS )z4Test if the given mode will open a file for writing.)�w�+TFr )r r Z _writemodes�cr r r � _iswritemodeX s zDataSource._iswritemodec C s" | � |�rtj�|�S |dfS dS )zxSplit zip extension from filename and return filename. *Returns*: base, zip_ext : {tuple} N)rP rE rC rL )r rM r r r � _splitzipextb s zDataSource._splitzipextc C s4 |g}| � |�s0t�� D ]}|r|�|| � q|S )z9Return a tuple containing compressed filename variations.)rP r1 r< �append)r rM �namesZzipextr r r �_possible_nameso s zDataSource._possible_namesc C sH t jd dkr ddlm} n ddlm} ||�\}}}}}}t|oD|�S )z=Test if path is a net location. Tests the scheme and netloc.r r4 ��urlparse)r5 r6 � urllib.parserZ �bool) r rC rZ �scheme�netloc�upath�uparams�uquery�ufragr r r �_isurlx s zDataSource._isurlc C s� t jd dkr(ddlm} ddlm} nddlm} ddlm} | �|�}tj � tj � |��spt� tj � |�� | � |�r�z>t||���(}t|d��}t�||� W 5 Q R X W 5 Q R X W q� |k r� |d| ��Y q�X n t�||� |S )zhCache the file specified by path. Creates a copy of the file in the datasource cache. r r4 ��urlopen��URLError�wbzURL not found: %s)r5 r6 �urllib.requestre � urllib.errorrg �urllib2rF rE rC �exists�dirname�makedirsrc r �_openrJ Z copyfileobjZcopyfile)r rC re rg r_ Z openedurl�fr r r �_cache� s" $ zDataSource._cachec C s| | � |�s*| �|�}|| �| �|��7 }n | �| �|��}|| �|� }|D ]*}| �|�rL| � |�rn| �|�}| S qLdS )ay Searches for ``path`` and returns full path if found. If path is an URL, _findfile will cache a local copy and return the path to the cached file. If path is a local file, _findfile will return a path to that local file. The search will include possible compressed versions of the file and return the first occurrence found. N)rc rX rF rl rq )r rC Zfilelist�namer r r � _findfile� s zDataSource._findfilec C s� t jd dkr ddlm} n ddlm} |�| jd�}t|�dkrJ|d }||�\}}}}}} | �|�}| �|�}tj � | j||�S )aF Return absolute path of file in the DataSource directory. If `path` is an URL, then `abspath` will return either the location the file exists locally or the location it would exist when opened using the `open` method. Parameters ---------- path : str Can be a local file or a remote URL. Returns ------- out : str Complete path, including the `DataSource` destination directory. Notes ----- The functionality is based on `os.path.abspath`. r r4 rY � � ) r5 r6 r[ rZ �splitrG �len�_sanitize_relative_pathrE rC �join) r rC rZ � splitpathr] r^ r_ r` ra rb r r r rF � s zDataSource.abspathc C sV d}t j�|�}||krR|}|�t j��d�}|�t j��d�}t j�|�\}}q|S )zvReturn a sanitised relative path for which os.path.abspath(os.path.join(base, path)).startswith(base) N�/z..)rE rC �normpath�lstrip�sep�pardir� splitdrive)r rC ZlastZdriver r r rx � s z"DataSource._sanitize_relative_pathc C s� t j�|�rdS tjd dkr8ddlm} ddlm} nddl m} ddl m} | � |�}t j�|�rjdS | � |�r�z||�}|� � ~W dS |k r� Y dS X dS )a3 Test if path exists. Test if `path` exists as (and in this order): - a local file. - a remote URL that has been downloaded and stored locally in the `DataSource` directory. - a remote URL that has not been downloaded, but is valid and accessible. Parameters ---------- path : str Can be a local file or a remote URL. Returns ------- out : bool True if `path` exists. Notes ----- When `path` is an URL, `exists` will return True if it's either stored locally in the `DataSource` directory, or is a valid remote URL. `DataSource` does not discriminate between the two, the file is accessible if it exists in either location. Tr r4 rd rf F) rE rC rl r5 r6 ri re rj rg rk rF rc �close)r rC re rg r_ Znetfiler r r rl s& zDataSource.existsr@ Nc C sp | � |�r | �|�r td��| �|�}|r`| �|�\}}|dkrL|�dd� t| ||||d�S td| ��dS )aD Open and return file-like object. If `path` is an URL, it will be downloaded, stored in the `DataSource` directory and opened from there. Parameters ---------- path : str Local file path or URL to open. mode : {'r', 'w', 'a'}, optional Mode to open `path`. Mode 'r' for reading, 'w' for writing, 'a' to append. Available modes depend on the type of object specified by `path`. Default is 'r'. encoding : {None, str}, optional Open text file with given encoding. The default encoding will be what `io.open` uses. newline : {None, str}, optional Newline to use when reading text file. Returns ------- out : file object File object. zURLs are not writeabler rR r r z %s not found.N)rc rT r rs rU r r1 �IOError)r rC r r r �foundZ_fnamerO r r r r0 A s " �zDataSource.open)r@ NN)r r! r" r? rE �curdirr3 rK rP rT rU rX rc rq rs rF rx rl r0 r r r r rB s 0 ! -<rB c @ sX e Zd ZdZejfdd�Zdd� Zdd� Zdd � Z d d � Z d d � Z ddd�Z dd� Z dS )� Repositorya Repository(baseurl, destpath='.') A data repository where multiple DataSource's share a base URL/directory. `Repository` extends `DataSource` by prepending a base URL (or directory) to all the files it handles. Use `Repository` when you will be working with multiple files from one base URL. Initialize `Repository` with the base URL, then refer to each file by its filename only. Parameters ---------- baseurl : str Path to the local directory or remote location that contains the data files. destpath : str or None, optional Path to the directory where the source file gets downloaded to for use. If `destpath` is None, a temporary directory will be created. The default path is the current directory. Examples -------- To analyze all files in the repository, do something like this (note: this is not self-contained code):: >>> repos = np.lib._datasource.Repository('/home/user/data/dir/') >>> for filename in filelist: ... fp = repos.open(filename) ... fp.analyze() ... fp.close() Similarly you could use a URL for a repository:: >>> repos = np.lib._datasource.Repository('http://www.xyz.edu/data') c C s t j| |d� || _dS )z>Create a Repository with a shared url or directory of baseurl.)rD N)rB r3 �_baseurl)r ZbaseurlrD r r r r3 � s zRepository.__init__c C s t �| � d S r )rB rK r2 r r r rK � s zRepository.__del__c C s4 |� | jd�}t|�dkr,tj�| j|�}n|}|S )z>Return complete path for path. Prepends baseurl if necessary.rt ru )rv r� rw rE rC ry )r rC rz �resultr r r � _fullpath� s zRepository._fullpathc C s t �| | �|��S )z8Extend DataSource method to prepend baseurl to ``path``.)rB rs r� �r rC r r r rs � s zRepository._findfilec C s t �| | �|��S )ak Return absolute path of file in the Repository directory. If `path` is an URL, then `abspath` will return either the location the file exists locally or the location it would exist when opened using the `open` method. Parameters ---------- path : str Can be a local file or a remote URL. This may, but does not have to, include the `baseurl` with which the `Repository` was initialized. Returns ------- out : str Complete path, including the `DataSource` destination directory. )rB rF r� r� r r r rF � s zRepository.abspathc C s t �| | �|��S )a� Test if path exists prepending Repository base URL to path. Test if `path` exists as (and in this order): - a local file. - a remote URL that has been downloaded and stored locally in the `DataSource` directory. - a remote URL that has not been downloaded, but is valid and accessible. Parameters ---------- path : str Can be a local file or a remote URL. This may, but does not have to, include the `baseurl` with which the `Repository` was initialized. Returns ------- out : bool True if `path` exists. Notes ----- When `path` is an URL, `exists` will return True if it's either stored locally in the `DataSource` directory, or is a valid remote URL. `DataSource` does not discriminate between the two, the file is accessible if it exists in either location. )rB rl r� r� r r r rl � s zRepository.existsr@ Nc C s t j| | �|�|||d�S )a� Open and return file-like object prepending Repository base URL. If `path` is an URL, it will be downloaded, stored in the DataSource directory and opened from there. Parameters ---------- path : str Local file path or URL to open. This may, but does not have to, include the `baseurl` with which the `Repository` was initialized. mode : {'r', 'w', 'a'}, optional Mode to open `path`. Mode 'r' for reading, 'w' for writing, 'a' to append. Available modes depend on the type of object specified by `path`. Default is 'r'. encoding : {None, str}, optional Open text file with given encoding. The default encoding will be what `io.open` uses. newline : {None, str}, optional Newline to use when reading text file. Returns ------- out : file object File object. rA )rB r0 r� )r rC r r r r r r r0 � s �zRepository.openc C s& | � | j�rtd��n t�| j�S dS )a List files in the source Repository. Returns ------- files : list of str List of file names (not containing a directory part). Notes ----- Does not currently work for remote repositories. z-Directory listing of URLs, not supported yet.N)rc r� �NotImplementedErrorrE �listdirr2 r r r r� s �zRepository.listdir)r@ NN)r r! r" r? rE r� r3 rK r� rs rF rl r0 r� r r r r r� r s ' " r� )r? Z __future__r r r rE r5 r rJ r+ � contextlibr Znumpy.core.overridesr r0 ro r r r- �objectr. r1 r� rB r� r r r r �<module> s( $ ,U) c