Class: Ansible::Ruby::Modules::Pip

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/packaging/language/pip.rb

Overview

Manage Python library dependencies. To use this module, one of the following keys is required: C(name) or C(requirements).

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#chdir ⇒ Object?

Returns cd into this directory before running the command.

Returns:

  • (Object, nil) —

    cd into this directory before running the command



50
 
# File 'lib/ansible/ruby/modules/generated/packaging/language/pip.rb', line 50

attribute :chdir

#editable ⇒ :yes, ...

Returns Pass the editable flag.

Returns:

  • (:yes, :no, nil) —

    Pass the editable flag.



46
 
# File 'lib/ansible/ruby/modules/generated/packaging/language/pip.rb', line 46

attribute :editable

#executable ⇒ String?

Returns The explicit executable or a pathname to the executable to be used to run pip for a specific version of Python installed in the system. For example C(pip-3.3), if there are both Python 2.7 and 3.3 installations in the system and you want to run pip for the Python 3.3 installation. It cannot be specified together with the ‘virtualenv’ parameter (added in 2.1). By default, it will take the appropriate version for the python interpreter use by ansible, e.g. pip3 on python 3, and pip2 or pip on python 2.

Returns:

  • (String, nil) —

    The explicit executable or a pathname to the executable to be used to run pip for a specific version of Python installed in the system. For example C(pip-3.3), if there are both Python 2.7 and 3.3 installations in the system and you want to run pip for the Python 3.3 installation. It cannot be specified together with the ‘virtualenv’ parameter (added in 2.1). By default, it will take the appropriate version for the python interpreter use by ansible, e.g. pip3 on python 3, and pip2 or pip on python 2.



53
 
# File 'lib/ansible/ruby/modules/generated/packaging/language/pip.rb', line 53

attribute :executable

#extra_args ⇒ String?

Returns Extra arguments passed to pip.

Returns:

  • (String, nil) —

    Extra arguments passed to pip.



42
 
# File 'lib/ansible/ruby/modules/generated/packaging/language/pip.rb', line 42

attribute :extra_args

#name ⇒ Array<String>, ...

Returns The name of a Python library to install or the url(bzr+,hg+,git+,svn+) of the remote package.,This can be a list (since 2.2) and contain version specifiers (since 2.7).

Returns:

  • (Array<String>, String, nil) —

    The name of a Python library to install or the url(bzr+,hg+,git+,svn+) of the remote package.,This can be a list (since 2.2) and contain version specifiers (since 2.7).



12
 
# File 'lib/ansible/ruby/modules/generated/packaging/language/pip.rb', line 12

attribute :name

#requirements ⇒ String?

Returns The path to a pip requirements file, which should be local to the remote system. File can be specified as a relative path if using the chdir option.

Returns:

  • (String, nil) —

    The path to a pip requirements file, which should be local to the remote system. File can be specified as a relative path if using the chdir option.



19
 
# File 'lib/ansible/ruby/modules/generated/packaging/language/pip.rb', line 19

attribute :requirements

#state ⇒ :absent, ...

Returns The state of module,The ‘forcereinstall’ option is only available in Ansible 2.1 and above.

Returns:

  • (:absent, :forcereinstall, :latest, :present, nil) —

    The state of module,The ‘forcereinstall’ option is only available in Ansible 2.1 and above.



38
 
# File 'lib/ansible/ruby/modules/generated/packaging/language/pip.rb', line 38

attribute :state

#umask ⇒ String?

Returns The system umask to apply before installing the pip package. This is useful, for example, when installing on systems that have a very restrictive umask by default (e.g., 0077) and you want to pip install packages which are to be used by all users. Note that this requires you to specify desired umask mode in octal, with a leading 0 (e.g., 0077).

Returns:

  • (String, nil) —

    The system umask to apply before installing the pip package. This is useful, for example, when installing on systems that have a very restrictive umask by default (e.g., 0077) and you want to pip install packages which are to be used by all users. Note that this requires you to specify desired umask mode in octal, with a leading 0 (e.g., 0077).



57
 
# File 'lib/ansible/ruby/modules/generated/packaging/language/pip.rb', line 57

attribute :umask

#version ⇒ Object?

Returns The version number to install of the Python library specified in the I(name) parameter.

Returns:

  • (Object, nil) —

    The version number to install of the Python library specified in the I(name) parameter.



16
 
# File 'lib/ansible/ruby/modules/generated/packaging/language/pip.rb', line 16

attribute :version

#virtualenv ⇒ String?

Returns An optional path to a I(virtualenv) directory to install into. It cannot be specified together with the ‘executable’ parameter (added in 2.1). If the virtualenv does not exist, it will be created before installing packages. The optional virtualenv_site_packages, virtualenv_command, and virtualenv_python options affect the creation of the virtualenv.

Returns:

  • (String, nil) —

    An optional path to a I(virtualenv) directory to install into. It cannot be specified together with the ‘executable’ parameter (added in 2.1). If the virtualenv does not exist, it will be created before installing packages. The optional virtualenv_site_packages, virtualenv_command, and virtualenv_python options affect the creation of the virtualenv.



23
 
# File 'lib/ansible/ruby/modules/generated/packaging/language/pip.rb', line 23

attribute :virtualenv

#virtualenv_command ⇒ String?

Returns The command or a pathname to the command to create the virtual environment with. For example C(pyvenv), C(virtualenv), C(virtualenv2), C(~/bin/virtualenv), C(/usr/local/bin/virtualenv).

Returns:

  • (String, nil) —

    The command or a pathname to the command to create the virtual environment with. For example C(pyvenv), C(virtualenv), C(virtualenv2), C(~/bin/virtualenv), C(/usr/local/bin/virtualenv).



31
 
# File 'lib/ansible/ruby/modules/generated/packaging/language/pip.rb', line 31

attribute :virtualenv_command

#virtualenv_python ⇒ Object?

Returns The Python executable used for creating the virtual environment. For example C(python3.5), C(python2.7). When not specified, the Python version used to run the ansible module is used. This parameter should not be used when C(virtualenv_command) is using C(pyvenv) or the C(-m venv) module.

Returns:

  • (Object, nil) —

    The Python executable used for creating the virtual environment. For example C(python3.5), C(python2.7). When not specified, the Python version used to run the ansible module is used. This parameter should not be used when C(virtualenv_command) is using C(pyvenv) or the C(-m venv) module.



35
 
# File 'lib/ansible/ruby/modules/generated/packaging/language/pip.rb', line 35

attribute :virtualenv_python

#virtualenv_site_packages ⇒ :yes, ...

Returns Whether the virtual environment will inherit packages from the global site-packages directory. Note that if this setting is changed on an already existing virtual environment it will not have any effect, the environment must be deleted and newly created.

Returns:

  • (:yes, :no, nil) —

    Whether the virtual environment will inherit packages from the global site-packages directory. Note that if this setting is changed on an already existing virtual environment it will not have any effect, the environment must be deleted and newly created.



27
 
# File 'lib/ansible/ruby/modules/generated/packaging/language/pip.rb', line 27

attribute :virtualenv_site_packages