Source code for conda_tui.environment

from dataclasses import dataclass
from functools import cache
from pathlib import Path

from conda.base.constants import ROOT_ENV_NAME
from conda.base.context import context
from conda.common.path import paths_equal
from conda.core.envs_manager import list_all_known_prefixes as list_prefixes




@dataclass
class Environment:
    prefix: Path

    @property
    def relative_path(self) -> Path:
        return self._get_relative_path(self.prefix)

    @staticmethod
    @cache
    def _get_relative_path(prefix: Path) -> Path:
        user_home = Path("~")
        if prefix.is_relative_to(user_home.expanduser()):
            return user_home / prefix.relative_to(user_home.expanduser())
        return prefix

    @property
    def name(self) -> str:
        """The name of the conda environment, if it is named. Otherwise, an empty string."""
        return self._get_name(self.prefix)

    @staticmethod
    @cache
    def _get_name(prefix: Path) -> str:
        """Retrieve the name of the environment from its prefix, if it has a name.

        Otherwise, returns an empty string.

        Cached for performance.

        """
        if str(prefix) == context.root_prefix:
            return ROOT_ENV_NAME
        elif any(
            paths_equal(envs_dir, str(prefix.parent)) for envs_dir in context.envs_dirs
        ):
            return str(prefix.name)
        return ""

    def __hash__(self) -> int:
        return hash(self.prefix)





def list_environments(sort: bool = True) -> list[Environment]:
    """Get a list of conda environments installed on local machine.

    Args:
        sort: If True, the list will be sorted alphabetically, with named environments
            appearing first, followed by path-based environments.

    """

    environments = [Environment(prefix=Path(env)) for env in list_prefixes()]
    if sort:
        named = sorted((e for e in environments if e.name), key=lambda x: x.name)
        unnamed = sorted(
            (e for e in environments if not e.name), key=lambda x: str(x.relative_path)
        )
        return named + unnamed
    return environments