pipenv の API リファレンス

pipenv (pypa/pipenv) の公開 API 265 件 —— クラス 79、関数 110、メソッド 76。実際のソースを静的解析して抽出した正確なシグネチャを掲載しています。

リポジトリ: pypa/pipenv

種別	件数
クラス	79
関数	110
メソッド	76

API 一覧

funcpipenv.cli.command.cli()

Main argparse-based entry point for pipenv.

classpipenv.cmdparse.Script

Parse a script line (in Pipfile's [scripts] section).

methodpipenv.cmdparse.Script.cmdify()

Encode into a cmd-executable string.

methodpipenv.cmdparse.Script.extend(extra_args)

Append *extra_args* to the script.

methodpipenv.environment.Environment.find_egg(egg_dist:importlib_metadata.Distribution) -> str

Find an egg by name in the given environment

methodpipenv.environment.Environment.python() -> str

Path to the environment python

methodpipenv.environment.Environment.script_basedir() -> str

Path to the environment scripts dir

classpipenv.environments.Setting

Control various settings of pipenv via environment variables.

funcpipenv.exceptions.unstyle(text:str) -> str

Remove all styles from the given text.

methodpipenv.installers.Version.cmpkey()

Make the version a comparable tuple.

classpipenv.patched.pip._internal.build_env.NoOpBuildEnvironment

A no-op drop-in replacement for BuildEnvironment

methodpipenv.patched.pip._internal.cache.Cache.get(link:Link, package_name:str | None, supported_tags:list[Tag]) -> Link

Returns a link to a cached item if it exists, otherwise returns the passed link.

methodpipenv.patched.pip._internal.cache.Cache.get_path_for_link(link:Link) -> str

Return a directory to store cached items in for link.

classpipenv.patched.pip._internal.cache.SimpleWheelCache

A cache of wheels for future installs.

funcpipenv.patched.pip._internal.cli.cmdoptions.check_build_constraints(options:Values) -> None

Function for validating build constraints options.

funcpipenv.patched.pip._internal.cli.cmdoptions.raise_option_error(parser:OptionParser, option:Option, msg:str) -> None

Raise an option parsing error using parser.error().

methodpipenv.patched.pip._internal.cli.index_command.SessionCommandMixin.get_default_session(options:Values) -> PipSession

Get a default-managed session.

classpipenv.patched.pip._internal.cli.parser.PrettyHelpFormatter

A prettier/less verbose help formatter for optparse.

methodpipenv.patched.pip._internal.cli.parser.PrettyHelpFormatter.format_option(option:optparse.Option) -> str

Overridden method with Rich support.

classpipenv.patched.pip._internal.cli.parser.UpdatingDefaultsHelpFormatter

Custom help formatter for use in ConfigOptionParser.

classpipenv.patched.pip._internal.commands.cache.CacheCommand

Inspect and manage pip's wheel cache.

classpipenv.patched.pip._internal.commands.check.CheckCommand

Verify installed packages have compatible dependencies.

classpipenv.patched.pip._internal.commands.completion.CompletionCommand

A helper command to be used for command completion.

methodpipenv.patched.pip._internal.commands.completion.CompletionCommand.run(options:Values, args:list[str]) -> int

Prints the completion code of the given shell

classpipenv.patched.pip._internal.commands.configuration.ConfigurationCommand

Manage local and global configuration.

method

pipenv.patched.pip._internal.commands.configuration.ConfigurationCommand.print_config_file_values(variant:Kind, fname:str) -> None

Get key-value pairs from the file of a variant

funcpipenv.patched.pip._internal.commands.create_command(name:str, **kwargs:Any) -> Command

Create an instance of the Command class with the given name.

classpipenv.patched.pip._internal.commands.debug.DebugCommand

Display debug information.

classpipenv.patched.pip._internal.commands.freeze.FreezeCommand

Output installed packages in requirements format.

funcpipenv.patched.pip._internal.commands.get_similar_commands(name:str) -> str | None

Command name auto-correct.

classpipenv.patched.pip._internal.commands.hash.HashCommand

Compute a hash of a local package archive.

classpipenv.patched.pip._internal.commands.help.HelpCommand

Show help for commands

classpipenv.patched.pip._internal.commands.index.IndexCommand

Inspect information available from package indexes.

classpipenv.patched.pip._internal.commands.list.ListCommand

List installed packages, including editables.

funcpipenv.patched.pip._internal.commands.search.transform_hits(hits:list[dict[str, str]]) -> list[TransformedHit]

The list from pypi is really a list of versions.

classpipenv.patched.pip._internal.commands.show.ShowCommand

Show information about one or more installed packages.

funcpipenv.patched.pip._internal.commands.show.search_packages_info(query:list[str]) -> Generator[_PackageInfo, None, None]

Gather details from installed distributions.

classpipenv.patched.pip._internal.commands.uninstall.UninstallCommand

Uninstall packages.

classpipenv.patched.pip._internal.configuration.Configuration

Handles management of configuration.

methodpipenv.patched.pip._internal.configuration.Configuration.get_value(key:str) -> Any

Get a value from the configuration.

methodpipenv.patched.pip._internal.configuration.Configuration.get_values_in_config(variant:Kind) -> dict[str, Any]

Get values present in a config file

methodpipenv.patched.pip._internal.configuration.Configuration.save() -> None

Save the current in-memory state.

methodpipenv.patched.pip._internal.configuration.Configuration.set_value(key:str, value:Any) -> None

Modify a value in the configuration.

methodpipenv.patched.pip._internal.configuration.Configuration.unset_value(key:str) -> None

Unset a value in the configuration.

classpipenv.patched.pip._internal.distributions.base.AbstractDistribution

A base class for handling installable artifacts.

classpipenv.patched.pip._internal.distributions.installed.InstalledDistribution

Represents an installed package.

classpipenv.patched.pip._internal.distributions.sdist.SourceDistribution

Represents a source distribution.

classpipenv.patched.pip._internal.distributions.wheel.WheelDistribution

Represents a wheel distribution.

classpipenv.patched.pip._internal.exceptions.BadCommand

Raised when virtualenv or a command is not found

classpipenv.patched.pip._internal.exceptions.BuildDependencyInstallError

Raised when build dependencies cannot be installed.

classpipenv.patched.pip._internal.exceptions.CommandError

Raised when there is an error in command-line arguments

classpipenv.patched.pip._internal.exceptions.ConfigurationError

General exception in configuration

classpipenv.patched.pip._internal.exceptions.ExternallyManagedEnvironment

The current environment is externally managed.

classpipenv.patched.pip._internal.exceptions.FailedToPrepareCandidate

Raised when we fail to prepare a candidate (i.e.

classpipenv.patched.pip._internal.exceptions.HashMismatch

Distribution file hash values don't match.

classpipenv.patched.pip._internal.exceptions.HashMissing

A hash was needed for a requirement but is absent.

classpipenv.patched.pip._internal.exceptions.InstallationError

General exception during installation

classpipenv.patched.pip._internal.exceptions.InstallationSubprocessError

A subprocess call failed.

classpipenv.patched.pip._internal.exceptions.InvalidWheel

Invalid (e.g.

classpipenv.patched.pip._internal.exceptions.InvalidWheelFilename

Invalid wheel filename.

classpipenv.patched.pip._internal.exceptions.MetadataInconsistent

Built metadata contains inconsistent information.

classpipenv.patched.pip._internal.exceptions.MetadataInvalid

Metadata is invalid.

classpipenv.patched.pip._internal.exceptions.NetworkConnectionError

HTTP connection error

classpipenv.patched.pip._internal.exceptions.PipError

The base pip error.

classpipenv.patched.pip._internal.exceptions.UnsupportedWheel

Unsupported wheel.

classpipenv.patched.pip._internal.index.collector.IndexContent

Represents one response (or page), along with its URL.

classpipenv.patched.pip._internal.index.package_finder.PackageFinder

This finds packages.

funcpipenv.patched.pip._internal.locations.base.change_root(new_root:str, pathname:str) -> str

Return 'pathname' with 'new_root' prepended.

funcpipenv.patched.pip._internal.locations.get_platlib() -> str

Return the default platform-shared lib location.

funcpipenv.patched.pip._internal.locations.get_purelib() -> str

Return the default pure-Python lib location.

funcpipenv.patched.pip._internal.metadata._json.msg_to_json(msg:Message) -> dict[str, Any]

Convert a Message object into a JSON-compatible dictionary.

methodpipenv.patched.pip._internal.metadata.base.BaseDistribution.direct_url() -> DirectUrl | None

Obtain a DirectUrl from this distribution.

methodpipenv.patched.pip._internal.metadata.base.BaseDistribution.from_directory(directory:str) -> BaseDistribution

Load the distribution from a metadata directory.

methodpipenv.patched.pip._internal.metadata.base.BaseDistribution.from_wheel(wheel:Wheel, name:str) -> BaseDistribution

Load the distribution from a given wheel.

methodpipenv.patched.pip._internal.metadata.base.BaseDistribution.installed_location() -> str | None

The distribution's "installed" location.

methodpipenv.patched.pip._internal.metadata.base.BaseDistribution.is_file(path:InfoPath) -> bool

Check whether an entry in the info directory is a file.

method

pipenv.patched.pip._internal.metadata.base.BaseDistribution.iter_dependencies(extras:Collection[str]=()) -> Iterable[Requirement]

Dependencies of this distribution.

methodpipenv.patched.pip._internal.metadata.base.BaseDistribution.iter_provided_extras() -> Iterable[NormalizedName]

Extras provided by this distribution.

methodpipenv.patched.pip._internal.metadata.base.BaseDistribution.iter_raw_dependencies() -> Iterable[str]

Raw Requires-Dist metadata.

methodpipenv.patched.pip._internal.metadata.base.BaseDistribution.location() -> str | None

Where the distribution is loaded from.

methodpipenv.patched.pip._internal.metadata.base.BaseDistribution.metadata() -> email.message.Message

Metadata of distribution parsed from e.g.

methodpipenv.patched.pip._internal.metadata.base.BaseDistribution.raw_name() -> str

Value of "Name:" in distribution metadata.

methodpipenv.patched.pip._internal.metadata.base.BaseDistribution.read_text(path:InfoPath) -> str

Read a file in the info directory.

classpipenv.patched.pip._internal.metadata.base.BaseEnvironment

An environment containing distributions to introspect.

classpipenv.patched.pip._internal.metadata.importlib._compat.BasePath

A protocol that various path objects conform.

func

pipenv.patched.pip._internal.metadata.importlib._compat.get_dist_canonical_name(dist:importlib.metadata.Distribution) -> NormalizedName

Get the distribution's normalized name.

classpipenv.patched.pip._internal.models.candidate.InstallationCandidate

Represents a potential "candidate" for installation.

classpipenv.patched.pip._internal.models.link.Link

Represents a parsed link from a Package Index's simple URL

methodpipenv.patched.pip._internal.models.link.Link.netloc() -> str

This can contain auth information.

classpipenv.patched.pip._internal.models.link.LinkHash

Links to content may have embedded hash values.

methodpipenv.patched.pip._internal.models.link.LinkHash.is_hash_allowed(hashes:Hashes | None) -> bool

Return True if the current hash is allowed by `hashes`.

classpipenv.patched.pip._internal.models.wheel.Wheel

A wheel file

classpipenv.patched.pip._internal.network.auth.KeyRingBaseProvider

Keyring base provider interface

classpipenv.patched.pip._internal.network.auth.KeyRingNullProvider

Keyring null provider

classpipenv.patched.pip._internal.network.lazy_wheel.LazyZipOverHTTP

File-like object mapped to a ZIP file over HTTP.

methodpipenv.patched.pip._internal.network.lazy_wheel.LazyZipOverHTTP.close() -> None

Close the file.

methodpipenv.patched.pip._internal.network.lazy_wheel.LazyZipOverHTTP.closed() -> bool

Whether the file is closed.

methodpipenv.patched.pip._internal.network.lazy_wheel.LazyZipOverHTTP.mode() -> str

Opening mode, which is always rb.

methodpipenv.patched.pip._internal.network.lazy_wheel.LazyZipOverHTTP.name() -> str

Path to the underlying file.

methodpipenv.patched.pip._internal.network.lazy_wheel.LazyZipOverHTTP.read(size:int=-1) -> bytes

Read up to size bytes from the object and return them.

methodpipenv.patched.pip._internal.network.lazy_wheel.LazyZipOverHTTP.tell() -> int

Return the current position.

methodpipenv.patched.pip._internal.network.lazy_wheel.LazyZipOverHTTP.truncate(size:int | None=None) -> int

Resize the stream to the given size in bytes.

methodpipenv.patched.pip._internal.network.lazy_wheel.LazyZipOverHTTP.writable() -> bool

Return False.

funcpipenv.patched.pip._internal.network.session.looks_like_ci() -> bool

Return whether it looks like pip is running under CI.

funcpipenv.patched.pip._internal.network.session.user_agent() -> str

Return a string representing the user agent.

funcpipenv.patched.pip._internal.operations.install.wheel.pyc_output_path(path:str) -> str

Return the path the pyc file would have been written to.

classpipenv.patched.pip._internal.operations.prepare.RequirementPreparer

Prepares a Requirement

method

pipenv.patched.pip._internal.operations.prepare.RequirementPreparer.prepare_editable_requirement(req:InstallRequirement) -> BaseDistribution

Prepare an editable requirement.

func

pipenv.patched.pip._internal.operations.prepare.get_file_url(link:Link, download_dir:str | None=None, hashes:Hashes | None=None) -> File

Get file and optionally check its hash.

func

pipenv.patched.pip._internal.pyproject.load_pyproject_toml(pyproject_toml:str, setup_py:str, req_name:str) -> BuildSystemDetails

Load the pyproject.toml file.

funcpipenv.patched.pip._internal.req.constructors.check_first_requirement_in_file(filename:str) -> None

Check if file is parsable as a requirements file.

funcpipenv.patched.pip._internal.req.req_file.break_args_options(line:str) -> tuple[str, str]

Break up the line into an args and options string.

funcpipenv.patched.pip._internal.req.req_file.build_parser() -> optparse.OptionParser

Return a parser for parsing requirement lines

funcpipenv.patched.pip._internal.req.req_file.ignore_comments(lines_enum:ReqFileLines) -> ReqFileLines

Strips comments and filter empty lines.

method

pipenv.patched.pip._internal.resolution.legacy.resolver.Resolver.get_installation_order(req_set:RequirementSet) -> list[InstallRequirement]

Create the installation order.

methodpipenv.patched.pip._internal.resolution.resolvelib.base.Candidate.project_name() -> NormalizedName

The "project name" of the candidate.

methodpipenv.patched.pip._internal.resolution.resolvelib.base.Requirement.project_name() -> NormalizedName

The "project name" of a requirement.

func

pipenv.patched.pip._internal.resolution.resolvelib.candidates.as_base_candidate(candidate:Candidate) -> BaseCandidate | None

The runtime version of BaseCandidate.

method

pipenv.patched.pip._internal.resolution.resolvelib.factory.Factory.get_wheel_cache_entry(link:Link, name:str | None) -> CacheEntry | None

Look up the link in the wheel cache.

classpipenv.patched.pip._internal.resolution.resolvelib.provider.PipProvider

Pip's provider implementation for resolvelib.

classpipenv.patched.pip._internal.resolution.resolvelib.requirements.UnsatisfiableRequirement

A requirement that cannot be satisfied.

funcpipenv.patched.pip._internal.utils._jaraco_text.drop_comment(line)

Drop comments.

funcpipenv.patched.pip._internal.utils._log.getLogger(name:str) -> VerboseLogger

logging.getLogger, but ensures our VerboseLogger class is returned

funcpipenv.patched.pip._internal.utils._log.init_logging() -> None

funcpipenv.patched.pip._internal.utils.compat.get_path_uid(path:str) -> int

Return path's uid.

funcpipenv.patched.pip._internal.utils.datetime.parse_iso_datetime(isodate:str) -> datetime.datetime

Convert an ISO format string to a datetime.

func

pipenv.patched.pip._internal.utils.direct_url_helpers.direct_url_as_pep440_direct_reference(direct_url:DirectUrl, name:str) -> str

Convert a DirectUrl to a pip requirement string.

funcpipenv.patched.pip._internal.utils.filetypes.is_archive_file(name:str) -> bool

Return True if `name` is a considered as an archive file.

funcpipenv.patched.pip._internal.utils.logging.capture_logging() -> Generator[StringIO, None, None]

Capture all pip logs in a buffer temporarily.

funcpipenv.patched.pip._internal.utils.misc.ask(message:str, options:Iterable[str]) -> str

Ask the message interactively, with the given possible responses

funcpipenv.patched.pip._internal.utils.misc.ask_input(message:str) -> str

Ask for input interactively.

funcpipenv.patched.pip._internal.utils.misc.ask_password(message:str) -> str

Ask for a password interactively.

funcpipenv.patched.pip._internal.utils.misc.build_netloc(host:str, port:int | None) -> str

Build a netloc from a host-port pair

funcpipenv.patched.pip._internal.utils.misc.build_url_from_netloc(netloc:str, scheme:str='https') -> str

Build a full URL from a netloc.

funcpipenv.patched.pip._internal.utils.misc.ensure_dir(path:str) -> None

os.path.makedirs without EEXIST.

funcpipenv.patched.pip._internal.utils.misc.hash_file(path:str, blocksize:int=1 << 20) -> tuple[Any, int]

Return (hash, length) for path using hashlib.sha256()

funcpipenv.patched.pip._internal.utils.misc.is_console_interactive() -> bool

Is this console interactive?

funcpipenv.patched.pip._internal.utils.misc.is_installable_dir(path:str) -> bool

Is path is a directory containing pyproject.toml or setup.py?

funcpipenv.patched.pip._internal.utils.misc.pairwise(iterable:Iterable[Any]) -> Iterator[tuple[Any, Any]]

Return paired elements.

funcpipenv.patched.pip._internal.utils.misc.parse_netloc(netloc:str) -> tuple[str | None, int | None]

Return the host-port pair from a netloc.

func

pipenv.patched.pip._internal.utils.misc.read_chunks(file:BinaryIO, size:int=FILE_CHUNK_SIZE) -> Generator[bytes, None, None]

Yield pieces of data from a file-like object until EOF.

funcpipenv.patched.pip._internal.utils.misc.redact_auth_from_requirement(req:Requirement) -> str

Replace the password in a given requirement url with ****.

funcpipenv.patched.pip._internal.utils.misc.redact_auth_from_url(url:str) -> str

Replace the password in a given url with ****.

funcpipenv.patched.pip._internal.utils.misc.redact_netloc(netloc:str) -> str

Replace the sensitive data in a netloc with "****", if it exists.

funcpipenv.patched.pip._internal.utils.misc.remove_auth_from_url(url:str) -> str

Return a copy of url with 'username:password@' removed.

funcpipenv.patched.pip._internal.utils.misc.renames(old:str, new:str) -> None

Like os.renames(), but handles renaming across devices.

funcpipenv.patched.pip._internal.utils.misc.split_auth_from_netloc(netloc:str) -> NetlocTuple

Parse out and remove the auth information from a netloc.

funcpipenv.patched.pip._internal.utils.misc.splitext(path:str) -> tuple[str, str]

Like os.path.splitext, but take off .tar too

funcpipenv.patched.pip._internal.utils.misc.strtobool(val:str) -> int

Convert a string representation of truth to true (1) or false (0).

funcpipenv.patched.pip._internal.utils.misc.warn_if_run_as_root() -> None

Output a warning for sudo users on Unix.

funcpipenv.patched.pip._internal.utils.packaging.get_requirement(req_string:str) -> Requirement

Construct a packaging.Requirement object with caching

funcpipenv.patched.pip._internal.utils.subprocess.format_command_args(args:list[str] | CommandArgs) -> str

Format command arguments for display.

funcpipenv.patched.pip._internal.utils.subprocess.make_command(*args:str | HiddenText | CommandArgs) -> CommandArgs

Create a CommandArgs object.

funcpipenv.patched.pip._internal.utils.subprocess.reveal_command_args(args:list[str] | CommandArgs) -> list[str]

Return the arguments in their raw, unredacted form.

func

pipenv.patched.pip._internal.utils.temp_dir.TempDirectory.onerror(func:Callable[..., Any], path:Path, exc_val:BaseException) -> None

Log a warning for a `rmtree` error and continue

classpipenv.patched.pip._internal.utils.temp_dir.TempDirectoryTypeRegistry

Manages temp directory behavior

func

pipenv.patched.pip._internal.utils.unpacking.unpack_file(filename:str, location:str, content_type:str | None=None) -> None

Unpack ``filename`` into ``location``.

funcpipenv.patched.pip._internal.utils.urls.path_to_url(path:str) -> str

Convert a path to a file: URL.

funcpipenv.patched.pip._internal.utils.urls.url_to_path(url:str) -> str

Convert a file: URL to a path.

funcpipenv.patched.pip._internal.utils.wheel.wheel_dist_info_dir(source:ZipFile, name:str) -> str

Returns the name of the contained .dist-info directory.

funcpipenv.patched.pip._internal.utils.wheel.wheel_version(wheel_data:Message) -> tuple[int, ...]

Given WHEEL metadata, return the parsed Wheel-Version.

methodpipenv.patched.pip._internal.vcs.git.Git.get_remote_url(location:str) -> str

Return URL of the first remote encountered.

funcpipenv.patched.pip._internal.vcs.versioncontrol.is_url(name:str) -> bool

Return true if the name looks like a URL.

func

pipenv.patched.pip._internal.vcs.versioncontrol.make_vcs_requirement_url(repo_url:str, rev:str, project_name:str, subdir:str | None=None) -> str

Return the URL for a VCS requirement.

func

pipenv.patched.pip._internal.wheel_builder.build(requirements:Iterable[InstallRequirement], wheel_cache:WheelCache, verify:bool) -> BuildResult

Build wheels.

funcpipenv.patched.pip.main(args:list[str] | None=None) -> int

This is an internal API only meant for use by pip's own console scripts.

classpipenv.project.Project

docstring for Project

methodpipenv.project.Project.all_packages()

Returns a list of all packages.

methodpipenv.project.Project.dev_packages()

Returns a list of dev-packages.

methodpipenv.project.Project.packages()

Returns a list of packages.

methodpipenv.project.Project.parsed_pipfile() -> tomlkit.toml_document.TOMLDocument | TPipfile

Parse Pipfile into a TOMLFile

methodpipenv.project.Project.path_to(p:str) -> Path

Returns the absolute path to a given relative path.

methodpipenv.project.Project.pylock_output_path() -> str

Returns the path where pylock.toml should be written.

methodpipenv.project.Project.register_proper_name(name:str) -> None

Registers a proper name to the database.

methodpipenv.project.Project.settings() -> Settings

The ``Settings`` subsystem (Initiative D, T_D.3).

methodpipenv.project.Project.sources() -> Sources

The ``Sources`` subsystem (Initiative D, T_D.2).

methodpipenv.project.Project.venv_locator() -> VenvLocator

The ``VenvLocator`` subsystem (Initiative D, T_D.4).

methodpipenv.project.Project.write_lockfile(content)

Write out the lockfile.

methodpipenv.project.Project.write_toml(data, path=None)

Writes the given data structure out as TOML.

funcpipenv.resolver.main.main(argv=None) -> int

Console-script entry point.

classpipenv.resolver.schema.ConflictRecord

One row of pip's 'The conflict is caused by' table.

classpipenv.resolver.schema.Diagnostics

Side-channel info: warnings, timing, source-substitution log.

classpipenv.resolver.schema.LockedRequirement

The canonical lockfile-entry shape (design §3.3).

methodpipenv.resolver.schema.LockedRequirement.from_lockfile_dict(data:Mapping[str, Any]) -> LockedRequirement

Inverse of :meth:`to_lockfile_dict`.

methodpipenv.resolver.schema.LockedRequirement.to_json_dict() -> dict

Return a deterministic JSON-ready dict.

classpipenv.resolver.schema.PackageSpecs

Typed replacement for the legacy constraints-tempfile format.

classpipenv.resolver.schema.RequestMetadata

Caller-side context for the resolver request.

classpipenv.resolver.schema.ResolutionError

The dependency set has no satisfying solution.

classpipenv.resolver.schema.ResolverOptions

Boolean / verbosity options that today are argv flags.

classpipenv.resolver.schema.ResolverRequest

The single input to a pipenv-resolver subprocess invocation.

classpipenv.resolver.schema.ResolverSuccess

Resolution completed; lockfile entries follow.

classpipenv.resolver.schema.Source

One Pipfile ``[[source]]`` block, post-mirror-substitution.

classpipenv.resolver.schema.VCSPin

VCS pin: backend + URL + ref + optional subdirectory.

funcpipenv.routines.audit.install_pip_audit(project, system=False)

Install pip-audit.

funcpipenv.routines.clean.ensure_lockfile(project, pypi_mirror=None)

Ensures that a lockfile exists.

classpipenv.routines.context.ExecutionOptions

How to run a routine: passthrough flags, output, paths.

classpipenv.routines.context.InstallPolicy

Flags governing install / lock behaviour.

classpipenv.routines.context.PackageSelection

Which packages a routine should act on.

classpipenv.routines.context.RoutineContext

Top-level routine context.

classpipenv.routines.context.TargetEnv

Which Python and where to install.

funcpipenv.routines.install.do_install(project, ctx:RoutineContext) -> None

Install user-requested packages and/or apply the Pipfile.

funcpipenv.routines.install.do_install_dependencies(project, ctx:RoutineContext, requirements_dir)

Executes the installation functionality.

funcpipenv.routines.install.handle_lockfile(project, ctx:RoutineContext)

Handle the lockfile, updating if necessary.

funcpipenv.routines.install.handle_missing_lockfile(project, ctx:RoutineContext)

Handle a missing lockfile by creating one.

funcpipenv.routines.install.handle_outdated_lockfile(project, ctx:RoutineContext, *old_hash, *new_hash)

Handle an outdated lockfile.

funcpipenv.routines.lock.do_lock(project, ctx:RoutineContext)

Executes the freeze functionality.

funcpipenv.routines.scan.run_safety_scan(cmd, quiet)

Run safety scan with the given command.

funcpipenv.routines.uninstall.do_uninstall(project:Project, ctx:RoutineContext)

Uninstall packages from the project.

funcpipenv.routines.update.do_update(project, ctx:RoutineContext)

Update the virtualenv.

funcpipenv.routines.update.get_reverse_dependencies(project) -> Dict[str, Set[Tuple[str, str]]]

Get reverse dependencies using pipdeptree.

funcpipenv.utils.dependencies.as_pipfile(dep:InstallRequirement) -> Dict[str, Any]

Create a pipfile entry for the given InstallRequirement.

funcpipenv.utils.dependencies.expand_env_variables(line) -> AnyStr

Expand the env vars in a line following pip's standard.

funcpipenv.utils.dependencies.handle_non_vcs_requirement(name:str, _pipfile:Dict[str, Any], extras_str:str) -> str

Helper function to handle non-VCS requirements.

funcpipenv.utils.dependencies.parse_metadata_file(content:str)

Parse a METADATA file to get the package name.

funcpipenv.utils.dependencies.parse_pkginfo_file(content:str)

Parse a PKG-INFO file to get the package name.

funcpipenv.utils.dependencies.pep440_version(version)

Normalize version to PEP 440 standards

funcpipenv.utils.display.format_help(help)

Formats the help string.

funcpipenv.utils.environment.load_dot_env(project, as_dict=False, quiet=False)

Loads .env file into sys.environ.

funcpipenv.utils.fileutils.create_tracked_tempdir(*args:Any, **kwargs:Any) -> Path

Create a tracked temporary directory.

funcpipenv.utils.fileutils.is_file_url(url:Any) -> bool

Returns true if the given url is a file url.

funcpipenv.utils.fileutils.normalize_path(path:str) -> str

Return a case-normalized absolute variable-expanded path.

funcpipenv.utils.fileutils.open_file(link, session:Optional[PipSession]=None, stream:bool=False)

Open local or remote file for reading.

funcpipenv.utils.fileutils.url_to_path(url:str) -> Path

Convert a valid file url to a local filesystem path.

funcpipenv.utils.funktools.chunked(n:int, iterable:Iterable) -> Iterable

Split an iterable into lists of length *n*.

funcpipenv.utils.funktools.handle_remove_readonly(func, path, exc)

Error handler for shutil.rmtree.

funcpipenv.utils.funktools.is_readonly_path(fn:os.PathLike) -> bool

Check if a provided path exists and is readonly.

funcpipenv.utils.funktools.set_write_bit(fn:str) -> None

Set read-write permissions for the current user on the target path.

funcpipenv.utils.funktools.take(n:int, iterable:Iterable) -> Iterable

Take n elements from the supplied iterable without consuming it.

funcpipenv.utils.funktools.unnest(elem:Iterable) -> Any

Flatten an arbitrarily nested iterable.

funcpipenv.utils.internet.get_requests_session(max_retries=1, verify_ssl=True, cache_dir=USER_CACHE_DIR, source=None)

Load requests lazily.

funcpipenv.utils.internet.is_valid_url(url)

Checks if a given string is an url

funcpipenv.utils.locking.atomic_open_for_write(target, binary=False, newline=None, encoding=None) -> None

Atomically open `target` for writing.

classpipenv.utils.pylock.PylockError

Base exception for pylock.toml related errors.

classpipenv.utils.pylock.PylockFile

Represents a pylock.toml file as specified in PEP 751.

methodpipenv.utils.pylock.PylockFile.created_by() -> str

Get the created-by value.

methodpipenv.utils.pylock.PylockFile.default_groups() -> List[str]

Get the default-groups list.

methodpipenv.utils.pylock.PylockFile.dependency_groups() -> List[str]

Get the dependency-groups list.

methodpipenv.utils.pylock.PylockFile.environments() -> List[str]

Get the environments list.

methodpipenv.utils.pylock.PylockFile.extras() -> List[str]

Get the extras list.

method

pipenv.utils.pylock.PylockFile.from_lockfile(lockfile_path:Union[str, Path], pylock_path:Union[str, Path]=None, dev_groups:Optional[List[str]]=None) -> 'PylockFile'

Create a PylockFile from a Pipfile.lock file.

methodpipenv.utils.pylock.PylockFile.from_path(path:Union[str, Path]) -> 'PylockFile'

Load a pylock.toml file from the given path.

methodpipenv.utils.pylock.PylockFile.lock_version() -> str

Get the lock-version.

methodpipenv.utils.pylock.PylockFile.packages() -> List[Dict[str, Any]]

Get the packages list.

methodpipenv.utils.pylock.PylockFile.requires_python() -> Optional[str]

Get the requires-python value.

methodpipenv.utils.pylock.PylockFile.tool() -> Dict[str, Any]

Get the tool table.

methodpipenv.utils.pylock.PylockFile.write() -> None

Write the pylock.toml file to disk.

classpipenv.utils.pylock.PylockFormatError

Raised when the pylock.toml file format is invalid.

classpipenv.utils.pylock.PylockVersionError

Raised when the lock-version is not supported.

funcpipenv.utils.pylock.find_pylock_file(directory:Union[str, Path]=None) -> Optional[Path]

Find a pylock.toml file in the given directory.

funcpipenv.utils.requirements.redact_auth_from_url(url:str) -> str

Replace the password in a given url with ****.

func

pipenv.utils.requirementslib.get_http_url(link:Link, download:Downloader, download_dir:Optional[str]=None, hashes:Optional[Hashes]=None) -> File

Download a file from an HTTP URL.

methodpipenv.utils.resolver.Resolver.constraints()

Get all applicable constraints.

funcpipenv.utils.resolver.read_stdout()

Read all stdout data in chunks.

classpipenv.utils.settings.Settings

``[pipenv]`` configuration subsystem of :class:`Project`.

methodpipenv.utils.settings.Settings.update(d:dict[str, Any]) -> None

Persist new keys from ``d`` into the ``[pipenv]`` table.

methodpipenv.utils.settings.Settings.use_pylock() -> bool

Returns True if pylock.toml should be generated.

funcpipenv.utils.shell.handle_remove_readonly(func, path, exc)

Error handler for shutil.rmtree.

funcpipenv.utils.shell.system_which(command, path=None)

Emulates the system's which.

classpipenv.utils.sources.SourceNotFound

Raised by :meth:`Sources.get_source` when no source matches.

classpipenv.utils.sources.Sources

Indexes / [[source]] subsystem of :class:`Project`.

methodpipenv.utils.sources.Sources.all()

The active source list.

methodpipenv.utils.sources.Sources.find_source(source)

Given a source, find it.

funcpipenv.utils.toml.convert_toml_outline_tables(parsed:TOMLDocument, project) -> TOMLDocument

Converts all outline tables to inline tables.

funcpipenv.utils.virtualenv.do_create_virtualenv(project, python=None, site_packages=None, pypi_mirror=None)

Creates a virtualenv.

funcpipenv.utils.virtualenv.do_where(project, virtualenv=False, bare=True)

Executes the where functionality.

この情報について

掲載しているシグネチャは pypa/pipenv の公開ソースコードを Python の ast モジュールで静的解析し、引数名・デフォルト値・型注釈・戻り値型をそのまま抽出したものです。実装コードは保存していません。詳しくは仕組みの解説をご覧ください。

収録ライブラリ一覧（全 805 件）へ戻る