ExternallyManagedEnvironment Class Reference

Inheritance diagram for ExternallyManagedEnvironment:

Collaboration diagram for ExternallyManagedEnvironment:

Public Member Functions
None	__init__ (self, Optional[str] error)
"ExternallyManagedEnvironment"	from_config (cls, Union[pathlib.Path, str] config)
Public Member Functions inherited from DiagnosticPipError
str	__repr__ (self)
RenderResult	__rich_console__ (self, Console console, ConsoleOptions options)

Static Public Attributes
str	reference = "externally-managed-environment"
Static Public Attributes inherited from DiagnosticPipError
str	reference

Static Protected Member Functions
Iterator[str]	_iter_externally_managed_error_keys ()

Additional Inherited Members
Data Fields inherited from DiagnosticPipError
	kind
	reference
	message
	context
	note_stmt
	hint_stmt
	link

Detailed Description

The current environment is externally managed.

This is raised when the current environment is externally managed, as
defined by `PEP 668`_. The ``EXTERNALLY-MANAGED`` configuration is checked
and displayed when the error is bubbled up to the user.

:param error: The error message read from ``EXTERNALLY-MANAGED``.

Definition at line 663 of file exceptions.py.

Constructor & Destructor Documentation

__init__()

None __init__	(		self,
		Optional[str]	error
	)

Reimplemented from DiagnosticPipError.

Definition at line 675 of file exceptions.py.

    def __init__(self, error: Optional[str]) -> None:
        if error is None:
            context = Text(_DEFAULT_EXTERNALLY_MANAGED_ERROR)
        else:
            context = Text(error)
        super().__init__(
            message="This environment is externally managed",
            context=context,
            note_stmt=(
                "If you believe this is a mistake, please contact your "
                "Python installation or OS distribution provider. "
                "You can override this, at the risk of breaking your Python "
                "installation or OS, by passing --break-system-packages."
            ),
            hint_stmt=Text("See PEP 668 for the detailed specification."),
        )
 

Referenced by Protocol.__init_subclass__().

Here is the caller graph for this function:

Member Function Documentation

_iter_externally_managed_error_keys()

Iterator[str] _iter_externally_managed_error_keys ( )

staticprotected

Definition at line 693 of file exceptions.py.

    def _iter_externally_managed_error_keys() -> Iterator[str]:
        # LC_MESSAGES is in POSIX, but not the C standard. The most common
        # platform that does not implement this category is Windows, where
        # using other categories for console message localization is equally
        # unreliable, so we fall back to the locale-less vendor message. This
        # can always be re-evaluated when a vendor proposes a new alternative.
        try:
            category = locale.LC_MESSAGES
        except AttributeError:
            lang: Optional[str] = None
        else:
            lang, _ = locale.getlocale(category)
        if lang is not None:
            yield f"Error-{lang}"
            for sep in ("-", "_"):
                before, found, _ = lang.partition(sep)
                if not found:
                    continue
                yield f"Error-{before}"
        yield "Error"
 

from_config()

"ExternallyManagedEnvironment" from_config	(		cls,
		Union[pathlib.Path, str]	config
	)

Definition at line 715 of file exceptions.py.

    ) -> "ExternallyManagedEnvironment":
        parser = configparser.ConfigParser(interpolation=None)
        try:
            parser.read(config, encoding="utf-8")
            section = parser["externally-managed"]
            for key in cls._iter_externally_managed_error_keys():
                with contextlib.suppress(KeyError):
                    return cls(section[key])
        except KeyError:
            pass
        except (OSError, UnicodeDecodeError, configparser.ParsingError):
            from pip._internal.utils._log import VERBOSE
 
            exc_info = logger.isEnabledFor(VERBOSE)
            logger.warning("Failed to read %s", config, exc_info=exc_info)
        return cls(None)

Field Documentation

reference

str reference = "externally-managed-environment"

static

Definition at line 673 of file exceptions.py.

Referenced by DiagnosticPipError.__init__().

---

The documentation for this class was generated from the following file:

• /home/liwuen/projects_dev/pqc-engineering-ssec-23/venv/lib/python3.12/site-packages/pip/_internal/exceptions.py