mirror of
https://github.com/enpaul/tox-poetry-installer.git
synced 2024-10-29 19:47:00 +00:00
44 lines
2.3 KiB
Python
44 lines
2.3 KiB
Python
"""You've heard of vendoirization, now get ready for internal namespace shadowing
|
|
|
|
Poetry is an optional dependency of this package explicitly to support the use case of having the
|
|
plugin and the `poetry` package installed to the same python environment; this is most common in
|
|
containers and/or CI. In this case there are two potential problems that can arise in this case:
|
|
|
|
* The installation of the plugin overwrites the installed version of Poetry resulting in
|
|
compatibility issues.
|
|
* Running `poetry install --no-dev`, when this plugin is in the dev-deps, results in poetry being
|
|
uninstalled from the environment.
|
|
|
|
To support these edge cases, and more broadly to support not messing with a system package manager,
|
|
the `poetry` package dependency is listed as optional dependency. This allows the plugin to be
|
|
installed to the same environment as Poetry and import that same Poetry installation here.
|
|
|
|
However, simply importing Poetry on the assumption that it is installed breaks another valid use
|
|
case: having this plugin installed alongside Tox when not using a Poetry-based project. To account
|
|
for this the imports in this module are isolated and the resultant import error that would result
|
|
is converted to an internal error that can be caught by callers. Rather than importing this module
|
|
at the module scope it is imported into function scope wherever Poetry components are needed. This
|
|
moves import errors from load time to runtime which allows the plugin to be skipped if Poetry isn't
|
|
installed and/or a more helpful error be raised within the Tox framework.
|
|
"""
|
|
# pylint: disable=unused-import
|
|
import sys
|
|
|
|
from tox_poetry_installer import exceptions
|
|
|
|
|
|
try:
|
|
from cleo.io.null_io import NullIO
|
|
from poetry.config.config import Config
|
|
from poetry.core.packages.dependency import Dependency as PoetryDependency
|
|
from poetry.core.packages.package import Package as PoetryPackage
|
|
from poetry.factory import Factory
|
|
from poetry.installation.executor import Executor
|
|
from poetry.installation.operations.install import Install
|
|
from poetry.poetry import Poetry
|
|
from poetry.utils.env import VirtualEnv
|
|
except ImportError as err:
|
|
raise exceptions.PoetryNotInstalledError(
|
|
f"Failed to import a supported version of Poetry under the current environment '{sys.executable}': {err}"
|
|
) from None
|