Inheritance diagram for CacheCommand:

[legend]

Collaboration diagram for CacheCommand:

[legend]

Public Member Functions
None	add_options (self)

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

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

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

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

None	format_for_human (self, List[str] files)

None	format_for_abspath (self, List[str] files)

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

None	purge_cache (self, Values options, List[Any] 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

	get_cache_dir

	get_cache_info

	list_cache_items

	remove_cache_items

	purge_cache

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
str	_cache_dir (self, Values options, str subdir)

List[str]	_find_http_files (self, Values options)

List[str]	_find_wheels (self, Values options, str pattern)

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 and manage pip's wheel cache.

Subcommands:

- dir: Show the cache directory.
- info: Show information about the cache.
- list: List filenames of packages stored in the cache.
- remove: Remove one or more package from the cache.
- purge: Remove all items from the cache.

``<pattern>`` can be a glob expression or a package name.

Definition at line 15 of file cache.py.

Member Function Documentation

◆ _cache_dir()

str _cache_dir	(		self,
		Values	options,
		str	subdir
	)

protected

Definition at line 194 of file cache.py.

    def _cache_dir(self, options: Values, subdir: str) -> str:
        return os.path.join(options.cache_dir, subdir)
 

References i.

Referenced by CacheCommand._find_http_files(), CacheCommand._find_wheels(), and CacheCommand.get_cache_info().

Here is the caller graph for this function:

◆ _find_http_files()

List[str] _find_http_files	(		self,
		Values	options
	)

protected

Definition at line 197 of file cache.py.

    def _find_http_files(self, options: Values) -> List[str]:
        http_dir = self._cache_dir(options, "http")
        return filesystem.find_files(http_dir, "*")
 

References CacheCommand._cache_dir(), and i.

Referenced by CacheCommand.get_cache_info(), and CacheCommand.remove_cache_items().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _find_wheels()

List[str] _find_wheels	(		self,
		Values	options,
		str	pattern
	)

protected

Definition at line 201 of file cache.py.

    def _find_wheels(self, options: Values, pattern: str) -> List[str]:
        wheel_dir = self._cache_dir(options, "wheels")
 
        # The wheel filename format, as specified in PEP 427, is:
        #     {distribution}-{version}(-{build})?-{python}-{abi}-{platform}.whl
        #
        # Additionally, non-alphanumeric values in the distribution are
        # normalized to underscores (_), meaning hyphens can never occur
        # before `-{version}`.
        #
        # Given that information:
        # - If the pattern we're given contains a hyphen (-), the user is
        #   providing at least the version. Thus, we can just append `*.whl`
        #   to match the rest of it.
        # - If the pattern we're given doesn't contain a hyphen (-), the
        #   user is only providing the name. Thus, we append `-*.whl` to
        #   match the hyphen before the version, followed by anything else.
        #
        # PEP 427: https://www.python.org/dev/peps/pep-0427/
        pattern = pattern + ("*.whl" if "-" in pattern else "-*.whl")
 
        return filesystem.find_files(wheel_dir, pattern)

References CacheCommand._cache_dir(), and i.

Referenced by CacheCommand.get_cache_info(), CacheCommand.list_cache_items(), and CacheCommand.remove_cache_items().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ add_options()

None add_options ( self )

Reimplemented from Command.

Definition at line 39 of file cache.py.

    def add_options(self) -> None:
        self.cmd_opts.add_option(
            "--format",
            action="store",
            dest="list_format",
            default="human",
            choices=("human", "abspath"),
            help="Select the output format among: human (default) or abspath",
        )
 
        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.

◆ format_for_abspath()

None format_for_abspath	(		self,
		List[str]	files
	)

Definition at line 153 of file cache.py.

    def format_for_abspath(self, files: List[str]) -> None:
        if not files:
            return
 
        results = []
        for filename in files:
            results.append(filename)
 
        logger.info("\n".join(sorted(results)))
 

References i.

Referenced by CacheCommand.list_cache_items().

Here is the caller graph for this function:

◆ format_for_human()

None format_for_human	(		self,
		List[str]	files
	)

Definition at line 140 of file cache.py.

    def format_for_human(self, files: List[str]) -> None:
        if not files:
            logger.info("No locally built wheels cached.")
            return
 
        results = []
        for filename in files:
            wheel = os.path.basename(filename)
            size = filesystem.format_file_size(filename)
            results.append(f" - {wheel} ({size})")
        logger.info("Cache contents:\n")
        logger.info("\n".join(sorted(results)))
 

References i.

Referenced by CacheCommand.list_cache_items().

Here is the caller graph for this function:

◆ get_cache_dir()

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

Definition at line 83 of file cache.py.

    def get_cache_dir(self, options: Values, args: List[Any]) -> None:
        if args:
            raise CommandError("Too many arguments")
 
        logger.info(options.cache_dir)
 

References i.

◆ get_cache_info()

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

Definition at line 89 of file cache.py.

    def get_cache_info(self, options: Values, args: List[Any]) -> None:
        if args:
            raise CommandError("Too many arguments")
 
        num_http_files = len(self._find_http_files(options))
        num_packages = len(self._find_wheels(options, "*"))
 
        http_cache_location = self._cache_dir(options, "http")
        wheels_cache_location = self._cache_dir(options, "wheels")
        http_cache_size = filesystem.format_directory_size(http_cache_location)
        wheels_cache_size = filesystem.format_directory_size(wheels_cache_location)
 
        message = (
            textwrap.dedent(
                """
                    Package index page cache location: {http_cache_location}
                    Package index page cache size: {http_cache_size}
                    Number of HTTP files: {num_http_files}
                    Locally built wheels location: {wheels_cache_location}
                    Locally built wheels size: {wheels_cache_size}
                    Number of locally built wheels: {package_count}
                """
            )
            .format(
                http_cache_location=http_cache_location,
                http_cache_size=http_cache_size,
                num_http_files=num_http_files,
                wheels_cache_location=wheels_cache_location,
                package_count=num_packages,
                wheels_cache_size=wheels_cache_size,
            )
            .strip()
        )
 
        logger.info(message)
 

References CacheCommand._cache_dir(), CacheCommand._find_http_files(), CacheCommand._find_wheels(), and i.

Here is the call graph for this function:

◆ list_cache_items()

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

Definition at line 125 of file cache.py.

    def list_cache_items(self, options: Values, args: List[Any]) -> None:
        if len(args) > 1:
            raise CommandError("Too many arguments")
 
        if args:
            pattern = args[0]
        else:
            pattern = "*"
 
        files = self._find_wheels(options, pattern)
        if options.list_format == "human":
            self.format_for_human(files)
        else:
            self.format_for_abspath(files)
 

References CacheCommand._find_wheels(), CacheCommand.format_for_abspath(), CacheCommand.format_for_human(), and i.

Here is the call graph for this function:

◆ purge_cache()

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

Definition at line 188 of file cache.py.

    def purge_cache(self, options: Values, args: List[Any]) -> None:
        if args:
            raise CommandError("Too many arguments")
 
        return self.remove_cache_items(options, ["*"])
 

References CacheCommand.remove_cache_items, and CacheCommand.remove_cache_items().

Here is the call graph for this function:

◆ remove_cache_items()

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

Definition at line 163 of file cache.py.

    def remove_cache_items(self, options: Values, args: List[Any]) -> None:
        if len(args) > 1:
            raise CommandError("Too many arguments")
 
        if not args:
            raise CommandError("Please provide a pattern")
 
        files = self._find_wheels(options, args[0])
 
        no_matching_msg = "No matching packages"
        if args[0] == "*":
            # Only fetch http files if no specific pattern given
            files += self._find_http_files(options)
        else:
            # Add the pattern to the log message
            no_matching_msg += ' for pattern "{}"'.format(args[0])
 
        if not files:
            logger.warning(no_matching_msg)
 
        for filename in files:
            os.unlink(filename)
            logger.verbose("Removed %s", filename)
        logger.info("Files removed: %s", len(files))
 

References CacheCommand._find_http_files(), CacheCommand._find_wheels(), and i.

Referenced by CacheCommand.purge_cache().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ run()

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

Reimplemented from Command.

Definition at line 51 of file cache.py.

    def run(self, options: Values, args: List[str]) -> int:
        handlers = {
            "dir": self.get_cache_dir,
            "info": self.get_cache_info,
            "list": self.list_cache_items,
            "remove": self.remove_cache_items,
            "purge": self.purge_cache,
        }
 
        if not options.cache_dir:
            logger.error("pip cache commands can not function since cache is disabled.")
            return ERROR
 
        # 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 49 of file cache.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_cache_dir

get_cache_dir

Definition at line 53 of file cache.py.

◆ get_cache_info

get_cache_info

Definition at line 54 of file cache.py.

◆ ignore_require_venv

bool ignore_require_venv = True

static

Definition at line 30 of file cache.py.

◆ list_cache_items

list_cache_items

Definition at line 55 of file cache.py.

◆ purge_cache

purge_cache

Definition at line 57 of file cache.py.

◆ remove_cache_items

remove_cache_items

Definition at line 56 of file cache.py.

Referenced by CacheCommand.purge_cache().

◆ usage

str usage

static

Initial value:

=  """
        %prog dir
        %prog info
        %prog list [<pattern>] [--format=[human, abspath]]
        %prog remove <pattern>
        %prog purge
    """

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

Public Member Functions

Data Fields

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ _cache_dir()

◆ _find_http_files()

◆ _find_wheels()

◆ add_options()

◆ format_for_abspath()

◆ format_for_human()

◆ get_cache_dir()

◆ get_cache_info()

◆ list_cache_items()

◆ purge_cache()

◆ remove_cache_items()

◆ run()

Field Documentation

◆ cmd_opts

◆ get_cache_dir

◆ get_cache_info

◆ ignore_require_venv

◆ list_cache_items

◆ purge_cache

◆ remove_cache_items

◆ usage