CheckCommand Class Reference

Inheritance diagram for CheckCommand:

Collaboration diagram for CheckCommand:

Public Member Functions
int	run (self, Values options, List[str] args)
Public Member Functions inherited from Command
None	__init__ (self, str name, str summary, bool isolated=False)
None	add_options (self)
None	handle_pip_version_check (self, Values options)
Tuple[Values, List[str]]	parse_args (self, List[str] args)
int	main (self, List[str] args)
Public Member Functions inherited from CommandContextMixIn
Generator[None, None, None]	main_context (self)
_T	enter_context (self, ContextManager[_T] context_provider)

Static Public Attributes
str	usage
Static Public Attributes inherited from Command
str	usage = ""
bool	ignore_require_venv = False

Additional Inherited Members
Data Fields inherited from Command
	name
	summary
	parser
	cmd_opts
	tempdir_registry
	verbosity
Protected Member Functions inherited from Command
int	_main (self, List[str] args)
Protected Attributes inherited from CommandContextMixIn
	_in_main_context
	_main_context

Detailed Description

Verify installed packages have compatible dependencies.

Definition at line 17 of file check.py.

Member Function Documentation

run()

int run	(		self,
		Values	options,
		List[str]	args
	)

Reimplemented from Command.

Definition at line 23 of file check.py.

    def run(self, options: Values, args: List[str]) -> int:
        package_set, parsing_probs = create_package_set_from_installed()
        warn_legacy_versions_and_specifiers(package_set)
        missing, conflicting = check_package_set(package_set)
 
        for project_name in missing:
            version = package_set[project_name].version
            for dependency in missing[project_name]:
                write_output(
                    "%s %s requires %s, which is not installed.",
                    project_name,
                    version,
                    dependency[0],
                )
 
        for project_name in conflicting:
            version = package_set[project_name].version
            for dep_name, dep_version, req in conflicting[project_name]:
                write_output(
                    "%s %s has requirement %s, but you have %s %s.",
                    project_name,
                    version,
                    req,
                    dep_name,
                    dep_version,
                )
 
        if missing or conflicting or parsing_probs:
            return ERROR
        else:
            write_output("No broken requirements found.")
            return SUCCESS

Field Documentation

usage

str usage

static

Initial value:

=  """
      %prog [options]"""

Definition at line 20 of file check.py.

---

The documentation for this class was generated from the following file:

• /home/liwuen/projects_dev/pqc-engineering-ssec-23/venv/lib/python3.12/site-packages/pip/_internal/commands/check.py