common

Common utilities for conda command line tools.

Functions

is_active_prefix(→ bool)	Determines whether the args we pass in are pointing to the active prefix.
arg2spec(→ str)
specs_from_args(→ list[str])
strip_comment(→ str)
spec_from_line(→ str)
specs_from_url(→ list[str])
names_in_specs(names, specs)
disp_features(features)
stdout_json(d)
stdout_json_success([success])
check_non_admin()
validate_subdir_config()	Validates that the configured subdir is ok. A subdir that is different from
print_activate(env_name_or_prefix)
get_name_prefix_from_env_file(→ tuple[str | None, ...)	Get name and prefix from an environment spec file.
validate_environment_files_consistency(→ None)	Validates that all the provided environment files are of the same format type.
validate_file_exists(filename)	Validate the existence of an environment file.

Attributes

spec_pat

is_active_prefix(prefix: str) → bool

Determines whether the args we pass in are pointing to the active prefix. Can be used a validation step to make sure operations are not being performed on the active prefix.

arg2spec(arg: str, update: bool = False) → str

specs_from_args(args: collections.abc.Iterable[str]) → list[str]

spec_pat

strip_comment(line: str) → str

spec_from_line(line: str) → str

specs_from_url(url: str) → list[str]

names_in_specs(names, specs)

disp_features(features)

stdout_json(d)

stdout_json_success(success=True, **kwargs)

check_non_admin()

validate_subdir_config()

Validates that the configured subdir is ok. A subdir that is different from the native system is only allowed if it comes from the global configuration, or from an environment variable.

Raises:

OperationNotAllowed -- Active environment is not allowed to request non-native platform packages

print_activate(env_name_or_prefix)

get_name_prefix_from_env_file(file: str) → tuple[str | None, str | None]

Get name and prefix from an environment spec file.

Intentionally swallows all errors and logs them.

validate_environment_files_consistency(files: list[str]) → None

Validates that all the provided environment files are of the same format type.

This function checks if all provided environment files are of the same format type using the conda plugin system's environment specifiers. It prevents mixing different environment file formats (e.g., YAML, explicit package lists, requirements.txt).

Raises:

EnvironmentFileTypeMismatchError -- When files with different formats are found

validate_file_exists(filename: str)

Validate the existence of an environment file.

This function checks if the given filename exists as an environment file. If the filename has a URL scheme supported by CONDA_SESSION_SCHEMES, it assumes the file is accessible and returns without further validation. Otherwise, it expands the given path and verifies its existence. If the file does not exist, an EnvironmentFileNotFound exception is raised.

Parameters:

filename (str) -- The path or URL of the environment file to validate.

Raises:

EnvironmentFileNotFound -- If the file does not exist and is not a valid URL.