Skip to main content

Resolve abstract dependencies into concrete ones

Project description

ResolveLib at the highest level provides a Resolver class that includes dependency resolution logic. You give it some things, and a little information on how it should interact with them, and it will spit out a resolution result.

Intended Usage

import resolvelib

# Things I want to resolve.
requirements = [...]

# Implement logic so the resolver understands the requirement format.
class MyProvider:
    ...

provider = MyProvider()
reporter = resolvelib.BaseReporter()

# Create the (reusable) resolver.
resolver = resolvelib.Resolver(provider, reporter)

# Kick off the resolution process, and get the final result.
result = resolver.resolve(requirements)

The provider interface is specified in resolvelib.providers. You don’t need to inherit anything, however, only need to implement the right methods.

Terminology

The intention of this section is to unify the terms we use when talking about this code base, and packaging in general, to avoid confusion. Class and variable names in the code base should try to stick to terms defined here.

Things passed into Resolver.resolve() and provided by the provider are all considered opaque. They don’t need to adhere to this set of terminologies. Nothing can go wrong as long as the provider implementers can keep their heads straight.

Package

A thing that can be installed. A Package can have one or more versions available for installation.

Version

A string, usually in a number form, describing a snapshot of a Package. This number should increase when a Package posts a new snapshot, i.e a higher number means a more up-to-date snapshot.

Specifier

A collection of one or more Versions. This could be a wildcard, indicating that any Version is acceptable.

Candidate

A combination of a Package and a Version, i.e. a “concrete requirement”. Python people sometimes call this a “locked” or “pinned” dependency. Both of “requirement” and “dependency”, however, SHOULD NOT be used when describing a Candidate, to avoid confusion.

Some resolver architectures refer this as a “specification”, but it is not used here to avoid confusion with a Specifier.

Requirement

An intention to acquire a needed package, i.e. an “abstract requirement”. A “dependency”, if not clarified otherwise, also refers to this concept.

A Requirement should specify two things: a Package, and a Specifier.

Contributing

Please see developer documentation.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

resolvelib-1.2.1.tar.gz (24.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

resolvelib-1.2.1-py3-none-any.whl (18.7 kB view details)

Uploaded Python 3

File details

Details for the file resolvelib-1.2.1.tar.gz.

File metadata

  • Download URL: resolvelib-1.2.1.tar.gz
  • Upload date:
  • Size: 24.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for resolvelib-1.2.1.tar.gz
Algorithm Hash digest
SHA256 7d08a2022f6e16ce405d60b68c390f054efcfd0477d4b9bd019cc941c28fad1c
MD5 6ae59a4cbb332ddc695ea608e3c01e34
BLAKE2b-256 1d144669927e06631070edb968c78fdb6ce8992e27c9ab2cde4b3993e22ac7af

See more details on using hashes here.

Provenance

The following attestation bundles were made for resolvelib-1.2.1.tar.gz:

Publisher: release.yml on sarugaku/resolvelib

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file resolvelib-1.2.1-py3-none-any.whl.

File metadata

  • Download URL: resolvelib-1.2.1-py3-none-any.whl
  • Upload date:
  • Size: 18.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for resolvelib-1.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 fb06b66c8da04172d9e72a21d7d06186d8919e32ae5ab5cdf5b9d920be805ac2
MD5 8dace661c3ed0d532a091d9d69d27ab5
BLAKE2b-256 e223c941a0d0353681ca138489983c4309e0f5095dfd902e1357004f2357ddf2

See more details on using hashes here.

Provenance

The following attestation bundles were made for resolvelib-1.2.1-py3-none-any.whl:

Publisher: release.yml on sarugaku/resolvelib

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page