setuptools._distutils.command.install.install

class documentation

class install(Command): (source)

View In Hierarchy

Undocumented

Method change_roots Change the install directories pointed by name using root.
Method convert_paths Call `convert_path` over `names`.
Method create_home_path Create directories under ~.
Method create_path_file Creates the .pth file
Method dump_dirs Dumps the list of user options.
Method expand_basedirs Calls `os.path.expanduser` on install_base, install_platbase and root.
Method expand_dirs Calls `os.path.expanduser` on install dirs.
Method finalize_options Finalizes options.
Method finalize_other Finalizes options for non-posix platforms
Method finalize_unix Finalizes options for posix platforms.
Method get_inputs Returns the inputs of all the sub-commands
Method get_outputs Assembles the outputs of all the sub-commands.
Method handle_extra_path Set `path_file` and `extra_dirs` using `extra_path`.
Method has_data Returns true if the current distribution has any data to. install.
Method has_headers Returns true if the current distribution has any headers to install.
Method has_lib Returns true if the current distribution has any Python modules to install.
Method has_scripts Returns true if the current distribution has any scripts to. install.
Method initialize_options Initializes options.
Method run Runs the command.
Method select_scheme Undocumented
Class Variable boolean_options Undocumented
Class Variable description Undocumented
Class Variable negative_opt Undocumented
Class Variable sub_commands Undocumented
Class Variable user_options Undocumented
Instance Variable build_base Undocumented
Instance Variable build_lib Undocumented
Instance Variable compile Undocumented
Instance Variable config_vars Undocumented
Instance Variable exec_prefix Undocumented
Instance Variable extra_dirs Undocumented
Instance Variable extra_path Undocumented
Instance Variable force Undocumented
Instance Variable home Undocumented
Instance Variable install_base Undocumented
Instance Variable install_data Undocumented
Instance Variable install_headers Undocumented
Instance Variable install_lib Undocumented
Instance Variable install_libbase Undocumented
Instance Variable install_path_file Undocumented
Instance Variable install_platbase Undocumented
Instance Variable install_platlib Undocumented
Instance Variable install_purelib Undocumented
Instance Variable install_scripts Undocumented
Instance Variable install_userbase Undocumented
Instance Variable install_usersite Undocumented
Instance Variable optimize Undocumented
Instance Variable path_file Undocumented
Instance Variable prefix Undocumented
Instance Variable record Undocumented
Instance Variable root Undocumented
Instance Variable skip_build Undocumented
Instance Variable user Undocumented
Instance Variable warn_dir Undocumented
Method _expand_attrs Undocumented

Inherited from Command:

Method __getattr__ Undocumented
Method __init__ Create and initialize a new Command object. Most importantly, invokes the 'initialize_options()' method, which is the real initializer and depends on the actual command being instantiated.
Method announce Undocumented
Method copy_file Copy a file respecting verbose, dry-run and force flags. (The former two default to whatever is in the Distribution object, and the latter defaults to false for commands that don't define it.)
Method copy_tree Copy an entire directory tree respecting verbose, dry-run, and force flags.
Method debug_print Print 'msg' to stdout if the global DEBUG (taken from the DISTUTILS_DEBUG environment variable) flag is true.
Method dump_options Undocumented
Method ensure_dirname Undocumented
Method ensure_filename Ensure that 'option' is the name of an existing file.
Method ensure_finalized Undocumented
Method ensure_string Ensure that 'option' is a string; if not defined, set it to 'default'.
Method ensure_string_list Ensure that 'option' is a list of strings. If 'option' is currently a string, we split it either on /,\s*/ or /\s+/, so "foo bar baz", "foo,bar,baz", and "foo, bar baz" all become ["foo", "bar", "baz"].
Method execute Undocumented
Method get_command_name Undocumented
Method get_finalized_command Wrapper around Distribution's 'get_command_obj()' method: find (create if necessary and 'create' is true) the command object for 'command', call its 'ensure_finalized()' method, and return the finalized command object.
Method get_sub_commands Determine the sub-commands that are relevant in the current distribution (ie., that need to be run). This is based on the 'sub_commands' class attribute: each tuple in that list may include a method that we call to determine if the subcommand needs to be run for the current distribution...
Method make_archive Undocumented
Method make_file Special case of 'execute()' for operations that process one or more input files and generate one output file. Works just like 'execute()', except the operation is skipped and a different message printed if 'outfile' already exists and is newer than all files listed in 'infiles'...
Method mkpath Undocumented
Method move_file Move a file respecting dry-run flag.
Method reinitialize_command Undocumented
Method run_command Run some other command: uses the 'run_command()' method of Distribution, which creates and finalizes the command object if necessary and then invokes its 'run()' method.
Method set_undefined_options Set the values of any "undefined" options from corresponding option values in some other command object. "Undefined" here means "is None", which is the convention used to indicate that an option has not been changed between 'initialize_options()' and 'finalize_options()'...
Method spawn Spawn an external command respecting dry-run flag.
Method warn Undocumented
Instance Variable distribution Undocumented
Instance Variable finalized Undocumented
Instance Variable help Undocumented
Instance Variable verbose Undocumented
Method _ensure_stringlike Undocumented
Method _ensure_tested_string Undocumented
Instance Variable _dry_run Undocumented
def change_roots(self, *names): (source)

Change the install directories pointed by name using root.

def convert_paths(self, *names): (source)

Call `convert_path` over `names`.

def create_home_path(self): (source)

Create directories under ~.

def create_path_file(self): (source)

Creates the .pth file

def dump_dirs(self, msg): (source)

Dumps the list of user options.

def expand_basedirs(self): (source)

Calls `os.path.expanduser` on install_base, install_platbase and root.

def expand_dirs(self): (source)

Calls `os.path.expanduser` on install dirs.

def finalize_options(self): (source)
overrides setuptools._distutils.core.Command.finalize_options

Finalizes options.

def finalize_other(self): (source)

Finalizes options for non-posix platforms

def finalize_unix(self): (source)

Finalizes options for posix platforms.

def get_inputs(self): (source)

Returns the inputs of all the sub-commands

def get_outputs(self): (source)

Assembles the outputs of all the sub-commands.

def handle_extra_path(self): (source)

Set `path_file` and `extra_dirs` using `extra_path`.

def has_data(self): (source)

Returns true if the current distribution has any data to. install.

def has_headers(self): (source)

Returns true if the current distribution has any headers to install.

def has_lib(self): (source)

Returns true if the current distribution has any Python modules to install.

def has_scripts(self): (source)

Returns true if the current distribution has any scripts to. install.

def initialize_options(self): (source)
overrides setuptools._distutils.core.Command.initialize_options

Initializes options.

def run(self): (source)
overrides setuptools._distutils.core.Command.run

Runs the command.

def select_scheme(self, name): (source)

Undocumented

boolean_options: list[str] = (source)

Undocumented

description: str = (source)

Undocumented

negative_opt: dict[str, str] = (source)

Undocumented

sub_commands = (source)
overrides setuptools._distutils.core.Command.sub_commands

Undocumented

user_options = (source)

Undocumented

build_base = (source)

Undocumented

build_lib = (source)

Undocumented

compile = (source)

Undocumented

config_vars = (source)

Undocumented

exec_prefix = (source)

Undocumented

extra_dirs = (source)

Undocumented

extra_path = (source)

Undocumented

force: int = (source)
overrides setuptools._distutils.core.Command.force

Undocumented

home = (source)

Undocumented

install_base = (source)

Undocumented

install_data = (source)

Undocumented

install_headers = (source)

Undocumented

install_lib = (source)

Undocumented

install_libbase = (source)

Undocumented

install_path_file: int = (source)

Undocumented

install_platbase = (source)

Undocumented

install_platlib = (source)

Undocumented

install_purelib = (source)

Undocumented

install_scripts = (source)

Undocumented

install_userbase = (source)

Undocumented

install_usersite = (source)

Undocumented

optimize = (source)

Undocumented

path_file = (source)

Undocumented

prefix = (source)

Undocumented

record = (source)

Undocumented

root = (source)

Undocumented

skip_build: int = (source)

Undocumented

user: int = (source)

Undocumented

warn_dir: int = (source)

Undocumented

def _expand_attrs(self, attrs): (source)

Undocumented