setuptools._distutils.command.build_py.build

class documentation

class build_py(Command): (source)

Undocumented

Method	`build_module`	Undocumented
Method	`build_modules`	Undocumented
Method	`build_package_data`	Copy data files into build directory
Method	`build_packages`	Undocumented
Method	`byte_compile`	Undocumented
Method	`check_module`	Undocumented
Method	`check_package`	Undocumented
Method	`finalize_options`	Set final values for all the options that this command supports. This is always called as late as possible, ie. after any option assignments from the command-line or from other commands have been done...
Method	`find_all_modules`	Compute the list of all modules that will be built, whether they are specified one-module-at-a-time ('self.py_modules') or by whole packages ('self.packages'). Return a list of tuples (package, module, module_file), just like 'find_modules()' and 'find_package_modules()' do.
Method	`find_data_files`	Return filenames for package's data files in 'src_dir'
Method	`find_modules`	Finds individually-specified Python modules, ie. those listed by module name in 'self.py_modules'. Returns a list of tuples (package, module_base, filename): 'package' is a tuple of the path through package-space to the module; 'module_base' is the bare (no packages, no dots) module name, and 'filename' is the path to the "...
Method	`find_package_modules`	Undocumented
Method	`get_data_files`	Generate list of '(package,src_dir,build_dir,filenames)' tuples
Method	`get_module_outfile`	Undocumented
Method	`get_outputs`	Undocumented
Method	`get_package_dir`	Return the directory, relative to the top of the source distribution, where package 'package' should be found (at least according to the 'package_dir' option, if any).
Method	`get_source_files`	Undocumented
Method	`initialize_options`	Set default values for all the options that this command supports. Note that these defaults may be overridden by other commands, by the setup script, by config files, or by the command-line. Thus, this is not the place to code dependencies between options; generally, 'initialize_options()' implementations are just a bunch of "self...
Method	`run`	A command's raison d'etre: carry out the action it exists to perform, controlled by the options initialized in 'initialize_options()', customized by other commands, the setup script, the command-line, and config files, and finalized in 'finalize_options()'...
Class Variable	`boolean_options`	Undocumented
Class Variable	`description`	Undocumented
Class Variable	`negative_opt`	Undocumented
Class Variable	`user_options`	Undocumented
Instance Variable	`build_lib`	Undocumented
Instance Variable	`compile`	Undocumented
Instance Variable	`data_files`	Undocumented
Instance Variable	`force`	Undocumented
Instance Variable	`optimize`	Undocumented
Instance Variable	`package`	Undocumented
Instance Variable	`package_data`	Undocumented
Instance Variable	`package_dir`	Undocumented
Instance Variable	`packages`	Undocumented
Instance Variable	`py_modules`	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
Class Variable	`sub_commands`	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 build_module(self, module, module_file, package): (source) ¶

Undocumented

def build_modules(self): (source) ¶

Undocumented

def build_package_data(self): (source) ¶

Copy data files into build directory

def build_packages(self): (source) ¶

Undocumented

def byte_compile(self, files): (source) ¶

Undocumented

def check_module(self, module, module_file): (source) ¶

Undocumented

def check_package(self, package, package_dir): (source) ¶

Undocumented

def finalize_options(self): (source) ¶

overrides setuptools._distutils.core.Command.finalize_options

Set final values for all the options that this command supports. This is always called as late as possible, ie. after any option assignments from the command-line or from other commands have been done. Thus, this is the place to code option dependencies: if 'foo' depends on 'bar', then it is safe to set 'foo' from 'bar' as long as 'foo' still has the same value it was assigned in 'initialize_options()'. This method must be implemented by all command classes.

def find_all_modules(self): (source) ¶

Compute the list of all modules that will be built, whether they are specified one-module-at-a-time ('self.py_modules') or by whole packages ('self.packages'). Return a list of tuples (package, module, module_file), just like 'find_modules()' and 'find_package_modules()' do.

def find_data_files(self, package, src_dir): (source) ¶

Return filenames for package's data files in 'src_dir'

def find_modules(self): (source) ¶

Finds individually-specified Python modules, ie. those listed by module name in 'self.py_modules'. Returns a list of tuples (package, module_base, filename): 'package' is a tuple of the path through package-space to the module; 'module_base' is the bare (no packages, no dots) module name, and 'filename' is the path to the ".py" file (relative to the distribution root) that implements the module.

def find_package_modules(self, package, package_dir): (source) ¶

Undocumented

def get_data_files(self): (source) ¶

Generate list of '(package,src_dir,build_dir,filenames)' tuples

def get_module_outfile(self, build_dir, package, module): (source) ¶

Undocumented

def get_outputs(self, include_bytecode=1): (source) ¶

Undocumented

def get_package_dir(self, package): (source) ¶

Return the directory, relative to the top of the source distribution, where package 'package' should be found (at least according to the 'package_dir' option, if any).

def get_source_files(self): (source) ¶

Undocumented

def initialize_options(self): (source) ¶

overrides setuptools._distutils.core.Command.initialize_options

Set default values for all the options that this command supports. Note that these defaults may be overridden by other commands, by the setup script, by config files, or by the command-line. Thus, this is not the place to code dependencies between options; generally, 'initialize_options()' implementations are just a bunch of "self.foo = None" assignments. This method must be implemented by all command classes.

def run(self): (source) ¶

overrides setuptools._distutils.core.Command.run

A command's raison d'etre: carry out the action it exists to perform, controlled by the options initialized in 'initialize_options()', customized by other commands, the setup script, the command-line, and config files, and finalized in 'finalize_options()'. All terminal output and filesystem interaction should be done by 'run()'. This method must be implemented by all command classes.

boolean_options: list[str] = (source) ¶

Undocumented

description: str = (source) ¶

Undocumented

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

Undocumented

user_options: list = (source) ¶

Undocumented

build_lib = (source) ¶

Undocumented

compile: int = (source) ¶

Undocumented