Skip to content

Client#

AuthenticationMiddleware #

__repr__() #

Returns a representation of the Middleware

Examples#
>>> from rattler.networking import Client
>>> middleware = AuthenticationMiddleware()
>>> middleware
AuthenticationMiddleware()
>>> Client([middleware])
Client()
>>>

Client #

A client that can be used to make requests.

__repr__() #

Returns a representation of the Client

Examples#
>>> Client()
Client()
>>>

authenticated_client() staticmethod #

Returns an authenticated client.

Examples#
>>> Client.authenticated_client()
Client()
>>>

MirrorMiddleware #

__init__(mirrors) #

Create a new MirrorMiddleware instance. The mirrors argument should be a dictionary where the keys are the original mirror URLs and the values are lists of mirror URLs to replace the original mirror with.

Examples#
>>> from rattler.networking import Client
>>> middleware = MirrorMiddleware({"https://conda.anaconda.org/conda-forge": ["https://repo.prefix.dev/conda-forge"]})
>>> middleware
MirrorMiddleware()
>>> Client([middleware])
Client()
>>>

__repr__() #

Returns a representation of the Middleware

Examples#
>>> middleware = MirrorMiddleware({"https://conda.anaconda.org/conda-forge": ["https://repo.prefix.dev/conda-forge"]})
>>> middleware
MirrorMiddleware()
>>>

fetch_repo_data(*, channels, platforms, cache_path, callback, client=None) async #

Returns a list of RepoData for given channels and platform.

Parameters:

Name Type Description Default
channels List[Channel]

A list of Channels to fetch repo data.

required
platforms List[Platform]

A list of Platforms for which the repo data should be fetched.

required
cache_path Union[str, PathLike[str]]

A os.PathLike[str] where the repo data should be downloaded.

required
callback Optional[Callable[[int, int], None]]

A Callable[[int, int], None] to report the download progress of repo data.

required
client Optional[Client]

A Client to use for fetching the repo data.

None

Returns:

Type Description
List[SparseRepoData]

A list of SparseRepoData for requested channels and platforms.