HashCommand Class Reference

Inheritance diagram for HashCommand:

Collaboration diagram for HashCommand:

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 = "%prog [options] <file> ..."
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

Compute a hash of a local package archive.

These can be used with --hash in a requirements file to do repeatable
installs.

Definition at line 15 of file hash.py.

Member Function Documentation

add_options()

None add_options

(

self

)

Reimplemented from Command.

Definition at line 26 of file hash.py.

    def add_options(self) -> None:
        self.cmd_opts.add_option(
            "-a",
            "--algorithm",
            dest="algorithm",
            choices=STRONG_HASHES,
            action="store",
            default=FAVORITE_HASH,
            help="The hash algorithm to use: one of {}".format(
                ", ".join(STRONG_HASHES)
            ),
        )
        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 40 of file hash.py.

    def run(self, options: Values, args: List[str]) -> int:
        if not args:
            self.parser.print_usage(sys.stderr)
            return ERROR
 
        algorithm = options.algorithm
        for path in args:
            write_output(
                "%s:\n--hash=%s:%s", path, algorithm, _hash_of_file(path, algorithm)
            )
        return SUCCESS
 
 

References pip._internal.commands.hash._hash_of_file(), i, Command.parser, PrettyHelpFormatter.parser, UpdatingDefaultsHelpFormatter.parser, DownloadCommand.parser, IndexCommand.parser, InstallCommand.parser, and WheelCommand.parser.

Here is the call graph for this function:

Field Documentation

cmd_opts

cmd_opts

Definition at line 38 of file hash.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 hash.py.

usage

str usage = "%prog [options] <file> ..."

static

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