InspectCommand Class Reference

Inheritance diagram for InspectCommand:

Collaboration diagram for InspectCommand:

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
bool	ignore_require_venv = True
str	usage
Static Public Attributes inherited from Command
str	usage = ""
bool	ignore_require_venv = False

Protected Member Functions
Dict[str, Any]	_dist_to_dict (self, BaseDistribution dist)
Protected Member Functions inherited from Command
int	_main (self, List[str] args)

Additional Inherited Members
Protected Attributes inherited from CommandContextMixIn
	_in_main_context
	_main_context

Detailed Description

Inspect the content of a Python environment and produce a report in JSON format.

Definition at line 19 of file inspect.py.

Member Function Documentation

_dist_to_dict()

Dict[str, Any] _dist_to_dict (   self, BaseDistribution  dist  )

protected

Definition at line 65 of file inspect.py.

    def _dist_to_dict(self, dist: BaseDistribution) -> Dict[str, Any]:
        res: Dict[str, Any] = {
            "metadata": dist.metadata_dict,
            "metadata_location": dist.info_location,
        }
        # direct_url. Note that we don't have download_info (as in the installation
        # report) since it is not recorded in installed metadata.
        direct_url = dist.direct_url
        if direct_url is not None:
            res["direct_url"] = direct_url.to_dict()
        else:
            # Emulate direct_url for legacy editable installs.
            editable_project_location = dist.editable_project_location
            if editable_project_location is not None:
                res["direct_url"] = {
                    "url": path_to_url(editable_project_location),
                    "dir_info": {
                        "editable": True,
                    },
                }
        # installer
        installer = dist.installer
        if dist.installer:
            res["installer"] = installer
        # requested
        if dist.installed_with_dist_info:
            res["requested"] = dist.requested
        return res

References i.

Referenced by InspectCommand.run().

Here is the caller graph for this function:

add_options()

None add_options

(

self

)

Reimplemented from Command.

Definition at line 28 of file inspect.py.

    def add_options(self) -> None:
        self.cmd_opts.add_option(
            "--local",
            action="store_true",
            default=False,
            help=(
                "If in a virtualenv that has global access, do not list "
                "globally-installed packages."
            ),
        )
        self.cmd_opts.add_option(
            "--user",
            dest="user",
            action="store_true",
            default=False,
            help="Only output packages installed in user-site.",
        )
        self.cmd_opts.add_option(cmdoptions.list_path())
        self.parser.insert_option_group(0, self.cmd_opts)
 

References Command.cmd_opts, CacheCommand.cmd_opts, CompletionCommand.cmd_opts, ConfigurationCommand.cmd_opts, DebugCommand.cmd_opts, DownloadCommand.cmd_opts, FreezeCommand.cmd_opts, HashCommand.cmd_opts, IndexCommand.cmd_opts, InspectCommand.cmd_opts, InstallCommand.cmd_opts, ListCommand.cmd_opts, SearchCommand.cmd_opts, ShowCommand.cmd_opts, UninstallCommand.cmd_opts, WheelCommand.cmd_opts, and i.

run()

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

Reimplemented from Command.

Definition at line 48 of file inspect.py.

    def run(self, options: Values, args: List[str]) -> int:
        cmdoptions.check_list_path_option(options)
        dists = get_environment(options.path).iter_installed_distributions(
            local_only=options.local,
            user_only=options.user,
            skip=set(stdlib_pkgs),
        )
        output = {
            "version": "1",
            "pip_version": __version__,
            "installed": [self._dist_to_dict(dist) for dist in dists],
            "environment": default_environment(),
            # TODO tags? scheme?
        }
        print_json(data=output)
        return SUCCESS
 

References InspectCommand._dist_to_dict(), and i.

Here is the call graph for this function:

Field Documentation

cmd_opts

cmd_opts

Definition at line 46 of file inspect.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 24 of file inspect.py.

usage

str usage

static

Initial value:

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

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