Harmonized sphinx references

bob/bio/base/database/filelist/query.py

@@ -393,7 +393,7 @@ class FileListBioDatabase(ZTBioDatabase):
             "The given T-norm model id '%s' cannot be found in one of the groups '%s'" % (t_model_id, groups))
 
     def clients(self, protocol=None, groups=None):
-        """Returns a list of :py:class:`Client` objects for the specific query by the user.
+        """Returns a list of :py:class:`bob.bio.base.database.Client` objects for the specific query by the user.
 
         Keyword Parameters:
 
@@ -403,7 +403,7 @@ class FileListBioDatabase(ZTBioDatabase):
         groups : str or [str] or ``None``
           The groups to which the clients belong ("dev", "eval", "world", "optional_world_1", "optional_world_2").
 
-        Returns: A list containing all the :py:class:`Client` objects which have the given properties.
+        Returns: A list containing all the :py:class:`bob.bio.base.database.Client` objects which have the given properties.
         """
 
         protocol = protocol or self.protocol
@@ -411,7 +411,7 @@ class FileListBioDatabase(ZTBioDatabase):
         return [Client(id) for id in client_ids]
 
     def tclients(self, protocol=None, groups=None):
-        """Returns a list of T-Norm :py:class:`Client` objects for the specific query by the user.
+        """Returns a list of T-Norm :py:class:`bob.bio.base.database.Client` objects for the specific query by the user.
 
         Keyword Parameters:
 
@@ -421,7 +421,7 @@ class FileListBioDatabase(ZTBioDatabase):
         groups : str or [str] or ``None``
           The groups to which the clients belong ("dev", "eval").
 
-        Returns: A list containing all the T-Norm :py:class:`Client` objects which have the given properties.
+        Returns: A list containing all the T-Norm :py:class:`bob.bio.base.database.Client` objects which have the given properties.
         """
         protocol = protocol or self.protocol
         tclient_ids = self.tclient_ids(protocol, groups)
@@ -559,7 +559,7 @@ class FileListBioDatabase(ZTBioDatabase):
         return self.__model_id_list__(groups, 'for_tnorm', protocol)
 
     def objects(self, groups=None, protocol=None, purposes=None, model_ids=None, classes=None, **kwargs):
-        """Returns a set of :py:class:`BioFile` objects for the specific query by the user.
+        """Returns a set of :py:class:`bob.bio.base.database.BioFile` objects for the specific query by the user.
 
         Keyword Parameters:
 
@@ -587,7 +587,7 @@ class FileListBioDatabase(ZTBioDatabase):
           default), it is considered the same as a tuple with all possible values.
           Note: classes are not allowed to be specified when the 'probes_filename' is used.
 
-        Returns: A list of :py:class:`BioFile` objects considering all the filtering criteria.
+        Returns: A list of :py:class:`bob.bio.base.database.BioFile` objects considering all the filtering criteria.
         """
 
         protocol = protocol or self.protocol
@@ -669,7 +669,7 @@ class FileListBioDatabase(ZTBioDatabase):
         return self._make_bio(retval)
 
     def tobjects(self, groups=None, protocol=None, model_ids=None, **kwargs):
-        """Returns a list of :py:class:`BioFile` objects for enrolling T-norm models for score normalization.
+        """Returns a list of :py:class:`bob.bio.base.database.BioFile` objects for enrolling T-norm models for score normalization.
 
         Keyword Parameters:
 
@@ -684,7 +684,7 @@ class FileListBioDatabase(ZTBioDatabase):
         groups : str or [str] or ``None``
           The groups to which the models belong ("dev", "eval").
 
-        Returns: A list of :py:class:`BioFile` objects considering all the filtering criteria.
+        Returns: A list of :py:class:`bob.bio.base.database.BioFile` objects considering all the filtering criteria.
         """
         protocol = protocol or self.protocol
         groups = self.check_parameters_for_validity(groups, "group", self.groups(protocol, add_world=False))
@@ -704,7 +704,7 @@ class FileListBioDatabase(ZTBioDatabase):
         return self._make_bio(retval)
 
     def zobjects(self, groups=None, protocol=None, **kwargs):
-        """Returns a list of :py:class:`BioFile` objects to perform Z-norm score normalization.
+        """Returns a list of :py:class:`bob.bio.base.database.BioFile` objects to perform Z-norm score normalization.
 
         Keyword Parameters:
 
@@ -737,8 +737,8 @@ class FileListBioDatabase(ZTBioDatabase):
 
         Keyword parameters:
 
-        file : :py:class:`bob.bio.base.database.BioFile`
-          The :py:class:`BioFile` object for which the annotations should be read.
+        file :py:class:`bob.bio.base.database.BioFile`
+          The BioFile object for which the annotations should be read.
 
         Return value
           The annotations as a dictionary: {'reye':(re_y,re_x), 'leye':(le_y,le_x)}
@@ -764,7 +764,7 @@ class FileListBioDatabase(ZTBioDatabase):
 
         **Keyword parameters**
 
-        file : :py:class:`bob.bio.base.database.BioFile`
+        file :py:class:`bob.bio.base.database.BioFile`
           The BioFile object for which the file name should be returned.
 
         check_existence : bool

bootstrap-buildout.py

@@ -25,10 +25,7 @@ import tempfile
 
 from optparse import OptionParser
 
-__version__ = '2015-07-01'
-# See zc.buildout's changelog if this version is up to date.
-
-tmpeggs = tempfile.mkdtemp(prefix='bootstrap-')
+tmpeggs = tempfile.mkdtemp()
 
 usage = '''\
 [DESIRED PYTHON FOR BUILDOUT] bootstrap.py [options]
@@ -43,9 +40,8 @@ this script from going over the network.
 '''
 
 parser = OptionParser(usage=usage)
-parser.add_option("--version",
-                  action="store_true", default=False,
-                  help=("Return bootstrap.py version."))
+parser.add_option("-v", "--version", help="use a specific zc.buildout version")
+
 parser.add_option("-t", "--accept-buildout-test-releases",
                   dest='accept_buildout_test_releases',
                   action="store_true", default=False,
@@ -63,32 +59,24 @@ parser.add_option("-f", "--find-links",
 parser.add_option("--allow-site-packages",
                   action="store_true", default=False,
                   help=("Let bootstrap.py use existing site packages"))
-parser.add_option("--buildout-version",
-                  help="Use a specific zc.buildout version")
 parser.add_option("--setuptools-version",
-                  help="Use a specific setuptools version")
-parser.add_option("--setuptools-to-dir",
-                  help=("Allow for re-use of existing directory of "
-                        "setuptools versions"))
+                  help="use a specific setuptools version")
 
-options, args = parser.parse_args()
-if options.version:
-    print("bootstrap.py version %s" % __version__)
-    sys.exit(0)
 
+options, args = parser.parse_args()
 
 ######################################################################
 # load/install setuptools
 
 try:
+    if options.allow_site_packages:
+        import setuptools
+        import pkg_resources
     from urllib.request import urlopen
 except ImportError:
     from urllib2 import urlopen
 
 ez = {}
-if os.path.exists('ez_setup.py'):
-    exec(open('ez_setup.py').read(), ez)
-else:
 exec(urlopen('https://bootstrap.pypa.io/ez_setup.py').read(), ez)
 
 if not options.allow_site_packages:
@@ -100,19 +88,12 @@ if not options.allow_site_packages:
     # We can't remove these reliably
     if hasattr(site, 'getsitepackages'):
         for sitepackage_path in site.getsitepackages():
-            # Strip all site-packages directories from sys.path that
-            # are not sys.prefix; this is because on Windows
-            # sys.prefix is a site-package directory.
-            if sitepackage_path != sys.prefix:
-                sys.path[:] = [x for x in sys.path
-                               if sitepackage_path not in x]
+            sys.path[:] = [x for x in sys.path if sitepackage_path not in x]
 
 setup_args = dict(to_dir=tmpeggs, download_delay=0)
 
 if options.setuptools_version is not None:
     setup_args['version'] = options.setuptools_version
-if options.setuptools_to_dir is not None:
-    setup_args['to_dir'] = options.setuptools_to_dir
 
 ez['use_setuptools'](**setup_args)
 import setuptools
@@ -129,12 +110,7 @@ for path in sys.path:
 
 ws = pkg_resources.working_set
 
-setuptools_path = ws.find(
-    pkg_resources.Requirement.parse('setuptools')).location
-
-# Fix sys.path here as easy_install.pth added before PYTHONPATH
 cmd = [sys.executable, '-c',
-       'import sys; sys.path[0:0] = [%r]; ' % setuptools_path +
        'from setuptools.command.easy_install import main; main()',
        '-mZqNxd', tmpeggs]
 
@@ -147,8 +123,11 @@ find_links = os.environ.get(
 if find_links:
     cmd.extend(['-f', find_links])
 
+setuptools_path = ws.find(
+    pkg_resources.Requirement.parse('setuptools')).location
+
 requirement = 'zc.buildout'
-version = options.buildout_version
+version = options.version
 if version is None and not options.accept_buildout_test_releases:
     # Figure out the most recent final version of zc.buildout.
     import setuptools.package_index
@@ -188,7 +167,7 @@ if version:
 cmd.append(requirement)
 
 import subprocess
-if subprocess.call(cmd) != 0:
+if subprocess.call(cmd, env=dict(os.environ, PYTHONPATH=setuptools_path)) != 0:
     raise Exception(
         "Failed to execute command:\n%s" % repr(cmd)[1:-1])