summaryrefslogtreecommitdiff
path: root/src/virtualenv/discovery/discover.py
blob: 28e07dd4c668bf0a753a6a32f0f740ba675ba41a (plain)
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
from __future__ import annotations

from abc import ABCMeta, abstractmethod


class Discover(metaclass=ABCMeta):
    """Discover and provide the requested Python interpreter"""

    @classmethod
    def add_parser_arguments(cls, parser):  # noqa: U100
        """Add CLI arguments for this discovery mechanisms.

        :param parser: the CLI parser
        """
        raise NotImplementedError

    def __init__(self, options):
        """Create a new discovery mechanism.

        :param options: the parsed options as defined within :meth:`add_parser_arguments`
        """
        self._has_run = False
        self._interpreter = None
        self._env = options.env

    @abstractmethod
    def run(self):
        """Discovers an interpreter.

        :return: the interpreter ready to use for virtual environment creation
        """
        raise NotImplementedError

    @property
    def interpreter(self):
        """
        :return: the interpreter as returned by :meth:`run`, cached
        """
        if self._has_run is False:
            self._interpreter = self.run()
            self._has_run = True
        return self._interpreter


__all__ = [
    "Discover",
]