Add support to the installer for parallizing dependency installs

This commit is contained in:
Ethan Paul 2021-04-16 01:55:30 -04:00
parent af40c5a87b
commit 06fcd56172
No known key found for this signature in database
GPG Key ID: D0E2CBF1245E92BF

View File

@ -2,7 +2,10 @@
# Silence this one globally to support the internal function imports for the proxied poetry module. # Silence this one globally to support the internal function imports for the proxied poetry module.
# See the docstring in 'tox_poetry_installer._poetry' for more context. # See the docstring in 'tox_poetry_installer._poetry' for more context.
# pylint: disable=import-outside-toplevel # pylint: disable=import-outside-toplevel
import concurrent.futures
import contextlib
import typing import typing
from typing import Optional
from typing import Sequence from typing import Sequence
from typing import Set from typing import Set
@ -18,13 +21,18 @@ if typing.TYPE_CHECKING:
def install( def install(
poetry: "_poetry.Poetry", venv: ToxVirtualEnv, packages: Sequence[PoetryPackage] poetry: "_poetry.Poetry",
venv: ToxVirtualEnv,
packages: Sequence[PoetryPackage],
parallels: Optional[int] = None,
): ):
"""Install a bunch of packages to a virtualenv """Install a bunch of packages to a virtualenv
:param poetry: Poetry object the packages were sourced from :param poetry: Poetry object the packages were sourced from
:param venv: Tox virtual environment to install the packages to :param venv: Tox virtual environment to install the packages to
:param packages: List of packages to install to the virtual environment :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 from tox_poetry_installer import _poetry
@ -40,14 +48,34 @@ def install(
installed: Set[PoetryPackage] = set() installed: Set[PoetryPackage] = set()
for dependency in packages: @contextlib.contextmanager
if dependency not in installed: def _optional_parallelize():
tox.reporter.verbosity2( """A bit of cheat, really
f"{constants.REPORTER_PREFIX} Installing {dependency}"
) A context manager that exposes a common interface for the caller that optionally
pip.install(dependency) enables/disables the usage of the parallel thread pooler depending on the value of
installed.add(dependency) the ``parallels`` parameter.
"""
if parallels:
with concurrent.futures.ThreadPoolExecutor(
max_workers=parallels
) as executor:
yield executor.submit
else: else:
tox.reporter.verbosity2( yield lambda func, arg: func(arg)
f"{constants.REPORTER_PREFIX} Skipping {dependency}, already installed"
) with _optional_parallelize() as executor:
for dependency in packages:
if dependency not in installed:
installed.add(dependency)
tox.reporter.verbosity2(
f"{constants.REPORTER_PREFIX} Installing {dependency}"
)
executor(pip.install, dependency)
else:
tox.reporter.verbosity2(
f"{constants.REPORTER_PREFIX} Skipping {dependency}, already installed"
)
tox.reporter.verbosity2(
f"{constants.REPORTER_PREFIX} Waiting for installs to finish..."
)