creators.py 4.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798
  1. from __future__ import annotations
  2. from collections import OrderedDict, defaultdict
  3. from typing import TYPE_CHECKING, NamedTuple
  4. from virtualenv.create.describe import Describe
  5. from virtualenv.create.via_global_ref.builtin.builtin_way import VirtualenvBuiltin
  6. from .base import ComponentBuilder
  7. if TYPE_CHECKING:
  8. from collections.abc import Sequence
  9. from python_discovery import PythonInfo
  10. from virtualenv.config.cli.parser import VirtualEnvConfigParser, VirtualEnvOptions
  11. from virtualenv.create.creator import Creator, CreatorMeta
  12. class CreatorInfo(NamedTuple):
  13. key_to_class: dict[str, type[Creator]]
  14. key_to_meta: dict[str, CreatorMeta]
  15. describe: type[Describe] | None
  16. builtin_key: str
  17. class CreatorSelector(ComponentBuilder):
  18. def __init__(self, interpreter: PythonInfo, parser: VirtualEnvConfigParser) -> None:
  19. creators, self.key_to_meta, self.describe, self.builtin_key = self.for_interpreter(interpreter)
  20. super().__init__(interpreter, parser, "creator", creators) # ty: ignore[invalid-argument-type]
  21. @classmethod
  22. def for_interpreter(cls, interpreter: PythonInfo) -> CreatorInfo:
  23. key_to_class, key_to_meta, builtin_key, describe = OrderedDict(), {}, None, None
  24. errors = defaultdict(list)
  25. for key, creator_class in cls.options("virtualenv.create").items():
  26. if key == "builtin":
  27. msg = "builtin creator is a reserved name"
  28. raise RuntimeError(msg)
  29. meta = creator_class.can_create(interpreter) # ty: ignore[unresolved-attribute]
  30. if meta:
  31. if meta.error:
  32. errors[meta.error].append(creator_class)
  33. else:
  34. if "builtin" not in key_to_class and issubclass(creator_class, VirtualenvBuiltin):
  35. builtin_key = key
  36. key_to_class["builtin"] = creator_class
  37. key_to_meta["builtin"] = meta
  38. key_to_class[key] = creator_class
  39. key_to_meta[key] = meta
  40. if describe is None and issubclass(creator_class, Describe) and creator_class.can_describe(interpreter):
  41. describe = creator_class
  42. if not key_to_meta:
  43. if errors:
  44. rows = [f"{k} for creators {', '.join(i.__name__ for i in v)}" for k, v in errors.items()]
  45. raise RuntimeError("\n".join(rows))
  46. msg = f"No virtualenv implementation for {interpreter}"
  47. raise RuntimeError(msg)
  48. return CreatorInfo(
  49. key_to_class=key_to_class,
  50. key_to_meta=key_to_meta,
  51. describe=describe,
  52. builtin_key=builtin_key or "",
  53. )
  54. def add_selector_arg_parse(self, name: str, choices: Sequence[str]) -> None:
  55. # prefer the built-in venv if present, otherwise fallback to first defined type
  56. choices = sorted(choices, key=lambda a: 0 if a == "builtin" else 1)
  57. default_value = self._get_default(choices)
  58. self.parser.add_argument(
  59. f"--{name}",
  60. choices=choices,
  61. default=default_value,
  62. required=False,
  63. help=f"create environment via{'' if self.builtin_key is None else f' (builtin = {self.builtin_key})'}",
  64. )
  65. @staticmethod
  66. def _get_default(choices: list[str]) -> str:
  67. return next(iter(choices))
  68. def populate_selected_argparse(self, selected: str, app_data: object) -> None:
  69. self.parser.description = f"options for {self.name} {selected}"
  70. assert self._impl_class is not None # noqa: S101 # Set by handle_selected_arg_parse
  71. self._impl_class.add_parser_arguments(self.parser, self.interpreter, self.key_to_meta[selected], app_data) # ty: ignore[unresolved-attribute]
  72. def create(self, options: VirtualEnvOptions) -> Creator:
  73. options.meta = self.key_to_meta[getattr(options, self.name)]
  74. assert self._impl_class is not None # noqa: S101 # Set by handle_selected_arg_parse
  75. if not issubclass(self._impl_class, Describe):
  76. options.describe = self.describe(options, self.interpreter) # ty: ignore[call-non-callable, invalid-argument-type]
  77. return super().create(options) # ty: ignore[invalid-return-type]
  78. __all__ = [
  79. "CreatorInfo",
  80. "CreatorSelector",
  81. ]