Source code for bob.db.base.file

#!/usr/bin/env python
# vim: set fileencoding=utf-8 :

import os

import bob.io.base


class File(object):
  """Abstract class that define basic properties of File objects.

  Your file instance should have at least the self.id and self.path
  properties.
  """

  def __init__(self, path, file_id=None, **kwargs):
    """**Constructor Documentation**

    Initialize the File object with the minimum required data.

    Parameters
    ----------
    path : str
        The path to this file, relative to the basic directory.
        If you use an SQL database, this should be the SQL type String.
        Please do not specify any file extensions.

    file_id : object
        The id of the file (various type). Its type depends on your
        implementation. If you use an SQL database, this should be an SQL type
        like Integer or String. If you are using an automatically determined
        file id, you don't need to specify this parameter.

    Raises
    ------
    NotImplementedError
        If self.id is not set and not specified during initialization through
        `file_id`.
    """

    self.path = path
    """A relative path, which includes file name but excludes file extension"""

    # set file id only, when specified
    if file_id:
      self.id = file_id
      """A unique identifier of the file."""
    else:
      # check that the file id at least exists
      if not hasattr(self, 'id'):
        raise NotImplementedError(
            "Please either specify the file id as parameter, or create an "
            "'id' member variable in the derived class that is automatically "
            "determined (e.g. by SQLite)")

    super(File, self).__init__(**kwargs)

  def __lt__(self, other):
    """This function defines the order on the File objects. File objects are
    always ordered by their ID, in ascending order."""
    return self.id < other.id

  def __repr__(self):
    """This function describes how to convert a File object into a string."""
    return "<File('%s': '%s')>" % (str(self.id), str(self.path))

[docs] def make_path(self, directory=None, extension=None): """Wraps the current path so that a complete path is formed Parameters ---------- directory : :obj:`str`, optional An optional directory name that will be prefixed to the returned result. extension : :obj:`str`, optional An optional extension that will be suffixed to the returned filename. The extension normally includes the leading ``.`` character as in ``.jpg`` or ``.hdf5``. Returns ------- str Returns a string containing the newly generated file path. """ # assure that directory and extension are actually strings # create the path return str(os.path.join(directory or '', self.path + (extension or '')))
[docs] def save(self, data, directory=None, extension='.hdf5', create_directories=True): """Saves the input data at the specified location and using the given extension. Override it if you need to save differently. Parameters ---------- data : object The data blob to be saved (normally a :py:class:`numpy.ndarray`). directory : :obj:`str`, optional If not empty or None, this directory is prefixed to the final file destination extension : :obj:`str`, optional The extension of the filename - this will control the type of output and the codec for saving the input blob. create_directories : :obj:`bool`, optional Whether to create the required directories to save the data. """ # get the path path = self.make_path(directory or '', extension or '') # use the bob API to save the data bob.io.base.save(data, path, create_directories=create_directories)
[docs] def load(self, directory=None, extension='.hdf5'): """Loads the data at the specified location and using the given extension. Override it if you need to load differently. Parameters ---------- directory : :obj:`str`, optional If not empty or None, this directory is prefixed to the final file destination extension : :obj:`str`, optional If not empty or None, this extension is suffixed to the final file destination Returns ------- object The loaded data (normally :py:class:`numpy.ndarray`). """ # get the path path = self.make_path(directory or '', extension or '') return bob.io.base.load(path)