Merge branch 'doc_py27' into 'master'

Fix docs on py27 following changes to the list class

See merge request !30

bob/measure/__init__.py

@@ -171,9 +171,9 @@ def recognition_rate(cmc_scores, threshold = None, rank = 1):
 
   Parameters:
 
-    cmc_scores (list): A list in the format ``[(negatives, positives), ...]``
-      containing the CMC scores loaded with one of the functions
-      (:py:func:`bob.measure.load.cmc_four_column` or
+    cmc_scores (:py:class:`list`): A list in the format ``[(negatives,
+      positives), ...]`` containing the CMC scores loaded with one of the
+      functions (:py:func:`bob.measure.load.cmc_four_column` or
       :py:func:`bob.measure.load.cmc_five_column`).
 
       Each pair contains the ``negative`` and the ``positive`` scores for **one
@@ -278,9 +278,9 @@ def cmc(cmc_scores):
 
   Parameters:
 
-    cmc_scores (list): A list in the format ``[(negatives, positives), ...]``
-      containing the CMC scores loaded with one of the functions
-      (:py:func:`bob.measure.load.cmc_four_column` or
+    cmc_scores (:py:class:`list`): A list in the format ``[(negatives,
+      positives), ...]`` containing the CMC scores loaded with one of the
+      functions (:py:func:`bob.measure.load.cmc_four_column` or
       :py:func:`bob.measure.load.cmc_five_column`).
 
       Each pair contains the ``negative`` and the ``positive`` scores for **one
@@ -339,9 +339,9 @@ def detection_identification_rate(cmc_scores, threshold, rank = 1):
 
   Parameters:
 
-    cmc_scores (list): A list in the format ``[(negatives, positives), ...]``
-      containing the CMC scores loaded with one of the functions
-      (:py:func:`bob.measure.load.cmc_four_column` or
+    cmc_scores (:py:class:`list`): A list in the format ``[(negatives,
+      positives), ...]`` containing the CMC scores loaded with one of the
+      functions (:py:func:`bob.measure.load.cmc_four_column` or
       :py:func:`bob.measure.load.cmc_five_column`).
 
       Each pair contains the ``negative`` and the ``positive`` scores for **one
@@ -400,9 +400,9 @@ def false_alarm_rate(cmc_scores, threshold):
 
   Parameters:
 
-    cmc_scores (list): A list in the format ``[(negatives, positives), ...]``
-      containing the CMC scores loaded with one of the functions
-      (:py:func:`bob.measure.load.cmc_four_column` or
+    cmc_scores (:py:class:`list`): A list in the format ``[(negatives,
+      positives), ...]`` containing the CMC scores loaded with one of the
+      functions (:py:func:`bob.measure.load.cmc_four_column` or
       :py:func:`bob.measure.load.cmc_five_column`).
 
       Each pair contains the ``negative`` and the ``positive`` scores for **one

bob/measure/load.py

@@ -152,10 +152,10 @@ def cmc_four_column(filename):
 
   Returns:
 
-    list: A list of tuples, where each tuple contains the ``negative`` and
-    ``positive`` scores for one probe of the database. Both ``negatives`` and
-    ``positives`` can be either an 1D :py:class:`numpy.ndarray` of type
-    ``float``, or ``None``.
+    :py:class:`list`: A list of tuples, where each tuple contains the
+    ``negative`` and ``positive`` scores for one probe of the database. Both
+    ``negatives`` and ``positives`` can be either an 1D
+    :py:class:`numpy.ndarray` of type ``float``, or ``None``.
 
   """
 
@@ -256,8 +256,8 @@ def cmc_five_column(filename):
 
   Returns:
 
-    list: A list of tuples, where each tuple contains the ``negative`` and
-    ``positive`` scores for one probe of the database.
+    :py:class:`list`: A list of tuples, where each tuple contains the
+    ``negative`` and ``positive`` scores for one probe of the database.
 
   """
   score_lines = four_column(filename)
@@ -328,18 +328,18 @@ def cmc(filename, ncolumns=None):
 
   Parameters:
 
-  filename:  :py:class:`str`, ``file-like``:
-    The file object that will be opened with :py:func:`open_file` containing the scores.
+    filename (:py:class:`str` or ``file-like``): The file object that will be
+      opened with :py:func:`open_file` containing the scores.
 
-  ncolumns: int or ``None``
-    If specified to be ``4`` or ``5``, the score file will be assumed to be in the given format.
-    If not specified, the score file format will be estimated automatically
+    ncolumns: (:py:class:`int`, Optional): If specified to be ``4`` or ``5``,
+      the score file will be assumed to be in the given format.  If not
+      specified, the score file format will be estimated automatically
 
   Returns:
 
-  list: [(neg,pos)]
-    A list of tuples, where each tuple contains the ``negative`` and
-    ``positive`` scores for one probe of the database.
+  :py:class:`list`: [(neg,pos)] A list of tuples, where each tuple contains the
+  ``negative`` and ``positive`` scores for one probe of the database.
+
   """
   ncolumns = _estimate_score_file_format(filename, ncolumns)
   if ncolumns == 4:

bob/measure/plot.py

@@ -27,7 +27,8 @@ def log_values(min_step=-4, counts_per_step=4):
 
   Returns:
 
-    list: A list of logarithmically scaled values between :math:`10^{M}` and 1.
+    :py:class:`list`: A list of logarithmically scaled values between
+    :math:`10^{M}` and 1.
 
   """
 

bootstrap-buildout.py

-##############################################################################
-#
-# Copyright (c) 2006 Zope Foundation and Contributors.
-# All Rights Reserved.
-#
-# This software is subject to the provisions of the Zope Public License,
-# Version 2.1 (ZPL).  A copy of the ZPL should accompany this distribution.
-# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
-# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
-# FOR A PARTICULAR PURPOSE.
-#
-##############################################################################
-"""Bootstrap a buildout-based project
-
-Simply run this script in a directory containing a buildout.cfg.
-The script accepts buildout command-line options, so you can
-use the -c option to specify an alternate configuration file.
-"""
-
-import os
-import shutil
-import sys
-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-')
-
-usage = '''\
-[DESIRED PYTHON FOR BUILDOUT] bootstrap.py [options]
-
-Bootstraps a buildout-based project.
-
-Simply run this script in a directory containing a buildout.cfg, using the
-Python that you want bin/buildout to use.
-
-Note that by using --find-links to point to local resources, you can keep
-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("-t", "--accept-buildout-test-releases",
-                  dest='accept_buildout_test_releases',
-                  action="store_true", default=False,
-                  help=("Normally, if you do not specify a --version, the "
-                        "bootstrap script and buildout gets the newest "
-                        "*final* versions of zc.buildout and its recipes and "
-                        "extensions for you.  If you use this flag, "
-                        "bootstrap and buildout will get the newest releases "
-                        "even if they are alphas or betas."))
-parser.add_option("-c", "--config-file",
-                  help=("Specify the path to the buildout configuration "
-                        "file to be used."))
-parser.add_option("-f", "--find-links",
-                  help=("Specify a URL to search for buildout releases"))
-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"))
-
-options, args = parser.parse_args()
-if options.version:
-    print("bootstrap.py version %s" % __version__)
-    sys.exit(0)
-
-
-######################################################################
-# load/install setuptools
-
-try:
-    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:
-    # ez_setup imports site, which adds site packages
-    # this will remove them from the path to ensure that incompatible versions
-    # of setuptools are not in the path
-    import site
-    # inside a virtualenv, there is no 'getsitepackages'.
-    # 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]
-
-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
-import pkg_resources
-
-# This does not (always?) update the default working set.  We will
-# do it.
-for path in sys.path:
-    if path not in pkg_resources.working_set.entries:
-        pkg_resources.working_set.add_entry(path)
-
-######################################################################
-# Install buildout
-
-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]
-
-find_links = os.environ.get(
-    'bootstrap-testing-find-links',
-    options.find_links or
-    ('http://downloads.buildout.org/'
-     if options.accept_buildout_test_releases else None)
-    )
-if find_links:
-    cmd.extend(['-f', find_links])
-
-requirement = 'zc.buildout'
-version = options.buildout_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
-    _final_parts = '*final-', '*final'
-
-    def _final_version(parsed_version):
-        try:
-            return not parsed_version.is_prerelease
-        except AttributeError:
-            # Older setuptools
-            for part in parsed_version:
-                if (part[:1] == '*') and (part not in _final_parts):
-                    return False
-            return True
-
-    index = setuptools.package_index.PackageIndex(
-        search_path=[setuptools_path])
-    if find_links:
-        index.add_find_links((find_links,))
-    req = pkg_resources.Requirement.parse(requirement)
-    if index.obtain(req) is not None:
-        best = []
-        bestv = None
-        for dist in index[req.project_name]:
-            distv = dist.parsed_version
-            if _final_version(distv):
-                if bestv is None or distv > bestv:
-                    best = [dist]
-                    bestv = distv
-                elif distv == bestv:
-                    best.append(dist)
-        if best:
-            best.sort()
-            version = best[-1].version
-if version:
-    requirement = '=='.join((requirement, version))
-cmd.append(requirement)
-
-import subprocess
-if subprocess.call(cmd) != 0:
-    raise Exception(
-        "Failed to execute command:\n%s" % repr(cmd)[1:-1])
-
-######################################################################
-# Import and run buildout
-
-ws.add_entry(tmpeggs)
-ws.require(requirement)
-import zc.buildout.buildout
-
-if not [a for a in args if '=' not in a]:
-    args.append('bootstrap')
-
-# if -c was provided, we push it back into args for buildout' main function
-if options.config_file is not None:
-    args[0:0] = ['-c', options.config_file]
-
-zc.buildout.buildout.main(args)
-shutil.rmtree(tmpeggs)

doc/nitpick-exceptions.txt

+# ignores stuff that does not exist in Python 2.7 manual
+py:class list