File size: 35,020 Bytes
71687cf | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 | # Copyright (C) 2012 Anaconda, Inc
# SPDX-License-Identifier: BSD-3-Clause
"""
This module contains a subclass implementation of pluggy's
`PluginManager <https://pluggy.readthedocs.io/en/stable/api_reference.html#pluggy.PluginManager>`_.
Additionally, it contains a function we use to construct the ``PluginManager`` object and
register all plugins during conda's startup process.
"""
from __future__ import annotations
import functools
import logging
import os
from importlib.metadata import distributions
from inspect import getmodule, isclass
from typing import TYPE_CHECKING, overload
import pluggy
from ..auxlib import NULL
from ..auxlib.ish import dals
from ..base.constants import APP_NAME, DEFAULT_CONSOLE_REPORTER_BACKEND
from ..base.context import context
from ..common.io import dashlist
from ..exceptions import (
CondaValueError,
EnvironmentExporterNotDetected,
EnvironmentSpecPluginNotDetected,
PluginError,
)
from . import (
environment_exporters,
environment_specifiers,
package_extractors,
post_solves,
prefix_data_loaders,
reporter_backends,
solvers,
subcommands,
virtual_packages,
)
from .config import PluginConfig
from .hookspec import CondaSpecs
from .subcommands.doctor import health_checks
if TYPE_CHECKING:
from collections.abc import Callable, Iterable
from typing import Literal
from requests.auth import AuthBase
from ..common.path import PathType
from ..core.path_actions import Action
from ..core.solve import Solver
from ..models.match_spec import MatchSpec
from ..models.records import PackageRecord
from .types import (
CondaAuthHandler,
CondaEnvironmentExporter,
CondaEnvironmentSpecifier,
CondaHealthCheck,
CondaPackageExtractor,
CondaPostCommand,
CondaPostSolve,
CondaPostTransactionAction,
CondaPreCommand,
CondaPrefixDataLoader,
CondaPrefixDataLoaderCallable,
CondaPreSolve,
CondaPreTransactionAction,
CondaReporterBackend,
CondaRequestHeader,
CondaSetting,
CondaSolver,
CondaSubcommand,
CondaVirtualPackage,
)
log = logging.getLogger(__name__)
class CondaPluginManager(pluggy.PluginManager):
"""
The conda plugin manager to implement behavior additional to pluggy's default plugin manager.
"""
get_cached_solver_backend: Callable[[str | None], type[Solver]]
"""Cached version of the :meth:`~conda.plugins.manager.CondaPluginManager.get_solver_backend` method."""
get_cached_session_headers: Callable[[str], dict[str, str]]
"""Cached version of the :meth:`~conda.plugins.manager.CondaPluginManager.get_session_headers` method."""
get_cached_request_headers: Callable[[str, str], dict[str, str]]
"""Cached version of the :meth:`~conda.plugins.manager.CondaPluginManager.get_request_headers` method."""
def __init__(self, *args, **kwargs):
super().__init__(APP_NAME, *args, **kwargs)
# Make the cache containers local to the instances so that the
# reference from cache to the instance gets garbage collected with the instance
self.get_cached_solver_backend = functools.cache(self.get_solver_backend)
self.get_cached_session_headers = functools.cache(self.get_session_headers)
self.get_cached_request_headers = functools.cache(self.get_request_headers)
def get_canonical_name(self, plugin: object) -> str:
# detect the fully qualified module name
prefix = "<unknown_module>"
if (module := getmodule(plugin)) and module.__spec__:
prefix = module.__spec__.name
# return the fully qualified name for modules
if module is plugin:
return prefix
# return the fully qualified name for classes
elif isclass(plugin):
return f"{prefix}.{plugin.__qualname__}"
# return the fully qualified name for instances
else:
return f"{prefix}.{plugin.__class__.__qualname__}[{id(plugin)}]"
def register(self, plugin, name: str | None = None) -> str | None:
"""
Call :meth:`pluggy.PluginManager.register` and return the result or
ignore errors raised, except ``ValueError``, which means the plugin
had already been registered.
"""
try:
# register plugin but ignore ValueError since that means
# the plugin has already been registered
return super().register(plugin, name=name)
except ValueError:
return None
except Exception as err:
raise PluginError(
f"Error while loading conda plugin: "
f"{name or self.get_canonical_name(plugin)} ({err})"
) from err
def load_plugins(self, *plugins) -> int:
"""
Load the provided list of plugins and fail gracefully on error.
The provided list of plugins can either be classes or modules with
:attr:`~conda.plugins.hookimpl`.
"""
count = 0
for plugin in plugins:
if self.register(plugin):
count += 1
return count
def load_entrypoints(self, group: str, name: str | None = None) -> int:
"""Load modules from querying the specified setuptools ``group``.
:param str group: Entry point group to load plugins.
:param str name: If given, loads only plugins with the given ``name``.
:rtype: int
:return: The number of plugins loaded by this call.
"""
count = 0
for dist in distributions():
for entry_point in dist.entry_points:
# skip entry points that don't match the group/name
if entry_point.group != group or (
name is not None and entry_point.name != name
):
continue
# attempt to load plugin from entry point
try:
plugin = entry_point.load()
except Exception as err:
# not using exc_info=True here since the CLI loggers are
# set up after CLI initialization and argument parsing,
# meaning that it comes too late to properly render
# a traceback; instead we pass exc_info conditionally on
# context.verbosity
log.warning(
f"Error while loading conda entry point: {entry_point.name} ({err})",
exc_info=err if context.info else None,
)
continue
if self.register(plugin):
count += 1
return count
@overload
def get_hook_results(
self, name: Literal["subcommands"]
) -> list[CondaSubcommand]: ...
@overload
def get_hook_results(
self, name: Literal["virtual_packages"]
) -> list[CondaVirtualPackage]: ...
@overload
def get_hook_results(self, name: Literal["solvers"]) -> list[CondaSolver]: ...
@overload
def get_hook_results(
self, name: Literal["pre_commands"]
) -> list[CondaPreCommand]: ...
@overload
def get_hook_results(
self, name: Literal["post_commands"]
) -> list[CondaPostCommand]: ...
@overload
def get_hook_results(
self, name: Literal["auth_handlers"]
) -> list[CondaAuthHandler]: ...
@overload
def get_hook_results(
self, name: Literal["health_checks"]
) -> list[CondaHealthCheck]: ...
@overload
def get_hook_results(self, name: Literal["pre_solves"]) -> list[CondaPreSolve]: ...
@overload
def get_hook_results(
self, name: Literal["post_solves"]
) -> list[CondaPostSolve]: ...
@overload
def get_hook_results(
self, name: Literal["session_headers"], *, host: str
) -> list[CondaRequestHeader]: ...
@overload
def get_hook_results(
self, name: Literal["request_headers"], *, host: str, path: str
) -> list[CondaRequestHeader]: ...
@overload
def get_hook_results(self, name: Literal["settings"]) -> list[CondaSetting]: ...
@overload
def get_hook_results(
self, name: Literal["reporter_backends"]
) -> list[CondaReporterBackend]: ...
@overload
def get_hook_results(
self, name: Literal["pre_transaction_actions"]
) -> list[CondaPreTransactionAction]: ...
@overload
def get_hook_results(
self, name: Literal["post_transaction_actions"]
) -> list[CondaPostTransactionAction]: ...
@overload
def get_hook_results(
self, name: Literal["prefix_data_loaders"]
) -> list[CondaPrefixDataLoader]: ...
@overload
def get_hook_results(
self, name: Literal["environment_specifiers"]
) -> list[CondaEnvironmentSpecifier]: ...
@overload
def get_hook_results(
self, name: Literal["package_extractors"]
) -> list[CondaPackageExtractor]: ...
@overload
def get_hook_results(
self, name: Literal["environment_exporters"]
) -> list[CondaEnvironmentExporter]: ...
def get_hook_results(self, name, **kwargs):
"""
Return results of the plugin hooks with the given name and
raise an error if there is a conflict.
"""
specname = f"{self.project_name}_{name}" # e.g. conda_solvers
hook = getattr(self.hook, specname, None)
if hook is None:
raise PluginError(f"Could not find requested `{name}` plugins")
# hook() returns a generator of all plugins for a given specname,
# unfortunately this generator does not offer any information about which
# package/module the plugin is defined in, this makes reporting errors in
# a meaningful way to users difficult
plugins = [plugin for plugins in hook(**kwargs) for plugin in plugins]
# Validate plugin names since plugins may not properly inherit from CondaPlugin
invalid = [
plugin
for plugin in plugins
if not hasattr(plugin, "name")
or not isinstance(plugin.name, str)
or plugin.name != plugin.name.lower().strip()
]
if invalid:
raise PluginError(
f"Invalid plugin names found for `{name}`:\n"
f"{dashlist(map(repr, invalid))}\n"
f"\n"
f"Please report this issue to the plugin author(s)."
)
# Check for conflicts since no two plugins can have the same name
seen = set()
conflicts = [
plugin for plugin in plugins if plugin.name in seen or seen.add(plugin.name)
]
if conflicts:
raise PluginError(
f"Conflicting plugins found for `{name}`:\n"
f"{dashlist(map(repr, conflicts))}\n"
f"\n"
f"Multiple conda plugins are registered via the `{specname}` hook. "
f"Please make sure that you don't have any incompatible plugins installed."
)
return sorted(plugins, key=lambda plugin: plugin.name)
def get_solvers(self) -> dict[str, CondaSolver]:
"""Return a mapping from solver name to solver class."""
return {
solver_plugin.name: solver_plugin
for solver_plugin in self.get_hook_results("solvers")
}
def get_solver_backend(self, name: str | None = None) -> type[Solver]:
"""
Get the solver backend with the given name (or fall back to the
name provided in the context).
See ``context.solver`` for more details.
Please use the cached version of this method called
:meth:`get_cached_solver_backend` for high-throughput code paths
which is set up as a instance-specific LRU cache.
"""
# Some light data validation in case name isn't given.
name = (name or context.solver).lower().strip()
solvers_mapping = self.get_solvers()
# Look up the solver mapping and fail loudly if it can't
# find the requested solver.
solver_plugin = solvers_mapping.get(name, None)
if solver_plugin is None:
raise CondaValueError(
f"You have chosen a non-default solver backend ({name}) "
f"but it was not recognized. Choose one of: "
f"{', '.join(solvers_mapping)}"
)
return solver_plugin.backend
def get_auth_handler(self, name: str) -> type[AuthBase] | None:
"""
Get the auth handler with the given name or None
"""
name = name.lower().strip()
auth_handlers = self.get_hook_results("auth_handlers")
matches = [item for item in auth_handlers if item.name == name]
if len(matches) > 0:
return matches[0].handler
return None
def get_settings(self) -> dict[str, CondaSetting]:
"""
Return a mapping of plugin setting name to CondaSetting objects.
This method intentionally overwrites any duplicates that may be present
"""
return {
config_param.name: config_param
for config_param in self.get_hook_results("settings")
}
def invoke_pre_commands(self, command: str) -> None:
"""
Invokes ``CondaPreCommand.action`` functions registered with ``conda_pre_commands``.
:param command: name of the command that is currently being invoked
"""
for hook in self.get_hook_results("pre_commands"):
if command in hook.run_for:
hook.action(command)
def invoke_post_commands(self, command: str) -> None:
"""
Invokes ``CondaPostCommand.action`` functions registered with ``conda_post_commands``.
:param command: name of the command that is currently being invoked
"""
for hook in self.get_hook_results("post_commands"):
if command in hook.run_for:
hook.action(command)
def disable_external_plugins(self) -> None:
"""
Disables all currently registered plugins except built-in conda plugins
"""
for name, plugin in self.list_name_plugin():
if not name.startswith("conda.plugins.") and not self.is_blocked(name):
self.set_blocked(name)
def get_subcommands(self) -> dict[str, CondaSubcommand]:
return {
subcommand.name: subcommand
for subcommand in self.get_hook_results("subcommands")
}
def get_health_checks(self) -> dict[str, CondaHealthCheck]:
"""Return a mapping of health check name to health check."""
return {check.name: check for check in self.get_hook_results("health_checks")}
def get_reporter_backends(self) -> tuple[CondaReporterBackend, ...]:
return tuple(self.get_hook_results("reporter_backends"))
def get_reporter_backend(self, name: str) -> CondaReporterBackend:
"""
Attempts to find a reporter backend while providing a fallback option if it is
not found.
This method must return a valid ``CondaReporterBackend`` object or else it will
raise an exception.
"""
reporter_backends_map = {
reporter_backend.name: reporter_backend
for reporter_backend in self.get_reporter_backends()
}
reporter_backend = reporter_backends_map.get(name, None)
if reporter_backend is None:
log.warning(
f'Unable to find reporter backend: "{name}"; '
f'falling back to using "{DEFAULT_CONSOLE_REPORTER_BACKEND}"'
)
return reporter_backends_map.get(DEFAULT_CONSOLE_REPORTER_BACKEND)
else:
return reporter_backend
def get_virtual_package_records(self) -> tuple[PackageRecord, ...]:
return tuple(
virtual_package
for hook in self.get_hook_results("virtual_packages")
if (virtual_package := hook.to_virtual_package()) is not NULL
)
def get_session_headers(self, host: str) -> dict[str, str]:
return {
hook.name: hook.value
for hook in self.get_hook_results("session_headers", host=host)
}
def get_request_headers(self, host: str, path: str) -> dict[str, str]:
return {
hook.name: hook.value
for hook in self.get_hook_results("request_headers", host=host, path=path)
}
def get_prefix_data_loaders(self) -> Iterable[CondaPrefixDataLoaderCallable]:
for hook in self.get_hook_results("prefix_data_loaders"):
yield hook.loader
def invoke_pre_solves(
self,
specs_to_add: frozenset[MatchSpec],
specs_to_remove: frozenset[MatchSpec],
) -> None:
"""
Invokes ``CondaPreSolve.action`` functions registered with ``conda_pre_solves``.
:param specs_to_add:
:param specs_to_remove:
"""
for hook in self.get_hook_results("pre_solves"):
hook.action(specs_to_add, specs_to_remove)
def invoke_post_solves(
self,
repodata_fn: str,
unlink_precs: tuple[PackageRecord, ...],
link_precs: tuple[PackageRecord, ...],
) -> None:
"""
Invokes ``CondaPostSolve.action`` functions registered with ``conda_post_solves``.
:param repodata_fn:
:param unlink_precs:
:param link_precs:
"""
for hook in self.get_hook_results("post_solves"):
hook.action(repodata_fn, unlink_precs, link_precs)
def load_settings(self) -> None:
"""
Iterates through all registered settings and adds them to the
:class:`conda.common.configuration.PluginConfig` class.
"""
for name, setting in self.get_settings().items():
PluginConfig.add_plugin_setting(name, setting.parameter, setting.aliases)
def get_config(self, data) -> PluginConfig:
"""
Retrieve the configuration for the plugin.
Returns:
PluginConfig: The configuration object for the plugin, initialized with raw data from the context.
"""
return PluginConfig(data)
def get_environment_specifiers(self) -> dict[str, CondaEnvironmentSpecifier]:
"""
Returns a mapping from environment specifier name to environment specifier.
"""
return {
hook.name: hook for hook in self.get_hook_results("environment_specifiers")
}
def get_environment_specifier_by_name(
self,
source: str,
name: str,
) -> CondaEnvironmentSpecifier:
"""Get an environment specifier plugin by name
:param source: full path to the environment spec file/source
:param name: name of the environment plugin to load
:raises CondaValueError: if the requested plugin is not available.
:raises PluginError: if the requested plugin is unable to handle the provided file.
:returns: an environment specifier plugin that matches the provided plugin name, or can handle the provided file
"""
name = name.lower().strip()
plugins = self.get_environment_specifiers()
try:
plugin = plugins[name]
except KeyError:
raise CondaValueError(
f"You have chosen an unrecognized environment"
f" specifier type ({name}). Choose one of: "
f"{dashlist(plugins)}"
)
else:
# Try to load the plugin and check if it can handle the environment spec
try:
if plugin.environment_spec(source).can_handle():
return plugin
except Exception as e:
raise PluginError(
dals(
f"""
An error occured when handling '{source}' with plugin '{name}'.
{type(e).__name__}: {e}
"""
)
)
else:
# If the plugin was not able to handle the environment spec, raise an error
raise PluginError(
f"Requested plugin '{name}' is unable to handle environment spec '{source}'"
)
def detect_environment_specifier(self, source: str) -> CondaEnvironmentSpecifier:
"""Detect the environment specifier plugin for a given spec source
Raises PluginError if more than one environment_spec plugin is found to be able to handle the file.
Raises EnvironmentSpecPluginNotDetected if no plugins were found.
:param source: full path to the environment spec file or source
:returns: an environment specifier plugin that can handle the provided file
"""
hooks = self.get_environment_specifiers()
found = []
autodetect_disabled_plugins = []
for hook_name, hook in hooks.items():
if hook.environment_spec.detection_supported:
log.debug("EnvironmentSpec hook: checking %s", hook_name)
try:
if hook.environment_spec(source).can_handle():
log.debug(
"EnvironmentSpec hook: %s can be %s",
source,
hook_name,
)
found.append(hook)
else:
log.debug(
"EnvironmentSpec hook: %s can NOT be handled by %s",
source,
hook_name,
)
except Exception as e:
log.error(
"EnvironmentSpec hook: an error occurred when handling '%s' with plugin '%s'. %s",
source,
hook_name,
e,
)
log.debug("%r", e, exc_info=e)
else:
log.debug(
"EnvironmentSpec hook: %s can NOT be handled by %s",
source,
hook_name,
)
autodetect_disabled_plugins.append(hook_name)
if not found:
# HACK: if there was no plugin found, try to catch all `environment.yml` plugin
# FUTURE: Remove this final try at using the environment.yml to read the environment
# file. This should be removed in "26.9" when the deprecations warning for
# environment.yml's that are not compliant with cep-0024 are removed.
try:
return self.get_environment_specifier_by_name(
source=source, name="environment.yml"
)
except (PluginError, CondaValueError) as exc:
# raise error if no plugins found that can read the environment file
raise EnvironmentSpecPluginNotDetected(
name=source,
plugin_names=hooks,
autodetect_disabled_plugins=autodetect_disabled_plugins,
) from exc
elif len(found) == 1:
# return the plugin if only one is found
return found[0]
else:
# raise an error if there is more than one plugin found
raise PluginError(
dals(
f"""
Too many plugins found that can handle the environment file '{source}':
{", ".join([hook.name for hook in found])}
Please make sure that you don't have any overlapping plugins installed.
"""
)
)
def get_environment_specifier(
self,
source: str,
name: str | None = None,
) -> CondaEnvironmentSpecifier:
"""Get the environment specifier plugin for a given spec source, or given a plugin name
Raises PluginError if more than one environment_spec plugin is found to be able to handle the file.
Raises EnvironmentSpecPluginNotDetected if no plugins were found.
Raises CondaValueError if the requested plugin is not available.
:param filename: full path to the environment spec file/source
:param name: name of the environment plugin to load
:returns: an environment specifier plugin that matches the provided plugin name, or can handle the provided file
"""
if not name:
return self.detect_environment_specifier(source)
else:
return self.get_environment_specifier_by_name(source=source, name=name)
def get_environment_exporters(self) -> Iterable[CondaEnvironmentExporter]:
"""
Yields all detected environment exporters.
"""
yield from self.get_hook_results("environment_exporters")
def get_exporter_format_mapping(self) -> dict[str, CondaEnvironmentExporter]:
"""
Get a mapping from format names (including aliases) to environment exporters.
:return: Dict mapping format name to CondaEnvironmentExporter
:raises PluginError: If multiple exporters use the same format name or alias
"""
mapping = {}
conflicts = {} # format_name -> set of plugin names
for plugin in self.get_environment_exporters():
for format_name in (plugin.name, *plugin.aliases):
if format_name in mapping:
if format_name not in conflicts:
conflicts[format_name] = {mapping[format_name].name}
conflicts[format_name].add(plugin.name)
else:
mapping[format_name] = plugin
if conflicts:
conflict_details = []
for format_name, plugin_names in sorted(conflicts.items()):
plugins_str = ", ".join(sorted(plugin_names))
conflict_details.append(
f"'{format_name}' used by plugins: {plugins_str}"
)
raise PluginError(
f"Format name conflicts detected in environment exporters:"
f"{dashlist(conflict_details)}\n"
f"Multiple plugins cannot use the same format name or alias."
)
return mapping
def detect_environment_exporter(self, filename: str) -> CondaEnvironmentExporter:
"""
Detect an environment exporter based on exact filename matching against default_filenames.
:param filename: Filename to find an exporter for (basename is used for detection)
:return: CondaEnvironmentExporter that supports the filename
:raises EnvironmentExporterNotDetected: If no exporter supports the filename
:raises PluginError: If multiple exporters claim to support the same filename
"""
# Extract just the basename for matching
basename = os.path.basename(filename)
matches = []
for exporter_config in self.get_environment_exporters():
# Check if basename exactly matches any of the default filenames
if basename in exporter_config.default_filenames:
matches.append(exporter_config)
if not matches:
raise EnvironmentExporterNotDetected(
filename=basename,
exporters=self.get_environment_exporters(),
)
elif len(matches) > 1:
raise PluginError(
f"Multiple environment exporters found that can handle filename '{basename}':"
f"{dashlist([match.name for match in matches])}\n"
f"\n"
f"Please make sure that you don't have any conflicting exporter plugins installed."
)
return matches[0]
def get_environment_exporter_by_format(
self, format_name: str
) -> CondaEnvironmentExporter:
"""
Get an environment exporter based on the format name.
:param format_name: Format name to find an exporter for (e.g., 'yaml', 'json', 'environment-yaml')
:return: CondaEnvironmentExporter that supports the format
:raises CondaValueError: If no exporter is found for the given format
"""
format_mapping = self.get_exporter_format_mapping()
exporter = format_mapping.get(format_name)
if exporter is None:
raise CondaValueError(
f"Unknown export format '{format_name}'. "
f"Available formats:{dashlist(sorted(format_mapping.keys()))}"
)
return exporter
def get_pre_transaction_actions(
self,
transaction_context: dict[str, str] | None = None,
target_prefix: str | None = None,
unlink_precs: Iterable[PackageRecord] | None = None,
link_precs: Iterable[PackageRecord] | None = None,
remove_specs: Iterable[MatchSpec] | None = None,
update_specs: Iterable[MatchSpec] | None = None,
neutered_specs: Iterable[MatchSpec] | None = None,
) -> list[Action]:
"""Get the plugin-defined pre-transaction actions.
:param transaction_context: Mapping between target prefixes and PrefixActions
instances
:param target_prefix: Target prefix for the action
:param unlink_precs: Package records to be unlinked
:param link_precs: Package records to link
:param remove_specs: Specs to be removed
:param update_specs: Specs to be updated
:param neutered_specs: Specs to be neutered
:return: The plugin-defined pre-transaction actions
"""
return [
hook.action(
transaction_context,
target_prefix,
unlink_precs,
link_precs,
remove_specs,
update_specs,
neutered_specs,
)
for hook in self.get_hook_results("pre_transaction_actions")
]
def get_post_transaction_actions(
self,
transaction_context: dict[str, str] | None = None,
target_prefix: str | None = None,
unlink_precs: Iterable[PackageRecord] | None = None,
link_precs: Iterable[PackageRecord] | None = None,
remove_specs: Iterable[MatchSpec] | None = None,
update_specs: Iterable[MatchSpec] | None = None,
neutered_specs: Iterable[MatchSpec] | None = None,
) -> list[Action]:
"""Get the plugin-defined post-transaction actions.
:param transaction_context: Mapping between target prefixes and PrefixActions
instances
:param target_prefix: Target prefix for the action
:param unlink_precs: Package records to be unlinked
:param link_precs: Package records to link
:param remove_specs: Specs to be removed
:param update_specs: Specs to be updated
:param neutered_specs: Specs to be neutered
:return: The plugin-defined post-transaction actions
"""
return [
hook.action(
transaction_context,
target_prefix,
unlink_precs,
link_precs,
remove_specs,
update_specs,
neutered_specs,
)
for hook in self.get_hook_results("post_transaction_actions")
]
def get_package_extractors(self) -> dict[str, CondaPackageExtractor]:
"""
Return a mapping from file extension to package extractor plugin.
Extensions are lowercased for case-insensitive matching.
:return: Dictionary mapping lowercased extensions (e.g., ``".conda"``) to their
:class:`~conda.plugins.types.CondaPackageExtractor` plugins.
"""
return {
extension.lower(): hook
for hook in self.get_hook_results("package_extractors")
for extension in hook.extensions
}
def get_package_extractor(
self,
source_full_path: PathType,
) -> CondaPackageExtractor:
"""
Get the package extractor plugin for a given package path.
Searches through registered package extractor plugins to find one that
handles the file extension of the provided package path.
:param source_full_path: Full path to the package archive file.
:return: The matching :class:`~conda.plugins.types.CondaPackageExtractor` plugin.
:raises PluginError: If no registered extractor handles the file extension.
"""
source_str = os.fspath(source_full_path).lower()
for extension, extractor in self.get_package_extractors().items():
if source_str.endswith(extension):
return extractor
raise PluginError(
f"No registered 'package_extractors' plugin found for package: {source_full_path}"
)
def extract_package(
self,
source_full_path: PathType,
destination_directory: PathType,
) -> None:
"""
Extract a package archive to a destination directory.
Finds the appropriate extractor plugin based on the file extension
and extracts the package.
:param source_full_path: Full path to the package archive file.
:param destination_directory: Directory to extract the package contents to.
:raises PluginError: If no registered extractor handles the file extension.
"""
extractor = self.get_package_extractor(source_full_path)
extractor.extract(source_full_path, destination_directory)
def has_package_extension(self, path: PathType) -> str | None:
"""
Check if a path has a supported package file extension.
:param path: Path to check.
:return: The matched extension (lowercased) if found, None otherwise.
"""
path_str = os.fspath(path).lower()
for ext in self.get_package_extractors():
if path_str.endswith(ext):
return ext
return None
@functools.cache
def get_plugin_manager() -> CondaPluginManager:
"""
Get a cached version of the :class:`~conda.plugins.manager.CondaPluginManager` instance,
with the built-in and entrypoints provided by the plugins loaded.
"""
plugin_manager = CondaPluginManager()
plugin_manager.add_hookspecs(CondaSpecs)
plugin_manager.load_plugins(
solvers,
*virtual_packages.plugins,
*subcommands.plugins,
*health_checks.plugins,
*post_solves.plugins,
*reporter_backends.plugins,
*package_extractors.plugins,
*prefix_data_loaders.plugins,
*environment_specifiers.plugins,
*environment_exporters.plugins,
)
plugin_manager.load_entrypoints(APP_NAME)
return plugin_manager
|