IndexCommand Class Reference

Inheritance diagram for IndexCommand:

Collaboration diagram for IndexCommand:

Public Member Functions
None	add_options (self)
int	run (self, Values options, List[str] args)
None	get_available_package_versions (self, Values options, List[Any] args)
Public Member Functions inherited from IndexGroupCommand
None	handle_pip_version_check (self, Values options)
Public Member Functions inherited from Command
None	__init__ (self, str name, str summary, bool isolated=False)
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)
Public Member Functions inherited from SessionCommandMixin
None	__init__ (self)
PipSession	get_default_session (self, Values options)

Data Fields
	cmd_opts
	parser
	get_available_package_versions
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
PackageFinder	_build_package_finder (self, Values options, PipSession session, Optional[TargetPython] target_python=None, Optional[bool] ignore_requires_python=None)
Protected Member Functions inherited from Command
int	_main (self, List[str] args)
Protected Member Functions inherited from SessionCommandMixin
Optional[List[str]]	_get_index_urls (cls, Values options)
PipSession	_build_session (self, Values options, Optional[int] retries=None, Optional[int] timeout=None, bool fallback_to_certifi=False)

Additional Inherited Members
Protected Attributes inherited from CommandContextMixIn
	_in_main_context
	_main_context
Protected Attributes inherited from SessionCommandMixin
	_session

Detailed Description

Inspect information available from package indexes.

Definition at line 22 of file index.py.

Member Function Documentation

_build_package_finder()

PackageFinder _build_package_finder (   self, Values  options, PipSession  session, Optional[TargetPython]   target_python = None, Optional[bool]   ignore_requires_python = None  )

protected

Create a package finder appropriate to the index command.

Definition at line 78 of file index.py.

    ) -> PackageFinder:
        """
        Create a package finder appropriate to the index command.
        """
        link_collector = LinkCollector.create(session, options=options)
 
        # Pass allow_yanked=False to ignore yanked versions.
        selection_prefs = SelectionPreferences(
            allow_yanked=False,
            allow_all_prereleases=options.pre,
            ignore_requires_python=ignore_requires_python,
        )
 
        return PackageFinder.create(
            link_collector=link_collector,
            selection_prefs=selection_prefs,
            target_python=target_python,
        )
 

References i.

Referenced by IndexCommand.get_available_package_versions(), ListCommand.iter_packages_latest_infos(), DownloadCommand.run(), InstallCommand.run(), and WheelCommand.run().

Here is the caller graph for this function:

add_options()

None add_options

(

self

)

Reimplemented from Command.

Definition at line 32 of file index.py.

    def add_options(self) -> None:
        cmdoptions.add_target_python_options(self.cmd_opts)
 
        self.cmd_opts.add_option(cmdoptions.ignore_requires_python())
        self.cmd_opts.add_option(cmdoptions.pre())
        self.cmd_opts.add_option(cmdoptions.no_binary())
        self.cmd_opts.add_option(cmdoptions.only_binary())
 
        index_opts = cmdoptions.make_option_group(
            cmdoptions.index_group,
            self.parser,
        )
 
        self.parser.insert_option_group(0, index_opts)
        self.parser.insert_option_group(0, self.cmd_opts)
 

get_available_package_versions()

None get_available_package_versions	(		self,
		Values	options,
		List[Any]	args
	)

Definition at line 103 of file index.py.

    def get_available_package_versions(self, options: Values, args: List[Any]) -> None:
        if len(args) != 1:
            raise CommandError("You need to specify exactly one argument")
 
        target_python = cmdoptions.make_target_python(options)
        query = args[0]
 
        with self._build_session(options) as session:
            finder = self._build_package_finder(
                options=options,
                session=session,
                target_python=target_python,
                ignore_requires_python=options.ignore_requires_python,
            )
 
            versions: Iterable[Union[LegacyVersion, Version]] = (
                candidate.version for candidate in finder.find_all_candidates(query)
            )
 
            if not options.pre:
                # Remove prereleases
                versions = (
                    version for version in versions if not version.is_prerelease
                )
            versions = set(versions)
 
            if not versions:
                raise DistributionNotFound(
                    "No matching distribution found for {}".format(query)
                )
 
            formatted_versions = [str(ver) for ver in sorted(versions, reverse=True)]
            latest = formatted_versions[0]
 
        write_output("{} ({})".format(query, latest))
        write_output("Available versions: {}".format(", ".join(formatted_versions)))
        print_dist_installation_info(query, latest)

References ListCommand._build_package_finder(), RequirementCommand._build_package_finder(), IndexCommand._build_package_finder(), SessionCommandMixin._build_session(), and i.

Here is the call graph for this function:

run()

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

Reimplemented from Command.

Definition at line 48 of file index.py.

    def run(self, options: Values, args: List[str]) -> int:
        handlers = {
            "versions": self.get_available_package_versions,
        }
 
        logger.warning(
            "pip index is currently an experimental command. "
            "It may be removed/changed in a future release "
            "without prior warning."
        )
 
        # Determine action
        if not args or args[0] not in handlers:
            logger.error(
                "Need an action (%s) to perform.",
                ", ".join(sorted(handlers)),
            )
            return ERROR
 
        action = args[0]
 
        # Error handling happens here, not in the action-handlers.
        try:
            handlers[action](options, args[1:])
        except PipError as e:
            logger.error(e.args[0])
            return ERROR
 
        return SUCCESS
 

Field Documentation

cmd_opts

cmd_opts

Definition at line 33 of file index.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().

get_available_package_versions

get_available_package_versions

Definition at line 50 of file index.py.

ignore_require_venv

bool ignore_require_venv = True

static

Definition at line 27 of file index.py.

parser

parser

Definition at line 42 of file index.py.

Referenced by ListCommand.add_options(), UpdatingDefaultsHelpFormatter.expand_default(), Command.parse_args(), DebugCommand.run(), and HashCommand.run().

usage

str usage

static

Initial value:

=  """
        %prog versions <package>
    """

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