SearchCommand Class Reference

Inheritance diagram for SearchCommand:

Collaboration diagram for SearchCommand:

Public Member Functions
None	add_options (self)
int	run (self, Values options, List[str] args)
List[Dict[str, str]]	search (self, List[str] query, Values options)
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)
Public Member Functions inherited from SessionCommandMixin
None	__init__ (self)
PipSession	get_default_session (self, Values options)

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 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)
Protected Attributes inherited from CommandContextMixIn
	_in_main_context
	_main_context
Protected Attributes inherited from SessionCommandMixin
	_session

Detailed Description

Search for PyPI packages whose name or summary contains <query>.

Definition at line 34 of file search.py.

Member Function Documentation

add_options()

None add_options

(

self

)

Reimplemented from Command.

Definition at line 41 of file search.py.

    def add_options(self) -> None:
        self.cmd_opts.add_option(
            "-i",
            "--index",
            dest="index",
            metavar="URL",
            default=PyPI.pypi_url,
            help="Base URL of Python Package Index (default %default)",
        )
 
        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 53 of file search.py.

    def run(self, options: Values, args: List[str]) -> int:
        if not args:
            raise CommandError("Missing required argument (search query).")
        query = args
        pypi_hits = self.search(query, options)
        hits = transform_hits(pypi_hits)
 
        terminal_width = None
        if sys.stdout.isatty():
            terminal_width = shutil.get_terminal_size()[0]
 
        print_results(hits, terminal_width=terminal_width)
        if pypi_hits:
            return SUCCESS
        return NO_MATCHES_FOUND
 

References i, pip._internal.commands.search.print_results(), SearchCommand.search(), PackageIndex.search(), and pip._internal.commands.search.transform_hits().

Here is the call graph for this function:

search()

List[Dict[str, str]] search	(		self,
		List[str]	query,
		Values	options
	)

Definition at line 69 of file search.py.

    def search(self, query: List[str], options: Values) -> List[Dict[str, str]]:
        index_url = options.index
 
        session = self.get_default_session(options)
 
        transport = PipXmlrpcTransport(index_url, session)
        pypi = xmlrpc.client.ServerProxy(index_url, transport)
        try:
            hits = pypi.search({"name": query, "summary": query}, "or")
        except xmlrpc.client.Fault as fault:
            message = "XMLRPC request failed [code: {code}]\n{string}".format(
                code=fault.faultCode,
                string=fault.faultString,
            )
            raise CommandError(message)
        assert isinstance(hits, list)
        return hits
 
 

References SessionCommandMixin.get_default_session(), and i.

Referenced by SearchCommand.run().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

cmd_opts

cmd_opts

Definition at line 51 of file search.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 39 of file search.py.

usage

str usage

static

Initial value:

=  """
      %prog [options] <query>"""

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