pip.cmdoptions Namespace Reference

Classes
class	OptionMaker

Functions
def	make_option_group

Variables
tuple	help_
tuple	require_virtualenv
tuple	verbose
tuple	version
tuple	quiet
tuple	log
tuple	log_explicit_levels
tuple	log_file
tuple	no_input
tuple	proxy
tuple	timeout
tuple	default_vcs
tuple	skip_requirements_regex
tuple	exists_action
tuple	cert
tuple	index_url
tuple	extra_index_url
tuple	no_index
tuple	find_links
tuple	use_mirrors
tuple	mirrors
tuple	allow_external
tuple	allow_all_external
tuple	no_allow_external
tuple	allow_unsafe
tuple	no_allow_unsafe
tuple	process_dependency_links
tuple	requirements
tuple	use_wheel
tuple	no_use_wheel
tuple	download_cache
tuple	no_deps
tuple	build_dir
tuple	install_options
tuple	global_options
tuple	no_clean
dictionary	general_group
	groups # More...
dictionary	index_group

Detailed Description

shared options and groups

The principle here is to define options once, but *not* instantiate them globally.
One reason being that options with action='append' can carry state between parses.
pip parse's general options twice internally, and shouldn't pass on state.
To be consistent, all options will follow this design.

Function Documentation

def pip.cmdoptions.make_option_group	(		group,
			parser
	)

Return an OptionGroup object
group  -- assumed to be dict with 'name' and 'options' keys
parser -- an optparse Parser

Variable Documentation

tuple pip.cmdoptions.allow_all_external

Initial value:

= OptionMaker(
    "--allow-all-external",
    dest="allow_all_external",
    action="store_true",
    default=False,
    help="Allow the installation of all externally hosted files",
)

tuple pip.cmdoptions.allow_external

Initial value:

= OptionMaker(
    "--allow-external",
    dest="allow_external",
    action="append",
    default=[],
    metavar="PACKAGE",
    help="Allow the installation of externally hosted files",
)

tuple pip.cmdoptions.allow_unsafe

Initial value:

= OptionMaker(
    "--allow-unverified", "--allow-insecure",
    dest="allow_unverified",
    action="append",
    default=[],
    metavar="PACKAGE",
    help="Allow the installation of insecure and unverifiable files",
)

tuple pip.cmdoptions.build_dir

Initial value:

= OptionMaker(
    '-b', '--build', '--build-dir', '--build-directory',
    dest='build_dir',
    metavar='dir',
    default=build_prefix,
    help='Directory to unpack packages into and build in. '
    'The default in a virtualenv is "<venv path>/build". '
    'The default for global installs is "<OS temp dir>/pip_build_<username>".')

tuple pip.cmdoptions.cert

Initial value:

= OptionMaker(
    '--cert',
    dest='cert',
    type='str',
    default='',
    metavar='path',
    help = "Path to alternate CA bundle.")

tuple pip.cmdoptions.default_vcs

Initial value:

= OptionMaker(
    # The default version control system for editables, e.g. 'svn'
    '--default-vcs',
    dest='default_vcs',
    type='str',
    default='',
    help=SUPPRESS_HELP)

tuple pip.cmdoptions.download_cache

Initial value:

= OptionMaker(
    '--download-cache',
    dest='download_cache',
    metavar='dir',
    default=None,
    help='Cache downloaded packages in <dir>.')

tuple pip.cmdoptions.exists_action

Initial value:

= OptionMaker(
    # Option when path already exist
    '--exists-action',
    dest='exists_action',
    type='choice',
    choices=['s', 'i', 'w', 'b'],
    default=[],
    action='append',
    metavar='action',
    help="Default action when a path already exists: "
    "(s)witch, (i)gnore, (w)ipe, (b)ackup.")

tuple pip.cmdoptions.extra_index_url

Initial value:

= OptionMaker(
    '--extra-index-url',
    dest='extra_index_urls',
    metavar='URL',
    action='append',
    default=[],
    help='Extra URLs of package indexes to use in addition to --index-url.')

tuple pip.cmdoptions.find_links

Initial value:

= OptionMaker(
    '-f', '--find-links',
    dest='find_links',
    action='append',
    default=[],
    metavar='url',
    help="If a url or path to an html file, then parse for links to archives. If a local path or file:// url that's a directory, then look for archives in the directory listing.")

dictionary pip.cmdoptions.general_group

Initial value:

= {
    'name': 'General Options',
    'options': [
        help_,
        require_virtualenv,
        verbose,
        version,
        quiet,
        log_file,
        log,
        log_explicit_levels,
        no_input,
        proxy,
        timeout,
        default_vcs,
        skip_requirements_regex,
        exists_action,
        cert,
        ]
    }

groups #

tuple pip.cmdoptions.global_options

Initial value:

= OptionMaker(
    '--global-option',
    dest='global_options',
    action='append',
    metavar='options',
    help="Extra global options to be supplied to the setup.py "
    "call before the install command.")

tuple pip.cmdoptions.help_

Initial value:

= OptionMaker(
    '-h', '--help',
    dest='help',
    action='help',
    help='Show help.')

dictionary pip.cmdoptions.index_group

Initial value:

= {
    'name': 'Package Index Options',
    'options': [
        index_url,
        extra_index_url,
        no_index,
        find_links,
        use_mirrors,
        mirrors,
        allow_external,
        allow_all_external,
        no_allow_external,
        allow_unsafe,
        no_allow_unsafe,
        process_dependency_links,
        ]
    }

tuple pip.cmdoptions.index_url

Initial value:

= OptionMaker(
    '-i', '--index-url', '--pypi-url',
    dest='index_url',
    metavar='URL',
    default='https://pypi.python.org/simple/',
    help='Base URL of Python Package Index (default %default).')

tuple pip.cmdoptions.install_options

Initial value:

= OptionMaker(
    '--install-option',
    dest='install_options',
    action='append',
    metavar='options',
    help="Extra arguments to be supplied to the setup.py install "
    "command (use like --install-option=\"--install-scripts=/usr/local/bin\"). "
    "Use multiple --install-option options to pass multiple options to setup.py install. "
    "If you are using an option with a directory path, be sure to use absolute path.")

tuple pip.cmdoptions.log

Initial value:

= OptionMaker(
    '--log',
    dest='log',
    metavar='path',
    help='Path to a verbose appending log. This log is inactive by default.')

tuple pip.cmdoptions.log_explicit_levels

Initial value:

= OptionMaker(
    # Writes the log levels explicitely to the log'
    '--log-explicit-levels',
    dest='log_explicit_levels',
    action='store_true',
    default=False,
    help=SUPPRESS_HELP)

tuple pip.cmdoptions.log_file

Initial value:

= OptionMaker(
    # The default log file
    '--log-file', '--local-log',
    dest='log_file',
    metavar='path',
    default=default_log_file,
    help='Path to a verbose non-appending log, that only logs failures. This log is active by default at %default.')

tuple pip.cmdoptions.mirrors

Initial value:

= OptionMaker(
    '--mirrors',
    dest='mirrors',
    metavar='URL',
    action='append',
    default=[],
    help=SUPPRESS_HELP)

tuple pip.cmdoptions.no_allow_external

Initial value:

= OptionMaker(
    "--no-allow-external",
    dest="allow_all_external",
    action="store_false",
    default=False,
    help=SUPPRESS_HELP,
)

tuple pip.cmdoptions.no_allow_unsafe

Initial value:

= OptionMaker(
    "--no-allow-insecure",
    dest="allow_all_insecure",
    action="store_false",
    default=False,
    help=SUPPRESS_HELP
)

tuple pip.cmdoptions.no_clean

Initial value:

= OptionMaker(
    '--no-clean',
    action='store_true',
    default=False,
    help="Don't clean up build directories.")

tuple pip.cmdoptions.no_deps

Initial value:

= OptionMaker(
    '--no-deps', '--no-dependencies',
    dest='ignore_dependencies',
    action='store_true',
    default=False,
    help="Don't install package dependencies.")

tuple pip.cmdoptions.no_index

Initial value:

= OptionMaker(
    '--no-index',
    dest='no_index',
    action='store_true',
    default=False,
    help='Ignore package index (only looking at --find-links URLs instead).')

tuple pip.cmdoptions.no_input

Initial value:

= OptionMaker(
    # Don't ask for input
    '--no-input',
    dest='no_input',
    action='store_true',
    default=False,
    help=SUPPRESS_HELP)

tuple pip.cmdoptions.no_use_wheel

Initial value:

= OptionMaker(
    '--no-use-wheel',
    dest='use_wheel',
    action='store_false',
    default=True,
    help=('Do not Find and prefer wheel archives when searching indexes and '
          'find-links locations.'),
)

tuple pip.cmdoptions.process_dependency_links

Initial value:

= OptionMaker(
    "--process-dependency-links",
    dest="process_dependency_links",
    action="store_true",
    default=False,
    help="Enable the processing of dependency links.",
)

tuple pip.cmdoptions.proxy

Initial value:

= OptionMaker(
    '--proxy',
    dest='proxy',
    type='str',
    default='',
    help="Specify a proxy in the form [user:passwd@]proxy.server:port.")

tuple pip.cmdoptions.quiet

Initial value:

= OptionMaker(
    '-q', '--quiet',
    dest='quiet',
    action='count',
    default=0,
    help='Give less output.')

tuple pip.cmdoptions.require_virtualenv

Initial value:

= OptionMaker(
    # Run only if inside a virtualenv, bail if not.
    '--require-virtualenv', '--require-venv',
    dest='require_venv',
    action='store_true',
    default=False,
    help=SUPPRESS_HELP)

tuple pip.cmdoptions.requirements

Initial value:

= OptionMaker(
    '-r', '--requirement',
    dest='requirements',
    action='append',
    default=[],
    metavar='file',
    help='Install from the given requirements file. '
    'This option can be used multiple times.')

tuple pip.cmdoptions.skip_requirements_regex

Initial value:

= OptionMaker(
    # A regex to be used to skip requirements
    '--skip-requirements-regex',
    dest='skip_requirements_regex',
    type='str',
    default='',
    help=SUPPRESS_HELP)

tuple pip.cmdoptions.timeout

Initial value:

= OptionMaker(
    '--timeout', '--default-timeout',
    metavar='sec',
    dest='timeout',
    type='float',
    default=15,
    help='Set the socket timeout (default %default seconds).')

tuple pip.cmdoptions.use_mirrors

Initial value:

= OptionMaker(
    '-M', '--use-mirrors',
    dest='use_mirrors',
    action='store_true',
    default=False,
    help=SUPPRESS_HELP)

tuple pip.cmdoptions.use_wheel

Initial value:

= OptionMaker(
    '--use-wheel',
    dest='use_wheel',
    action='store_true',
    help=SUPPRESS_HELP,
)

tuple pip.cmdoptions.verbose

Initial value:

= OptionMaker(
    '-v', '--verbose',
    dest='verbose',
    action='count',
    default=0,
    help='Give more output. Option is additive, and can be used up to 3 times.')

tuple pip.cmdoptions.version

Initial value:

= OptionMaker(
    '-V', '--version',
    dest='version',
    action='store_true',
    help='Show version and exit.')