$TXg0dZddlmZddlmZddlZer"ddlmZddlm Z m Z m Z m Z m Z mZmZmZmZmZmZmZdZ ej,eZ ej0eZ Gd d Zy) z Pluggy hook specifications ("hookspecs") to register conda plugins. Each hookspec defined in :class:`~conda.plugins.hookspec.CondaSpecs` contains an example of how to use it. ) annotations) TYPE_CHECKINGN)Iterable) CondaAuthHandlerCondaHealthCheckCondaPostCommandCondaPostSolveCondaPreCommand CondaPreSolveCondaReporterBackendCondaRequestHeader CondaSetting CondaSolverCondaSubcommandCondaVirtualPackagecondaceZdZdZeddZeddZeddZeddZeddZ eddZ eddZ edd Z edd Z edd Zedd Zedd Ze ddZy) CondaSpecsz5The conda plugin hookspecs, to be used by developers.cy)a Register solvers in conda. **Example:** .. code-block:: python import logging from conda import plugins from conda.core import solve log = logging.getLogger(__name__) class VerboseSolver(solve.Solver): def solve_final_state(self, *args, **kwargs): log.info("My verbose solver!") return super().solve_final_state(*args, **kwargs) @plugins.hookimpl def conda_solvers(): yield plugins.CondaSolver( name="verbose-classic", backend=VerboseSolver, ) :return: An iterable of solver entries. Nselfs 6lib/python3.12/site-packages/conda/plugins/hookspec.py conda_solverszCondaSpecs.conda_solvers4cy)a. Register external subcommands in conda. **Example:** .. code-block:: python from conda import plugins def example_command(args): print("This is an example command!") @plugins.hookimpl def conda_subcommands(): yield plugins.CondaSubcommand( name="example", summary="example command", action=example_command, ) :return: An iterable of subcommand entries. Nrrs rconda_subcommandszCondaSpecs.conda_subcommandsUrrcy)a Register virtual packages in Conda. **Example:** .. code-block:: python from conda import plugins @plugins.hookimpl def conda_virtual_packages(): yield plugins.CondaVirtualPackage( name="my_custom_os", version="1.2.3", build="x86_64", ) :return: An iterable of virtual package entries. Nrrs rconda_virtual_packagesz!CondaSpecs.conda_virtual_packagesprrcy)a Register pre-command functions in conda. **Example:** .. code-block:: python from conda import plugins def example_pre_command(command): print("pre-command action") @plugins.hookimpl def conda_pre_commands(): yield plugins.CondaPreCommand( name="example-pre-command", action=example_pre_command, run_for={"install", "create"}, ) Nrrs rconda_pre_commandszCondaSpecs.conda_pre_commandsrrcy)a  Register post-command functions in conda. **Example:** .. code-block:: python from conda import plugins def example_post_command(command): print("post-command action") @plugins.hookimpl def conda_post_commands(): yield plugins.CondaPostCommand( name="example-post-command", action=example_post_command, run_for={"install", "create"}, ) Nrrs rconda_post_commandszCondaSpecs.conda_post_commandsrrcy)az Register a conda auth handler derived from the requests API. This plugin hook allows attaching requests auth handler subclasses, e.g. when authenticating requests against individual channels hosted at HTTP/HTTPS services. **Example:** .. code-block:: python import os from conda import plugins from requests.auth import AuthBase class EnvironmentHeaderAuth(AuthBase): def __init__(self, *args, **kwargs): self.username = os.environ["EXAMPLE_CONDA_AUTH_USERNAME"] self.password = os.environ["EXAMPLE_CONDA_AUTH_PASSWORD"] def __call__(self, request): request.headers["X-Username"] = self.username request.headers["X-Password"] = self.password return request @plugins.hookimpl def conda_auth_handlers(): yield plugins.CondaAuthHandler( name="environment-header-auth", auth_handler=EnvironmentHeaderAuth, ) Nrrs rconda_auth_handlerszCondaSpecs.conda_auth_handlersrrcy)a Register health checks for conda doctor. This plugin hook allows you to add more "health checks" to conda doctor that you can write to diagnose problems in your conda environment. Check out the health checks already shipped with conda for inspiration. **Example:** .. code-block:: python from conda import plugins def example_health_check(prefix: str, verbose: bool): print("This is an example health check!") @plugins.hookimpl def conda_health_checks(): yield plugins.CondaHealthCheck( name="example-health-check", action=example_health_check, ) Nrrs rconda_health_checkszCondaSpecs.conda_health_checksrrcy)a? Register pre-solve functions in conda that are used in the general solver API, before the solver processes the package specs in search of a solution. **Example:** .. code-block:: python from conda import plugins from conda.models.match_spec import MatchSpec def example_pre_solve( specs_to_add: frozenset[MatchSpec], specs_to_remove: frozenset[MatchSpec], ): print(f"Adding {len(specs_to_add)} packages") print(f"Removing {len(specs_to_remove)} packages") @plugins.hookimpl def conda_pre_solves(): yield plugins.CondaPreSolve( name="example-pre-solve", action=example_pre_solve, ) Nrrs rconda_pre_solveszCondaSpecs.conda_pre_solvesrrcy)a Register post-solve functions in conda that are used in the general solver API, after the solver has provided the package records to add or remove from the conda environment. **Example:** .. code-block:: python from conda import plugins from conda.models.records import PackageRecord def example_post_solve( repodata_fn: str, unlink_precs: tuple[PackageRecord, ...], link_precs: tuple[PackageRecord, ...], ): print(f"Uninstalling {len(unlink_precs)} packages") print(f"Installing {len(link_precs)} packages") @plugins.hookimpl def conda_post_solves(): yield plugins.CondaPostSolve( name="example-post-solve", action=example_post_solve, ) Nrrs rconda_post_solveszCondaSpecs.conda_post_solvesrrcy)a Register new setting The example below defines a simple string type parameter **Example:** .. code-block:: python from conda import plugins from conda.common.configuration import PrimitiveParameter, SequenceParameter @plugins.hookimpl def conda_settings(): yield plugins.CondaSetting( name="example_option", description="This is an example option", parameter=PrimitiveParameter("default_value", element_type=str), aliases=("example_option_alias",), ) Nrrs rconda_settingszCondaSpecs.conda_settings9rrcy)a Register new reporter backend The example below defines a reporter backend that uses the ``pprint`` module in Python. **Example:** .. code-block:: python from pprint import pformat from conda import plugins from conda.plugins.types import ( CondaReporterBackend, ReporterRendererBase, ProgressBarBase, ) class PprintReporterRenderer(ReporterRendererBase): "Implementation of the ReporterRendererBase" def detail_view(self, data): return pformat(data) def envs_list(self, data): formatted_data = pformat(data) return f"Environments: {formatted_data}" def progress_bar(self, description, io_context_manager) -> ProgressBarBase: "Returns our custom progress bar implementation" return PprintProgressBar(description, io_context_manager) class PprintProgressBar(ProgressBarBase): "Blank implementation of ProgressBarBase which does nothing" def update_to(self, fraction) -> None: pass def refresh(self) -> None: pass def close(self) -> None: pass @plugins.hookimpl def conda_reporter_backends(): yield CondaReporterBackend( name="pprint", description="Reporter backend based on the pprint module", renderer=PprintReporterRenderer, ) Nrrs rconda_reporter_backendsz"CondaSpecs.conda_reporter_backendsRrrc#$KdEd{y7w)aQ Register new HTTP request headers The example below defines how to add HTTP headers for all requests with the hostname of ``example.com``. **Example:** .. code-block:: python from conda import plugins HOSTS = {"example.com", "sub.example.com"} @plugins.hookimpl def conda_session_headers(host: str): if host in HOSTS: yield plugins.CondaRequestHeader( name="Example-Header", value="example", ) rNr)rhosts rconda_session_headersz CondaSpecs.conda_session_headerss2 c#$KdEd{y7w)a Register new HTTP request headers The example below defines how to add HTTP headers for all requests with the hostname of ``example.com`` and a ``path/to/endpoint.json`` path. **Example:** .. code-block:: python from conda import plugins HOSTS = {"example.com", "sub.example.com"} ENDPOINT = "/path/to/endpoint.json" @plugins.hookimpl def conda_request_headers(host: str, path: str): if host in HOSTS and path == ENDPOINT: yield plugins.CondaRequestHeader( name="Example-Header", value="example", ) rNr)rr3paths rconda_request_headersz CondaSpecs.conda_request_headerss8 r5N)returnzIterable[CondaSolver])r9zIterable[CondaSubcommand])r9zIterable[CondaVirtualPackage])r9zIterable[CondaPreCommand])r9zIterable[CondaPostCommand])r9zIterable[CondaAuthHandler])r9zIterable[CondaHealthCheck])r9zIterable[CondaPreSolve])r9zIterable[CondaPostSolve])r9zIterable[CondaSetting])r9zIterable[CondaReporterBackend])r3strr9Iterable[CondaRequestHeader])r3r:r7r:r9r;)__name__ __module__ __qualname____doc__ _hookspecrrr!r#r%r'r)r+r-r/r1r4r8rrrrr1s"?  @  4  ,  0  0" " H  6  <  >  08 8 t4" %rr)r? __future__rtypingrpluggycollections.abcrtypesrrr r r r r rrrrr spec_nameHookspecMarkerr@HookimplMarkerhookimplrrrrrJsu# (      8 !F ! !) ,  !6  + SSr