seeder.py 1.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253
  1. from __future__ import annotations
  2. from abc import ABC, abstractmethod
  3. from typing import TYPE_CHECKING
  4. if TYPE_CHECKING:
  5. from argparse import ArgumentParser
  6. from python_discovery import PythonInfo
  7. from virtualenv.app_data.base import AppData
  8. from virtualenv.config.cli.parser import VirtualEnvOptions
  9. from virtualenv.create.creator import Creator
  10. class Seeder(ABC):
  11. """A seeder will install some seed packages into a virtual environment."""
  12. def __init__(self, options: VirtualEnvOptions, enabled: bool) -> None:
  13. """Create.
  14. :param options: the parsed options as defined within :meth:`add_parser_arguments`
  15. :param enabled: a flag weather the seeder is enabled or not
  16. """
  17. self.enabled = enabled
  18. self.env = options.env
  19. @classmethod
  20. def add_parser_arguments(cls, parser: ArgumentParser, interpreter: PythonInfo, app_data: AppData) -> None:
  21. """Add CLI arguments for this seed mechanisms.
  22. :param parser: the CLI parser
  23. :param app_data: the CLI parser
  24. :param interpreter: the interpreter this virtual environment is based of
  25. """
  26. raise NotImplementedError
  27. @abstractmethod
  28. def run(self, creator: Creator) -> None:
  29. """Perform the seed operation.
  30. :param creator: the creator (based of :class:`virtualenv.create.creator.Creator`) we used to create this virtual
  31. environment
  32. """
  33. raise NotImplementedError
  34. __all__ = [
  35. "Seeder",
  36. ]