DebugCommand Class Reference

Inheritance diagram for DebugCommand:

Collaboration diagram for DebugCommand:

Public Member Functions
None	add_options (self)
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	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)

Data Fields
	cmd_opts
Data Fields inherited from Command
	name
	summary
	parser
	cmd_opts
	tempdir_registry
	verbosity

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

Additional Inherited Members
Protected Member Functions inherited from Command
int	_main (self, List[str] args)
Protected Attributes inherited from CommandContextMixIn
	_in_main_context
	_main_context

Detailed Description

Display debug information.

Definition at line 156 of file debug.py.

Member Function Documentation

add_options()

None add_options

(

self

)

Reimplemented from Command.

Definition at line 165 of file debug.py.

    def add_options(self) -> None:
        cmdoptions.add_target_python_options(self.cmd_opts)
        self.parser.insert_option_group(0, self.cmd_opts)
        self.parser.config.load()
 

run()

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

Reimplemented from Command.

Definition at line 170 of file debug.py.

    def run(self, options: Values, args: List[str]) -> int:
        logger.warning(
            "This command is only meant for debugging. "
            "Do not use this with automation for parsing and getting these "
            "details, since the output and options of this command may "
            "change without notice."
        )
        show_value("pip version", get_pip_version())
        show_value("sys.version", sys.version)
        show_value("sys.executable", sys.executable)
        show_value("sys.getdefaultencoding", sys.getdefaultencoding())
        show_value("sys.getfilesystemencoding", sys.getfilesystemencoding())
        show_value(
            "locale.getpreferredencoding",
            locale.getpreferredencoding(),
        )
        show_value("sys.platform", sys.platform)
        show_sys_implementation()
 
        show_value("'cert' config value", ca_bundle_info(self.parser.config))
        show_value("REQUESTS_CA_BUNDLE", os.environ.get("REQUESTS_CA_BUNDLE"))
        show_value("CURL_CA_BUNDLE", os.environ.get("CURL_CA_BUNDLE"))
        show_value("pip._vendor.certifi.where()", where())
        show_value("pip._vendor.DEBUNDLED", pip._vendor.DEBUNDLED)
 
        show_vendor_versions()
 
        show_tags(options)
 
        return SUCCESS

References pip._internal.commands.debug.ca_bundle_info(), i, Command.parser, PrettyHelpFormatter.parser, UpdatingDefaultsHelpFormatter.parser, DownloadCommand.parser, IndexCommand.parser, InstallCommand.parser, WheelCommand.parser, pip._internal.commands.debug.show_sys_implementation(), pip._internal.commands.debug.show_tags(), pip._internal.commands.debug.show_value(), and pip._internal.commands.debug.show_vendor_versions().

Here is the call graph for this function:

Field Documentation

cmd_opts

cmd_opts

Definition at line 166 of file debug.py.

Referenced by RequirementCommand.__init__(), CacheCommand.add_options(), CompletionCommand.add_options(), ConfigurationCommand.add_options(), DownloadCommand.add_options(), FreezeCommand.add_options(), HashCommand.add_options(), InspectCommand.add_options(), InstallCommand.add_options(), ListCommand.add_options(), SearchCommand.add_options(), ShowCommand.add_options(), UninstallCommand.add_options(), and WheelCommand.add_options().

ignore_require_venv

bool ignore_require_venv = True

static

Definition at line 163 of file debug.py.

usage

str usage

static

Initial value:

=  """
      %prog <options>"""

Definition at line 161 of file debug.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/debug.py