class documentation

class bdist_rpm(Command): (source)

View In Hierarchy

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 finalize_package_data 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 bdist_base Undocumented
Instance Variable binary_only Undocumented
Instance Variable build_requires Undocumented
Instance Variable build_script Undocumented
Instance Variable changelog Undocumented
Instance Variable clean_script Undocumented
Instance Variable conflicts Undocumented
Instance Variable dist_dir Undocumented
Instance Variable distribution_name Undocumented
Instance Variable doc_files Undocumented
Instance Variable fix_python Undocumented
Instance Variable force_arch Undocumented
Instance Variable group Undocumented
Instance Variable icon Undocumented
Instance Variable install_script Undocumented
Instance Variable keep_temp Undocumented
Instance Variable no_autoreq Undocumented
Instance Variable obsoletes Undocumented
Instance Variable packager Undocumented
Instance Variable post_install Undocumented
Instance Variable post_uninstall Undocumented
Instance Variable pre_install Undocumented
Instance Variable pre_uninstall Undocumented
Instance Variable prep Undocumented
Instance Variable prep_script Undocumented
Instance Variable provides Undocumented
Instance Variable python Undocumented
Instance Variable quiet Undocumented
Instance Variable release Undocumented
Instance Variable requires Undocumented
Instance Variable rpm3_mode Undocumented
Instance Variable rpm_base Undocumented
Instance Variable serial Undocumented
Instance Variable source_only Undocumented
Instance Variable spec_only Undocumented
Instance Variable use_bzip2 Undocumented
Instance Variable use_rpm_opt_flags Undocumented
Instance Variable vendor Undocumented
Instance Variable verify_script Undocumented
Method _dist_path Undocumented
Method _format_changelog Format the changelog correctly and convert it to a list of strings
Method _make_spec_file Generate the text of an RPM spec file and return it as a list of strings (one per line).

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 force Undocumented
Instance Variable help Undocumented
Instance Variable verbose Undocumented
Method _ensure_stringlike Undocumented
Method _ensure_tested_string Undocumented
Instance Variable _dry_run Undocumented
def finalize_options(self): (source)

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 finalize_package_data(self): (source)

Undocumented

def initialize_options(self): (source)

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)

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

bdist_base = (source)

Undocumented

binary_only = (source)

Undocumented

build_requires = (source)

Undocumented

build_script = (source)

Undocumented

changelog = (source)

Undocumented

clean_script = (source)

Undocumented

conflicts = (source)

Undocumented

dist_dir = (source)

Undocumented

distribution_name = (source)

Undocumented

doc_files = (source)

Undocumented

fix_python = (source)

Undocumented

force_arch = (source)

Undocumented

Undocumented

Undocumented

install_script = (source)

Undocumented

keep_temp: int = (source)

Undocumented

no_autoreq: int = (source)

Undocumented

obsoletes = (source)

Undocumented

packager = (source)

Undocumented

post_install = (source)

Undocumented

post_uninstall = (source)

Undocumented

pre_install = (source)

Undocumented

pre_uninstall = (source)

Undocumented

Undocumented

prep_script = (source)

Undocumented

provides = (source)

Undocumented

Undocumented

Undocumented

Undocumented

requires = (source)

Undocumented

rpm3_mode: int = (source)

Undocumented

rpm_base = (source)

Undocumented

Undocumented

source_only = (source)

Undocumented

spec_only = (source)

Undocumented

use_bzip2 = (source)

Undocumented

use_rpm_opt_flags: int = (source)

Undocumented

Undocumented

verify_script = (source)

Undocumented

def _dist_path(self, path): (source)

Undocumented

def _format_changelog(self, changelog): (source)

Format the changelog correctly and convert it to a list of strings

def _make_spec_file(self): (source)

Generate the text of an RPM spec file and return it as a list of strings (one per line).