Inheritance diagram for WheelCommand:

[legend]

Collaboration diagram for WheelCommand:

[legend]

Public Member Functions
None	add_options (self)

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

Public Member Functions inherited from RequirementCommand
None	__init__ (self, Any args, *Any kw)

RequirementPreparer	make_requirement_preparer (cls, TempDirectory temp_build_dir, Values options, BuildTracker build_tracker, PipSession session, PackageFinder finder, bool use_user_site, Optional[str] download_dir=None, int verbosity=0)

BaseResolver	make_resolver (cls, RequirementPreparer preparer, PackageFinder finder, Values options, Optional[WheelCache] wheel_cache=None, bool use_user_site=False, bool ignore_installed=True, bool ignore_requires_python=False, bool force_reinstall=False, str upgrade_strategy="to-satisfy-only", Optional[bool] use_pep517=None, Optional[Tuple[int,...]] py_version_info=None)

List[InstallRequirement]	get_requirements (self, List[str] args, Values options, PackageFinder finder, PipSession session)

Public Member Functions inherited from IndexGroupCommand
None	handle_pip_version_check (self, Values options)

Public Member Functions inherited from Command
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
PipSession	get_default_session (self, Values options)

Data Fields
	parser

	cmd_opts

Data Fields inherited from Command
	name

	summary

	parser

	cmd_opts

	tempdir_registry

	verbosity

Static Public Attributes
str	usage

Static Public Attributes inherited from Command
str	usage = ""

bool	ignore_require_venv = False

Additional Inherited Members
Static Public Member Functions inherited from RequirementCommand
str	determine_resolver_variant (Values options)

None	trace_basic_info (PackageFinder finder)

Protected Member Functions inherited from RequirementCommand
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)

Protected Attributes inherited from CommandContextMixIn
	_in_main_context

	_main_context

Protected Attributes inherited from SessionCommandMixin
	_session

Detailed Description

Build Wheel archives for your requirements and dependencies.

Wheel is a built-package format, and offers the advantage of not
recompiling your software during every install. For more details, see the
wheel docs: https://wheel.readthedocs.io/en/latest/

'pip wheel' uses the build system interface as described here:
https://pip.pypa.io/en/stable/reference/build-system/

Definition at line 24 of file wheel.py.

Member Function Documentation

◆ add_options()

None add_options ( self )

Reimplemented from Command.

Definition at line 44 of file wheel.py.

    def add_options(self) -> None:
        self.cmd_opts.add_option(
            "-w",
            "--wheel-dir",
            dest="wheel_dir",
            metavar="dir",
            default=os.curdir,
            help=(
                "Build wheels into <dir>, where the default is the "
                "current working directory."
            ),
        )
        self.cmd_opts.add_option(cmdoptions.no_binary())
        self.cmd_opts.add_option(cmdoptions.only_binary())
        self.cmd_opts.add_option(cmdoptions.prefer_binary())
        self.cmd_opts.add_option(cmdoptions.no_build_isolation())
        self.cmd_opts.add_option(cmdoptions.use_pep517())
        self.cmd_opts.add_option(cmdoptions.no_use_pep517())
        self.cmd_opts.add_option(cmdoptions.check_build_deps())
        self.cmd_opts.add_option(cmdoptions.constraints())
        self.cmd_opts.add_option(cmdoptions.editable())
        self.cmd_opts.add_option(cmdoptions.requirements())
        self.cmd_opts.add_option(cmdoptions.src())
        self.cmd_opts.add_option(cmdoptions.ignore_requires_python())
        self.cmd_opts.add_option(cmdoptions.no_deps())
        self.cmd_opts.add_option(cmdoptions.progress_bar())
 
        self.cmd_opts.add_option(
            "--no-verify",
            dest="no_verify",
            action="store_true",
            default=False,
            help="Don't verify if built wheel is valid.",
        )
 
        self.cmd_opts.add_option(cmdoptions.config_settings())
        self.cmd_opts.add_option(cmdoptions.build_options())
        self.cmd_opts.add_option(cmdoptions.global_options())
 
        self.cmd_opts.add_option(
            "--pre",
            action="store_true",
            default=False,
            help=(
                "Include pre-release and development versions. By default, "
                "pip only finds stable versions."
            ),
        )
 
        self.cmd_opts.add_option(cmdoptions.require_hashes())
 
        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)
 

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 104 of file wheel.py.

    def run(self, options: Values, args: List[str]) -> int:
        session = self.get_default_session(options)
 
        finder = self._build_package_finder(options, session)
 
        options.wheel_dir = normalize_path(options.wheel_dir)
        ensure_dir(options.wheel_dir)
 
        build_tracker = self.enter_context(get_build_tracker())
 
        directory = TempDirectory(
            delete=not options.no_clean,
            kind="wheel",
            globally_managed=True,
        )
 
        reqs = self.get_requirements(args, options, finder, session)
        check_legacy_setup_py_options(options, reqs)
 
        wheel_cache = WheelCache(options.cache_dir)
 
        preparer = self.make_requirement_preparer(
            temp_build_dir=directory,
            options=options,
            build_tracker=build_tracker,
            session=session,
            finder=finder,
            download_dir=options.wheel_dir,
            use_user_site=False,
            verbosity=self.verbosity,
        )
 
        resolver = self.make_resolver(
            preparer=preparer,
            finder=finder,
            options=options,
            wheel_cache=wheel_cache,
            ignore_requires_python=options.ignore_requires_python,
            use_pep517=options.use_pep517,
        )
 
        self.trace_basic_info(finder)
 
        requirement_set = resolver.resolve(reqs, check_supported_wheels=True)
 
        reqs_to_build: List[InstallRequirement] = []
        for req in requirement_set.requirements.values():
            if req.is_wheel:
                preparer.save_linked_requirement(req)
            elif should_build_for_wheel_command(req):
                reqs_to_build.append(req)
 
        preparer.prepare_linked_requirements_more(requirement_set.requirements.values())
        requirement_set.warn_legacy_versions_and_specifiers()
 
        # build wheels
        build_successes, build_failures = build(
            reqs_to_build,
            wheel_cache=wheel_cache,
            verify=(not options.no_verify),
            build_options=options.build_options or [],
            global_options=options.global_options or [],
        )
        for req in build_successes:
            assert req.link and req.link.is_wheel
            assert req.local_file_path
            # copy from cache to target directory
            try:
                shutil.copy(req.local_file_path, options.wheel_dir)
            except OSError as e:
                logger.warning(
                    "Building wheel for %s failed: %s",
                    req.name,
                    e,
                )
                build_failures.append(req)
        if len(build_failures) != 0:
            raise CommandError("Failed to build one or more wheels")
 
        return SUCCESS

References ListCommand._build_package_finder(), RequirementCommand._build_package_finder(), IndexCommand._build_package_finder(), CommandContextMixIn.enter_context(), SessionCommandMixin.get_default_session(), RequirementCommand.get_requirements(), Metadata.get_requirements(), i, RequirementCommand.make_requirement_preparer(), RequirementCommand.make_resolver(), RequirementCommand.trace_basic_info(), Command.verbosity, and RequirementPreparer.verbosity.

Here is the call graph for this function:

Field Documentation

◆ cmd_opts

cmd_opts

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

◆ parser

parser

Definition at line 97 of file wheel.py.

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

◆ usage

str usage

static

Initial value:

=  """
      %prog [options] <requirement specifier> ...
      %prog [options] -r <requirements file> ...
      %prog [options] [-e] <vcs project url> ...
      %prog [options] [-e] <local project path> ...
      %prog [options] <archive url/path> ..."""

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

Public Member Functions

Data Fields

Static Public Attributes

Additional Inherited Members