setuptools._distutils.command.check.check

class documentation

class check(Command): (source)

This command checks the meta-data of the package.

Method	`check_metadata`	Ensures that all required elements of meta-data are supplied.
Method	`check_restructuredtext`	Checks if the long string fields are reST-compliant.
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	`initialize_options`	Sets default values for options.
Method	`run`	Runs the command.
Method	`warn`	Counts the number of warnings that occurs.
Class Variable	`boolean_options`	Undocumented
Class Variable	`description`	Undocumented
Class Variable	`user_options`	Undocumented
Instance Variable	`metadata`	Undocumented
Instance Variable	`restructuredtext`	Undocumented
Instance Variable	`strict`	Undocumented
Method	`_check_rst_data`	Returns warnings when the provided data doesn't compile.
Instance Variable	`_warnings`	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.
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 check_metadata(self): (source) ¶

Ensures that all required elements of meta-data are supplied. Required fields: name, version Warns if any are missing.

def check_restructuredtext(self): (source) ¶

Checks if the long string fields are reST-compliant.

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

overrides setuptools._distutils.core.Command.initialize_options

Sets default values for options.

def run(self): (source) ¶

overrides setuptools._distutils.core.Command.run

Runs the command.

def warn(self, msg): (source) ¶

overrides setuptools._distutils.core.Command.warn

Counts the number of warnings that occurs.

boolean_options: list[str] = (source) ¶

Undocumented

description: str = (source) ¶