numpy.lib._datasource
index
/usr/lib/python2.6/dist-packages/numpy/lib/_datasource.py

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 seemlessly 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
and bz2 are supported.
 
Example:
 
    >>> # Create a DataSource, use os.curdir (default) for local storage.
    >>> ds = datasource.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/index.html')
    >>>
    >>> # Use the file as you normally would
    >>> fp.read()
    >>> fp.close()

 
Modules
       
os

 
Classes
       
object
_FileOpeners
DataSource(object)
Repository

 
class Repository(DataSource)
    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 a Repository when you will be working with
multiple files from one base URL.  Initialize the Respository with the
base URL, then refer to each file by its filename only.
 
*Methods*:
 
    - exists : test if the file exists locally or remotely
    - abspath : get absolute path of the file in the DataSource directory
    - open : open the file
 
*Toy example*::
 
    # Analyze all files in the repository.
    repos = 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 = Repository('http://www.xyz.edu/data')
 
 
Method resolution order:
Repository
DataSource
object

Methods defined here:
__del__(self)
__init__(self, baseurl, destpath='.')
Create a Repository with a shared url or directory of baseurl.
abspath(self, path)
Return absolute path of file in the Repository directory.
 
If `path` is an URL, the ``abspath`` will be either the location
the file exists locally or the location it would exist when opened
using the ``open`` method.
 
The functionality is idential to os.path.abspath.
 
Parameters
----------
path : string
    Can be a local file or a remote URL.
 
Returns
-------
out : string
    Complete path, rooted in the DataSource destination directory.
 
See Also
--------
open
exists(self, path)
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 have been downloaded and stored locally in the
  DataSource directory.
- a remote URL that has not been downloaded, but is valid and
  accessible.
 
Parameters
----------
path : string
    Can be a local file or a remote URL.
 
Returns
-------
out : bool
    True if `path` exists.
 
See Also
--------
abspath
 
Notes
-----
When `path` is an URL, ``exist`` will return True if it's either stored
locally in the DataSource directory, or is a valid remote URL.  DataSource
does not discriminate between to two, the file is accessible if it exists
in either location.
listdir(self)
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.
open(self, path, mode='r')
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 : string
    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`.
 
Returns
-------
out : file object
    File object.

Data descriptors inherited from DataSource:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

 
class _FileOpeners(object)
    # TODO: .zip support, .tar support?
 
  Methods defined here:
__getitem__(self, key)
__init__(self)
keys(self)

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

 
Functions
       
open(path, mode='r', destpath='.')
Open ``path`` with ``mode`` and return the file object.
 
If ``path`` is an URL, it will be downloaded, stored in the DataSource
directory and opened from there.
 
*Parameters*:
 
    path : {string}
 
    mode : {string}, optional
 
    destpath : {string}, optional
        Destination directory where URLs will be downloaded and stored.
 
*Returns*:
 
    file object

 
Data
        __docformat__ = 'restructuredtext en'
__file__ = '/usr/lib/python2.6/dist-packages/numpy/lib/_datasource.pyc'
__name__ = 'numpy.lib._datasource'
__package__ = 'numpy.lib'
_file_openers = <numpy.lib._datasource._FileOpeners object at 0x23e3850>