14 Commits

Author SHA1 Message Date
536fd6536b Merge pull request #98 from enpaul/enp/refactor
Overhaul for stable
2024-08-20 14:09:42 -04:00
bbb075a1de Expand single character iteration variable 2024-08-20 14:06:51 -04:00
198287a633 Standardize import structure
Standardize on "import module" format rather than "from module import foo" format
Remove _poetry stub module since we directly depend on the poetry package now
Fix conflicts between modules and parameters both named 'poetry'
Fixes #92
2024-08-20 14:06:51 -04:00
4b38b00f81 Update mypy to 1.11
Fix typing errors
2024-08-20 13:14:22 -04:00
863f88d63c Fix linting errors for pylint 3 2024-08-20 13:02:12 -04:00
d816678975 Update dev dependencies to latest versions 2024-08-16 14:47:06 -04:00
552f2080f5 Remove python 3.7 support, add python 3.12 2024-08-16 14:47:06 -04:00
ddbf442a30 Update to isort and black 24 2024-08-16 14:27:46 -04:00
13cfb8616c Replace reorder-python-imports with isort
See here for indept explanation: https://github.com/psf/black/issues/4175
See here (and related) for the attitude: https://github.com/asottile/reorder-python-imports/issues/366
2024-08-16 14:26:51 -04:00
df343396a4 Remove safety dependency vulnerability scanner
I went back and fourth on this, but ultimately decided that it's more trouble
than it's worth. Between false positives, deeply nested packages raising
vulnerabilities, and the brittleness of the poetry-plugin-export that the
tooling relies on, it causes more headaches than it avoids. A future PR will
enable dependabot tooling that will open PRs to automatically fix this problem
so I don't have to deal with it anymore (hopefully)
2024-08-16 13:26:12 -04:00
f66e59ab85 Pin all development dependencies to python^3.10 2024-08-16 12:50:51 -04:00
f37463d172 Fix linting errors
Remove unused imports
Disable redundant errors
Add notes for why errors are disabled
2024-08-16 11:06:31 -04:00
6837a64121 Add handling of error when poetry.lock does not exist
Fixes #81
2024-08-16 11:06:31 -04:00
506aae0ccd Replace optional [poetry] extra with explicit poetry dependencies
Fixes #79
2024-08-16 11:06:31 -04:00
19 changed files with 1049 additions and 1560 deletions

View File

@@ -26,7 +26,6 @@ poetry --version --no-ansi;
poetry run pip --version; poetry run pip --version;
poetry install \ poetry install \
--extras poetry \
--quiet \ --quiet \
--remove-untracked \ --remove-untracked \
--no-ansi; --no-ansi;

View File

@@ -12,8 +12,6 @@ jobs:
strategy: strategy:
matrix: matrix:
python: python:
- version: "3.7"
toxenv: py37
- version: "3.8" - version: "3.8"
toxenv: py38 toxenv: py38
- version: "3.9" - version: "3.9"
@@ -22,6 +20,8 @@ jobs:
toxenv: py310 toxenv: py310
- version: "3.11" - version: "3.11"
toxenv: py311 toxenv: py311
- version: "3.12"
toxenv: py312
fail-fast: true fail-fast: true
steps: steps:
- name: Checkout - name: Checkout

View File

@@ -47,12 +47,13 @@ repos:
- id: reorder-python-imports - id: reorder-python-imports
name: reorder-python-imports name: reorder-python-imports
entry: reorder-python-imports entry: isort
language: system language: system
args: require_serial: true
- "--unclassifiable-application-module=tox_poetry_installer"
types: types:
- python - python
args:
- "--filter-files"
- id: black - id: black
name: black name: black

View File

@@ -11,7 +11,6 @@
# --disable=W" # --disable=W"
disable=logging-fstring-interpolation disable=logging-fstring-interpolation
,logging-format-interpolation ,logging-format-interpolation
,bad-continuation
,line-too-long ,line-too-long
,ungrouped-imports ,ungrouped-imports
,typecheck ,typecheck

2173
poetry.lock generated

File diff suppressed because it is too large Load Diff

View File

@@ -23,45 +23,46 @@ classifiers = [
"Natural Language :: English", "Natural Language :: English",
"Operating System :: OS Independent", "Operating System :: OS Independent",
"Programming Language :: Python :: 3", "Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.7",
"Programming Language :: Python :: 3.8", "Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9", "Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10", "Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11", "Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Programming Language :: Python :: Implementation :: CPython", "Programming Language :: Python :: Implementation :: CPython",
] ]
[tool.poetry.plugins.tox] [tool.poetry.plugins.tox]
poetry_installer = "tox_poetry_installer" poetry_installer = "tox_poetry_installer"
[tool.poetry.extras]
poetry = ["poetry", "cleo"]
[tool.poetry.dependencies] [tool.poetry.dependencies]
python = "^3.7" python = "^3.8"
cleo = {version = ">=1.0,<3.0", optional = true} cleo = ">=1.0,<3.0"
poetry = {version = "^1.5.0", optional = true} poetry = "^1.5.0"
poetry-core = "^1.1.0" poetry-core = "^1.1.0"
tox = "^4" tox = "^4.1"
[tool.poetry.group.dev.dependencies] [tool.poetry.group.dev.dependencies]
bandit = "^1.6.2" bandit = {version = "^1.7.7", python = "^3.10"}
black = "^22.3.0" black = {version = "^24.3.0", python = "^3.10"}
blacken-docs = "^1.8.0" blacken-docs = {version = "^1.18.0", python = "^3.10"}
ipython = {version = "^8.10.1", python = "^3.8"} ipython = {version = "^8.10.1", python = "^3.10"}
mdformat = "^0.7" isort = {version = "^5.13.2", python = "^3.10"}
mdformat-gfm = "^0.3" mdformat = {version = "^0.7", python = "^3.10"}
mypy = "^0.930" mdformat-gfm = {version = "^0.3", python = "^3.10"}
pre-commit = "^2.7.1" mypy = {version = "^1.11.1", python = "^3.10"}
pre-commit-hooks = "^3.3.0" pre-commit = {version = "^3.8.0", python = "^3.10"}
pylint = "^2.13.0" pre-commit-hooks = {version = "^4.6.0", python = "^3.10"}
pytest = "^6.0.2" pylint = {version = "^3.2.6", python = "^3.10"}
pytest-cov = "^2.10.1" pytest = {version = "^8.3.2", python = "^3.10"}
reorder-python-imports = "^2.3.5" pytest-cov = {version = "^5.0.0", python = "^3.10"}
safety = "^2.2.0" toml = {version = "^0.10.1", python = "^3.10"}
toml = "^0.10.1" tox = "^4.1"
tox = "^4" types-toml = {version = "^0.10.1", python = "^3.10"}
types-toml = "^0.10.1"
[tool.isort]
profile = "black"
force_single_line = "true"
lines_after_imports = 2
[build-system] [build-system]
requires = ["poetry-core>=1.1.0"] requires = ["poetry-core>=1.1.0"]

View File

@@ -1,14 +1,14 @@
# pylint: disable=missing-module-docstring, missing-function-docstring, unused-argument, too-few-public-methods # pylint: disable=missing-module-docstring,missing-function-docstring,unused-argument,too-few-public-methods,protected-access
import time import time
from pathlib import Path from pathlib import Path
from typing import List from typing import List
import poetry.factory import poetry.factory
import poetry.installation.executor import poetry.installation.executor
import poetry.installation.operations.operation
import poetry.utils.env import poetry.utils.env
import pytest import pytest
import tox.tox_env.python.virtual_env.runner import tox.tox_env.python.virtual_env.runner
from poetry.installation.operations.operation import Operation
import tox_poetry_installer.hooks._tox_on_install_helpers import tox_poetry_installer.hooks._tox_on_install_helpers
@@ -40,7 +40,9 @@ class MockExecutor:
def __init__(self, env: MockVirtualEnv, **kwargs): def __init__(self, env: MockVirtualEnv, **kwargs):
self.env = env self.env = env
def execute(self, operations: List[Operation]): def execute(
self, operations: List[poetry.installation.operations.operation.Operation]
):
self.env.installed.extend([operation.package for operation in operations]) self.env.installed.extend([operation.package for operation in operations])
time.sleep(1) time.sleep(1)
@@ -61,9 +63,9 @@ def mock_venv(monkeypatch):
@pytest.fixture(scope="function") @pytest.fixture(scope="function")
def mock_poetry_factory(monkeypatch): def mock_poetry_factory(monkeypatch):
pypoetry = poetry.factory.Factory().create_poetry(cwd=TEST_PROJECT_PATH) project = poetry.factory.Factory().create_poetry(cwd=TEST_PROJECT_PATH)
def mock_factory(*args, **kwargs): def mock_factory(*args, **kwargs):
return pypoetry return project
monkeypatch.setattr(poetry.factory.Factory, "create_poetry", mock_factory) monkeypatch.setattr(poetry.factory.Factory, "create_poetry", mock_factory)

View File

@@ -1,28 +1,30 @@
# pylint: disable=missing-module-docstring, redefined-outer-name, unused-argument, wrong-import-order, unused-import # pylint: disable=missing-module-docstring,redefined-outer-name,unused-argument,unused-import,protected-access
import time import time
from unittest import mock from unittest import mock
import poetry.factory
import poetry.installation.executor
import pytest import pytest
import tox.tox_env.python.virtual_env.runner import tox.tox_env.python.virtual_env.runner
from poetry.factory import Factory
import tox_poetry_installer.hooks._tox_on_install_helpers import tox_poetry_installer.hooks._tox_on_install_helpers
from .fixtures import mock_poetry_factory from .fixtures import mock_poetry_factory
from .fixtures import mock_venv from .fixtures import mock_venv
def test_deduplication(mock_venv, mock_poetry_factory): def test_deduplication(mock_venv, mock_poetry_factory):
"""Test that the installer does not install duplicate dependencies""" """Test that the installer does not install duplicate dependencies"""
poetry = Factory().create_poetry(None) project = poetry.factory.Factory().create_poetry(None)
packages: tox_poetry_installer.hooks._tox_on_install_helpers.PackageMap = { packages: tox_poetry_installer.hooks._tox_on_install_helpers.PackageMap = {
item.name: item for item in poetry.locker.locked_repository().packages item.name: item for item in project.locker.locked_repository().packages
} }
venv = tox.tox_env.python.virtual_env.runner.VirtualEnvRunner() venv = tox.tox_env.python.virtual_env.runner.VirtualEnvRunner()
to_install = [packages["toml"], packages["toml"]] to_install = [packages["toml"], packages["toml"]]
tox_poetry_installer.hooks._tox_on_install_helpers.install_package( tox_poetry_installer.hooks._tox_on_install_helpers.install_package(
poetry, venv, to_install project, venv, to_install
) )
assert len(set(to_install)) == len(venv.installed) # pylint: disable=no-member assert len(set(to_install)) == len(venv.installed) # pylint: disable=no-member
@@ -30,9 +32,9 @@ def test_deduplication(mock_venv, mock_poetry_factory):
def test_parallelization(mock_venv, mock_poetry_factory): def test_parallelization(mock_venv, mock_poetry_factory):
"""Test that behavior is consistent between parallel and non-parallel usage""" """Test that behavior is consistent between parallel and non-parallel usage"""
poetry = Factory().create_poetry(None) project = poetry.factory.Factory().create_poetry(None)
packages: tox_poetry_installer.hooks._tox_on_install_helpers.PackageMap = { packages: tox_poetry_installer.hooks._tox_on_install_helpers.PackageMap = {
item.name: item for item in poetry.locker.locked_repository().packages item.name: item for item in project.locker.locked_repository().packages
} }
to_install = [ to_install = [
@@ -47,14 +49,14 @@ def test_parallelization(mock_venv, mock_poetry_factory):
venv_sequential = tox.tox_env.python.virtual_env.runner.VirtualEnvRunner() venv_sequential = tox.tox_env.python.virtual_env.runner.VirtualEnvRunner()
start_sequential = time.time() start_sequential = time.time()
tox_poetry_installer.hooks._tox_on_install_helpers.install_package( tox_poetry_installer.hooks._tox_on_install_helpers.install_package(
poetry, venv_sequential, to_install, 0 project, venv_sequential, to_install, 0
) )
sequential = time.time() - start_sequential sequential = time.time() - start_sequential
venv_parallel = tox.tox_env.python.virtual_env.runner.VirtualEnvRunner() venv_parallel = tox.tox_env.python.virtual_env.runner.VirtualEnvRunner()
start_parallel = time.time() start_parallel = time.time()
tox_poetry_installer.hooks._tox_on_install_helpers.install_package( tox_poetry_installer.hooks._tox_on_install_helpers.install_package(
poetry, venv_parallel, to_install, 5 project, venv_parallel, to_install, 5
) )
parallel = time.time() - start_parallel parallel = time.time() - start_parallel
@@ -74,24 +76,22 @@ def test_propagates_exceptions_during_installation(
Regression test for https://github.com/enpaul/tox-poetry-installer/issues/86 Regression test for https://github.com/enpaul/tox-poetry-installer/issues/86
""" """
from tox_poetry_installer import _poetry # pylint: disable=import-outside-toplevel project = poetry.factory.Factory().create_poetry(None)
poetry = Factory().create_poetry(None)
packages: tox_poetry_installer.hooks._tox_on_install_helpers.PackageMap = { packages: tox_poetry_installer.hooks._tox_on_install_helpers.PackageMap = {
item.name: item for item in poetry.locker.locked_repository().packages item.name: item for item in project.locker.locked_repository().packages
} }
to_install = [packages["toml"]] to_install = [packages["toml"]]
venv = tox.tox_env.python.virtual_env.runner.VirtualEnvRunner() venv = tox.tox_env.python.virtual_env.runner.VirtualEnvRunner()
fake_exception = ValueError("my testing exception") fake_exception = ValueError("my testing exception")
with mock.patch.object( with mock.patch.object(
_poetry, poetry.installation.executor,
"Executor", "Executor",
**{"return_value.execute.side_effect": fake_exception}, **{"return_value.execute.side_effect": fake_exception},
): ):
with pytest.raises(ValueError) as exc_info: with pytest.raises(ValueError) as exc_info:
tox_poetry_installer.hooks._tox_on_install_helpers.install_package( tox_poetry_installer.hooks._tox_on_install_helpers.install_package(
poetry, venv, to_install, num_threads project, venv, to_install, num_threads
) )
assert exc_info.value is fake_exception assert exc_info.value is fake_exception

View File

@@ -3,6 +3,7 @@
The next best thing to having one source of truth is having a way to ensure all of your The next best thing to having one source of truth is having a way to ensure all of your
sources of truth agree with each other. sources of truth agree with each other.
""" """
from pathlib import Path from pathlib import Path
import toml import toml

View File

@@ -1,14 +1,13 @@
# pylint: disable=missing-module-docstring, redefined-outer-name, unused-argument, wrong-import-order, unused-import # pylint: disable=missing-module-docstring,redefined-outer-name,unused-argument,unused-import,protected-access
import poetry.factory import poetry.factory
import poetry.utils.env import poetry.utils.env
import pytest import pytest
from poetry.puzzle.provider import Provider
import tox_poetry_installer.hooks._tox_on_install_helpers import tox_poetry_installer.hooks._tox_on_install_helpers
from tox_poetry_installer import exceptions
from .fixtures import mock_poetry_factory from .fixtures import mock_poetry_factory
from .fixtures import mock_venv from .fixtures import mock_venv
from tox_poetry_installer import constants
from tox_poetry_installer import exceptions
def test_allow_missing(): def test_allow_missing():
@@ -49,9 +48,9 @@ def test_functional(mock_poetry_factory, mock_venv):
Trivially test that it resolves dependencies properly and that the parent package Trivially test that it resolves dependencies properly and that the parent package
is always the last in the returned list. is always the last in the returned list.
""" """
pypoetry = poetry.factory.Factory().create_poetry(None) project = poetry.factory.Factory().create_poetry(None)
packages = tox_poetry_installer.hooks._tox_on_install_helpers.build_package_map( packages = tox_poetry_installer.hooks._tox_on_install_helpers.build_package_map(
pypoetry project
) )
venv = poetry.utils.env.VirtualEnv() # pylint: disable=no-value-for-parameter venv = poetry.utils.env.VirtualEnv() # pylint: disable=no-value-for-parameter

18
tox.ini
View File

@@ -1,13 +1,11 @@
[tox] [tox]
envlist = py37, py38, py39, py310, py311, static, static-tests, security envlist = py3{8,9,10,11,12} static, static-tests, security
skip_missing_interpreters = true skip_missing_interpreters = true
[testenv] [testenv]
description = Run the tests description = Run the tests
require_locked_deps = true require_locked_deps = true
require_poetry = true require_poetry = true
extras =
poetry
locked_deps = locked_deps =
pytest pytest
pytest-cov pytest-cov
@@ -26,10 +24,10 @@ ignore_errors = true
locked_deps = locked_deps =
black black
blacken-docs blacken-docs
isort
mdformat mdformat
mdformat-gfm mdformat-gfm
mypy mypy
reorder-python-imports
pre-commit pre-commit
pre-commit-hooks pre-commit-hooks
pylint pylint
@@ -52,6 +50,7 @@ locked_deps =
pylint pylint
pytest pytest
mypy mypy
toml
types-toml types-toml
commands = commands =
pylint {toxinidir}/tests/ \ pylint {toxinidir}/tests/ \
@@ -78,14 +77,3 @@ commands =
--recursive \ --recursive \
--quiet \ --quiet \
--skip B101 --skip B101
poetry export \
--format requirements.txt \
--output {envtmpdir}/requirements.txt \
--without-hashes \
--with dev \
--extras poetry
safety check \
--file {envtmpdir}/requirements.txt \
--output text \
# https://github.com/pytest-dev/py/issues/287
--ignore 51457

View File

@@ -1,43 +0,0 @@
"""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

View File

@@ -5,7 +5,7 @@ in this module.
All constants should be type hinted. All constants should be type hinted.
""" """
from typing import Set
from typing import Tuple from typing import Tuple
from tox_poetry_installer import __about__ from tox_poetry_installer import __about__

View File

@@ -11,6 +11,7 @@ All exceptions should inherit from the common base exception :exc:`ToxPoetryInst
+-- LockedDepNotFoundError +-- LockedDepNotFoundError
+-- ExtraNotFoundError +-- ExtraNotFoundError
+-- LockedDepsRequiredError +-- LockedDepsRequiredError
+-- LockfileParsingError
""" """
@@ -41,3 +42,7 @@ class ExtraNotFoundError(ToxPoetryInstallerException):
class LockedDepsRequiredError(ToxPoetryInstallerException): class LockedDepsRequiredError(ToxPoetryInstallerException):
"""Environment cannot specify unlocked dependencies when locked dependencies are required""" """Environment cannot specify unlocked dependencies when locked dependencies are required"""
class LockfileParsingError(ToxPoetryInstallerException):
"""Failed to load or parse the Poetry lockfile"""

View File

@@ -1,32 +1,38 @@
"""Helper functions for the :func:`tox_on_install` hook""" """Helper functions for the :func:`tox_on_install` hook"""
import collections import collections
import concurrent.futures import concurrent.futures
import contextlib import contextlib
import typing import datetime
from datetime import datetime import pathlib
from pathlib import Path
from typing import Collection from typing import Collection
from typing import Dict from typing import Dict
from typing import List from typing import List
from typing import Sequence from typing import Sequence
from typing import Set from typing import Set
from poetry.core.packages.dependency import Dependency as PoetryDependency import cleo.io.null_io
from poetry.core.packages.package import Package as PoetryPackage import packaging.utils
from tox.tox_env.api import ToxEnv as ToxVirtualEnv import poetry.config.config
from tox.tox_env.package import PackageToxEnv import poetry.core.packages.dependency
import poetry.core.packages.package
import poetry.factory
import poetry.installation.executor
import poetry.installation.operations.install
import poetry.poetry
import poetry.utils.env
import tox.tox_env.api
import tox.tox_env.package
from tox_poetry_installer import constants from tox_poetry_installer import constants
from tox_poetry_installer import exceptions from tox_poetry_installer import exceptions
from tox_poetry_installer import logger from tox_poetry_installer import logger
if typing.TYPE_CHECKING:
from tox_poetry_installer import _poetry
PackageMap = Dict[str, List[PoetryPackage]] PackageMap = Dict[str, List[poetry.core.packages.package.Package]]
def check_preconditions(venv: ToxVirtualEnv) -> "_poetry.Poetry": def check_preconditions(venv: tox.tox_env.api.ToxEnv) -> poetry.poetry.Poetry:
"""Check that the local project environment meets expectations""" """Check that the local project environment meets expectations"""
# Skip running the plugin for the provisioning environment. The provisioned environment, # Skip running the plugin for the provisioning environment. The provisioned environment,
@@ -34,13 +40,11 @@ def check_preconditions(venv: ToxVirtualEnv) -> "_poetry.Poetry":
# handled by Tox and is out of scope for this plugin. Since one of the ways to install this # handled by Tox and is out of scope for this plugin. Since one of the ways to install this
# plugin in the first place is via the Tox provisioning environment, it quickly becomes a # plugin in the first place is via the Tox provisioning environment, it quickly becomes a
# chicken-and-egg problem. # chicken-and-egg problem.
if isinstance(venv, PackageToxEnv): if isinstance(venv, tox.tox_env.package.PackageToxEnv):
raise exceptions.SkipEnvironment(f"Skipping Tox provisioning env '{venv.name}'") raise exceptions.SkipEnvironment(f"Skipping Tox provisioning env '{venv.name}'")
from tox_poetry_installer import _poetry
try: try:
return _poetry.Factory().create_poetry(venv.core["tox_root"]) return poetry.factory.Factory().create_poetry(venv.core["tox_root"])
# Support running the plugin when the current tox project does not use Poetry for its # Support running the plugin when the current tox project does not use Poetry for its
# environment/dependency management. # environment/dependency management.
# #
@@ -55,9 +59,9 @@ def check_preconditions(venv: ToxVirtualEnv) -> "_poetry.Poetry":
def identify_transients( def identify_transients(
dep_name: str, dep_name: str,
packages: PackageMap, packages: PackageMap,
venv: "_poetry.VirtualEnv", venv: poetry.utils.env.VirtualEnv,
allow_missing: Sequence[str] = (), allow_missing: Sequence[str] = (),
) -> List[PoetryPackage]: ) -> List[poetry.core.packages.package.Package]:
"""Using a pool of packages, identify all transient dependencies of a given package name """Using a pool of packages, identify all transient dependencies of a given package name
:param dep_name: Either the Poetry dependency or the dependency's bare package name to recursively :param dep_name: Either the Poetry dependency or the dependency's bare package name to recursively
@@ -74,10 +78,12 @@ def identify_transients(
""" """
searched: Set[str] = set() searched: Set[str] = set()
def _transients(transient: PoetryDependency) -> List[PoetryPackage]: def _transients(
transient: poetry.core.packages.dependency.Dependency,
) -> List[poetry.core.packages.package.Package]:
searched.add(transient.name) searched.add(transient.name)
results: List[PoetryPackage] = [] results: List[poetry.core.packages.package.Package] = []
for option in packages[transient.name]: for option in packages[transient.name]:
if venv.is_valid_for_marker(option.to_dependency().marker): if venv.is_valid_for_marker(option.to_dependency().marker):
for requirement in option.requires: for requirement in option.requires:
@@ -126,38 +132,43 @@ def identify_transients(
def find_project_deps( def find_project_deps(
packages: PackageMap, packages: PackageMap,
venv: "_poetry.VirtualEnv", venv: poetry.utils.env.VirtualEnv,
poetry: "_poetry.Poetry", project: poetry.poetry.Poetry,
extras: Sequence[str] = (), extras: Sequence[str] = (),
) -> List[PoetryPackage]: ) -> List[poetry.core.packages.package.Package]:
"""Find the root project dependencies """Find the root project dependencies
Recursively identify the dependencies of the root project package Recursively identify the dependencies of the root project package
:param packages: Mapping of all locked package names to their corresponding package object :param packages: Mapping of all locked package names to their corresponding package object
:param venv: Poetry virtual environment to use for package compatibility checks :param venv: Poetry virtual environment to use for package compatibility checks
:param poetry: Poetry object for the current project :param project: Poetry object for the current project
:param extras: Sequence of extra names to include the dependencies of :param extras: Sequence of extra names to include the dependencies of
""" """
required_dep_names = [ required_dep_names = [
item.name for item in poetry.package.requires if not item.is_optional() item.name for item in project.package.requires if not item.is_optional()
] ]
extra_dep_names: List[str] = [] extra_dep_names: List[str] = []
for extra in extras: for extra in extras:
logger.info(f"Processing project extra '{extra}'") logger.info(f"Processing project extra '{extra}'")
try: try:
extra_dep_names += [item.name for item in poetry.package.extras[extra]] extra_dep_names += [
item.name
for item in project.package.extras[
packaging.utils.NormalizedName(extra)
]
]
except KeyError: except KeyError:
raise exceptions.ExtraNotFoundError( raise exceptions.ExtraNotFoundError(
f"Environment specifies project extra '{extra}' which was not found in the lockfile" f"Environment specifies project extra '{extra}' which was not found in the lockfile"
) from None ) from None
dependencies: List[PoetryPackage] = [] dependencies: List[poetry.core.packages.package.Package] = []
for dep_name in required_dep_names + extra_dep_names: for dep_name in required_dep_names + extra_dep_names:
dependencies += identify_transients( dependencies += identify_transients(
dep_name.lower(), packages, venv, allow_missing=[poetry.package.name] dep_name.lower(), packages, venv, allow_missing=[project.package.name]
) )
return dedupe_packages(dependencies) return dedupe_packages(dependencies)
@@ -165,24 +176,24 @@ def find_project_deps(
def find_additional_deps( def find_additional_deps(
packages: PackageMap, packages: PackageMap,
venv: "_poetry.VirtualEnv", venv: poetry.utils.env.VirtualEnv,
poetry: "_poetry.Poetry", project: poetry.poetry.Poetry,
dep_names: Sequence[str], dep_names: Sequence[str],
) -> List[PoetryPackage]: ) -> List[poetry.core.packages.package.Package]:
"""Find additional dependencies """Find additional dependencies
Recursively identify the dependencies of an arbitrary list of package names Recursively identify the dependencies of an arbitrary list of package names
:param packages: Mapping of all locked package names to their corresponding package object :param packages: Mapping of all locked package names to their corresponding package object
:param venv: Poetry virtual environment to use for package compatibility checks :param venv: Poetry virtual environment to use for package compatibility checks
:param poetry: Poetry object for the current project :param project: Poetry object for the current project
:param dep_names: Sequence of additional dependency names to recursively find the transient :param dep_names: Sequence of additional dependency names to recursively find the transient
dependencies for dependencies for
""" """
dependencies: List[PoetryPackage] = [] dependencies: List[poetry.core.packages.package.Package] = []
for dep_name in dep_names: for dep_name in dep_names:
dependencies += identify_transients( dependencies += identify_transients(
dep_name.lower(), packages, venv, allow_missing=[poetry.package.name] dep_name.lower(), packages, venv, allow_missing=[project.package.name]
) )
return dedupe_packages(dependencies) return dedupe_packages(dependencies)
@@ -191,9 +202,9 @@ def find_additional_deps(
def find_group_deps( def find_group_deps(
group: str, group: str,
packages: PackageMap, packages: PackageMap,
venv: "_poetry.VirtualEnv", venv: poetry.utils.env.VirtualEnv,
poetry: "_poetry.Poetry", project: poetry.poetry.Poetry,
) -> List[PoetryPackage]: ) -> List[poetry.core.packages.package.Package]:
"""Find the dependencies belonging to a dependency group """Find the dependencies belonging to a dependency group
Recursively identify the Poetry dev dependencies Recursively identify the Poetry dev dependencies
@@ -201,13 +212,17 @@ def find_group_deps(
:param group: Name of the dependency group from the project's ``pyproject.toml`` :param group: Name of the dependency group from the project's ``pyproject.toml``
:param packages: Mapping of all locked package names to their corresponding package object :param packages: Mapping of all locked package names to their corresponding package object
:param venv: Poetry virtual environment to use for package compatibility checks :param venv: Poetry virtual environment to use for package compatibility checks
:param poetry: Poetry object for the current project :param project: Poetry object for the current project
""" """
return find_additional_deps( return find_additional_deps(
packages, packages,
venv, venv,
poetry, project,
poetry.pyproject.data["tool"]["poetry"] # the type ignore here is due to the difficulties around getting nested data
# from the inherrently unstructured toml structure (which necessarily is flexibly
# typed) but in a situation where there is a meta-structure applied to it (i.e. a
# pyproject.toml structure).
project.pyproject.data["tool"]["poetry"] # type: ignore
.get("group", {}) .get("group", {})
.get(group, {}) .get(group, {})
.get("dependencies", {}) .get("dependencies", {})
@@ -216,66 +231,38 @@ def find_group_deps(
def find_dev_deps( def find_dev_deps(
packages: PackageMap, venv: "_poetry.VirtualEnv", poetry: "_poetry.Poetry" packages: PackageMap,
) -> List[PoetryPackage]: venv: poetry.utils.env.VirtualEnv,
project: poetry.poetry.Poetry,
) -> List[poetry.core.packages.package.Package]:
"""Find the dev dependencies """Find the dev dependencies
Recursively identify the Poetry dev dependencies Recursively identify the Poetry dev dependencies
:param packages: Mapping of all locked package names to their corresponding package object :param packages: Mapping of all locked package names to their corresponding package object
:param venv: Poetry virtual environment to use for package compatibility checks :param venv: Poetry virtual environment to use for package compatibility checks
:param poetry: Poetry object for the current project :param project: Poetry object for the current project
""" """
dev_group_deps = find_group_deps("dev", packages, venv, poetry) dev_group_deps = find_group_deps("dev", packages, venv, project)
# Legacy pyproject.toml poetry format: # Legacy pyproject.toml poetry format:
legacy_dev_group_deps = find_additional_deps( legacy_dev_group_deps = find_additional_deps(
packages, packages,
venv, venv,
poetry, project,
poetry.pyproject.data["tool"]["poetry"].get("dev-dependencies", {}).keys(), # the type ignore here is due to the difficulties around getting nested data
# from the inherrently unstructured toml structure (which necessarily is flexibly
# typed) but in a situation where there is a meta-structure applied to it (i.e. a
# pyproject.toml structure).
project.pyproject.data["tool"]["poetry"].get("dev-dependencies", {}).keys(), # type: ignore
) )
# Poetry 1.2 unions these two toml sections. # Poetry 1.2 unions these two toml sections.
return dedupe_packages(dev_group_deps + legacy_dev_group_deps) return dedupe_packages(dev_group_deps + legacy_dev_group_deps)
def install_package(
poetry: "_poetry.Poetry",
venv: ToxVirtualEnv,
packages: Collection["_poetry.PoetryPackage"],
parallels: int = 0,
):
"""Install a bunch of packages to a virtualenv
:param poetry: Poetry object the packages were sourced from
:param venv: Tox virtual environment to install the packages to
:param packages: List of packages to install to the virtual environment
:param parallels: Number of parallel processes to use for installing dependency packages, or
``None`` to disable parallelization.
"""
from tox_poetry_installer import _poetry
logger.info(f"Installing {len(packages)} packages to environment at {venv.env_dir}")
install_executor = _poetry.Executor(
env=convert_virtualenv(venv),
io=_poetry.NullIO(),
pool=poetry.pool,
config=_poetry.Config(),
)
installed: Set[_poetry.PoetryPackage] = set()
def logged_install(dependency: _poetry.PoetryPackage) -> None:
start = datetime.now()
logger.debug(f"Installing {dependency}")
install_executor.execute([_poetry.Install(package=dependency)])
end = datetime.now()
logger.debug(f"Finished installing {dependency} in {end - start}")
@contextlib.contextmanager @contextlib.contextmanager
def _optional_parallelize(): def _optional_parallelize(parallels: int):
"""A bit of cheat, really """A bit of cheat, really
A context manager that exposes a common interface for the caller that optionally A context manager that exposes a common interface for the caller that optionally
@@ -283,14 +270,48 @@ def install_package(
the ``parallels`` parameter. the ``parallels`` parameter.
""" """
if parallels > 0: if parallels > 0:
with concurrent.futures.ThreadPoolExecutor( with concurrent.futures.ThreadPoolExecutor(max_workers=parallels) as executor:
max_workers=parallels
) as executor:
yield executor.submit yield executor.submit
else: else:
yield lambda func, arg: func(arg) yield lambda func, arg: func(arg)
with _optional_parallelize() as executor:
def install_package(
project: poetry.poetry.Poetry,
venv: tox.tox_env.api.ToxEnv,
packages: Collection[poetry.core.packages.package.Package],
parallels: int = 0,
):
"""Install a bunch of packages to a virtualenv
:param project: Poetry object the packages were sourced from
:param venv: Tox virtual environment to install the packages to
:param packages: List of packages to install to the virtual environment
:param parallels: Number of parallel processes to use for installing dependency packages, or
``None`` to disable parallelization.
"""
logger.info(f"Installing {len(packages)} packages to environment at {venv.env_dir}")
install_executor = poetry.installation.executor.Executor(
env=convert_virtualenv(venv),
io=cleo.io.null_io.NullIO(),
pool=project.pool,
config=poetry.config.config.Config(),
)
installed: Set[poetry.core.packages.package.Package] = set()
def logged_install(dependency: poetry.core.packages.package.Package) -> None:
start = datetime.datetime.now()
logger.debug(f"Installing {dependency}")
install_executor.execute(
[poetry.installation.operations.install.Install(package=dependency)]
)
end = datetime.datetime.now()
logger.debug(f"Finished installing {dependency} in {end - start}")
with _optional_parallelize(parallels) as executor:
futures = [] futures = []
for dependency in packages: for dependency in packages:
if dependency not in installed: if dependency not in installed:
@@ -310,36 +331,36 @@ def install_package(
future.result() future.result()
def dedupe_packages(packages: Sequence[PoetryPackage]) -> List[PoetryPackage]: def dedupe_packages(
"""Deduplicates a sequence of PoetryPackages while preserving ordering packages: Sequence[poetry.core.packages.package.Package],
) -> List[poetry.core.packages.package.Package]:
"""Deduplicates a sequence of Packages while preserving ordering
Adapted from StackOverflow: https://stackoverflow.com/a/480227 Adapted from StackOverflow: https://stackoverflow.com/a/480227
""" """
seen: Set[PoetryPackage] = set() seen: Set[poetry.core.packages.package.Package] = set()
# Make this faster, avoid method lookup below # Make this faster, avoid method lookup below
seen_add = seen.add seen_add = seen.add
return [p for p in packages if not (p in seen or seen_add(p))] return [item for item in packages if not (item in seen or seen_add(item))]
def convert_virtualenv(venv: ToxVirtualEnv) -> "_poetry.VirtualEnv": def convert_virtualenv(venv: tox.tox_env.api.ToxEnv) -> poetry.utils.env.VirtualEnv:
"""Convert a Tox venv to a Poetry venv """Convert a Tox venv to a Poetry venv
:param venv: Tox ``VirtualEnv`` object representing a tox virtual environment :param venv: Tox ``VirtualEnv`` object representing a tox virtual environment
:returns: Poetry ``VirtualEnv`` object representing a poetry virtual environment :returns: Poetry ``VirtualEnv`` object representing a poetry virtual environment
""" """
from tox_poetry_installer import _poetry return poetry.utils.env.VirtualEnv(path=pathlib.Path(venv.env_dir))
return _poetry.VirtualEnv(path=Path(venv.env_dir))
def build_package_map(poetry: "_poetry.Poetry") -> PackageMap: def build_package_map(project: poetry.poetry.Poetry) -> PackageMap:
"""Build the mapping of package names to objects """Build the mapping of package names to objects
:param poetry: Populated poetry object to load locked packages from :param project: Populated poetry object to load locked packages from
:returns: Mapping of package names to Poetry package objects :returns: Mapping of package names to Poetry package objects
""" """
packages = collections.defaultdict(list) packages = collections.defaultdict(list)
for package in poetry.locker.locked_repository().packages: for package in project.locker.locked_repository().packages:
packages[package.name].append(package) packages[str(package.name)].append(package)
return packages return packages

View File

@@ -1,12 +1,16 @@
"""Add required env configuration options to the tox INI file""" """Add required env configuration options to the tox INI file"""
from typing import List from typing import List
from tox.config.sets import EnvConfigSet import tox.config.sets
from tox.plugin import impl import tox.plugin
@impl # pylint: disable=missing-function-docstring
def tox_add_env_config(env_conf: EnvConfigSet): @tox.plugin.impl
def tox_add_env_config(
env_conf: tox.config.sets.EnvConfigSet,
):
env_conf.add_config( env_conf.add_config(
"poetry_dep_groups", "poetry_dep_groups",
of_type=List[str], of_type=List[str],

View File

@@ -1,12 +1,14 @@
"""Add additional command line arguments to tox to configure plugin behavior""" """Add additional command line arguments to tox to configure plugin behavior"""
from tox.config.cli.parser import ToxParser
from tox.plugin import impl import tox.config.cli.parser
import tox.plugin
from tox_poetry_installer import constants from tox_poetry_installer import constants
@impl # pylint: disable=missing-function-docstring
def tox_add_option(parser: ToxParser): @tox.plugin.impl
def tox_add_option(parser: tox.config.cli.parser.ToxParser):
parser.add_argument( parser.add_argument(
"--parallel-install-threads", "--parallel-install-threads",
type=int, type=int,

View File

@@ -4,10 +4,11 @@ Loads the local Poetry environment and the corresponding lockfile then pulls the
specified by the Tox environment. Finally these dependencies are installed into the Tox specified by the Tox environment. Finally these dependencies are installed into the Tox
environment using the Poetry ``PipInstaller`` backend. environment using the Poetry ``PipInstaller`` backend.
""" """
from itertools import chain
from tox.plugin import impl import itertools
from tox.tox_env.api import ToxEnv as ToxVirtualEnv
import tox.plugin
import tox.tox_env.api
from tox_poetry_installer import exceptions from tox_poetry_installer import exceptions
from tox_poetry_installer import logger from tox_poetry_installer import logger
@@ -21,10 +22,9 @@ from tox_poetry_installer.hooks._tox_on_install_helpers import find_project_deps
from tox_poetry_installer.hooks._tox_on_install_helpers import install_package from tox_poetry_installer.hooks._tox_on_install_helpers import install_package
@impl # pylint: disable=missing-function-docstring,unused-argument
def tox_on_install( @tox.plugin.impl
tox_env: ToxVirtualEnv, section: str # pylint: disable=unused-argument def tox_on_install(tox_env: tox.tox_env.api.ToxEnv, *args) -> None:
) -> None:
try: try:
poetry = check_preconditions(tox_env) poetry = check_preconditions(tox_env)
except exceptions.SkipEnvironment as err: except exceptions.SkipEnvironment as err:
@@ -41,10 +41,16 @@ def tox_on_install(
virtualenv = convert_virtualenv(tox_env) virtualenv = convert_virtualenv(tox_env)
try:
if not poetry.locker.is_fresh(): if not poetry.locker.is_fresh():
logger.warning( logger.warning(
f"The Poetry lock file is not up to date with the latest changes in {poetry.file}" f"The Poetry lock file is not up to date with the latest changes in {poetry.file}"
) )
except FileNotFoundError as err:
logger.error(f"Could not parse lockfile: {err}")
raise exceptions.LockfileParsingError(
f"Could not parse lockfile: {err}"
) from err
try: try:
if tox_env.conf["require_locked_deps"] and tox_env.conf["deps"].lines(): if tox_env.conf["require_locked_deps"] and tox_env.conf["deps"].lines():
@@ -56,7 +62,7 @@ def tox_on_install(
group_deps = dedupe_packages( group_deps = dedupe_packages(
list( list(
chain( itertools.chain(
*[ *[
find_group_deps(group, packages, virtualenv, poetry) find_group_deps(group, packages, virtualenv, poetry)
for group in tox_env.conf["poetry_dep_groups"] for group in tox_env.conf["poetry_dep_groups"]

View File

@@ -4,6 +4,7 @@ Calling ``tox.reporter.something()`` and having to format a string with the pref
gets really old fast, but more importantly it also makes the flow of the main code gets really old fast, but more importantly it also makes the flow of the main code
more difficult to follow because of the added complexity. more difficult to follow because of the added complexity.
""" """
import logging import logging
from tox_poetry_installer import constants from tox_poetry_installer import constants