mirror of
https://github.com/enpaul/tox-poetry-installer.git
synced 2025-10-28 07:00:43 +00:00
Compare commits
42 Commits
0.8.5
...
c55ba474c7
| Author | SHA1 | Date | |
|---|---|---|---|
|
c55ba474c7
|
|||
| 2b75f74996 | |||
|
449381ca09
|
|||
|
bb44db0f9d
|
|||
|
afaf025485
|
|||
|
c984abbc2f
|
|||
|
cee49ff6c0
|
|||
|
11a478bd4e
|
|||
|
5e26a4e0de
|
|||
| c6c35636cd | |||
|
|
bc75c57126 | ||
|
|
7e5bc30b93 | ||
|
|
593f260278 | ||
|
779dd8c56f
|
|||
|
3399bbecc2
|
|||
|
dd61f8c40f
|
|||
| 447475ebe0 | |||
|
d711a17596
|
|||
|
4f69c8b3b2
|
|||
| bd102605b6 | |||
|
469cb251cf
|
|||
| 41ac5423f9 | |||
|
3388553ee0
|
|||
|
52f34cb317
|
|||
|
4c609770f1
|
|||
| d5650f0562 | |||
|
4261d45218
|
|||
|
d0842456cb
|
|||
|
b631a962b2
|
|||
|
453b575159
|
|||
| 50e1aaddcd | |||
|
|
d0efbd06b3 | ||
|
c435f1af69
|
|||
|
817ae28a23
|
|||
| 12c4ec62f2 | |||
|
|
73ddd43284 | ||
|
|
a181da95b3 | ||
|
|
e8ce2f391b | ||
|
|
c8fd6e4fc0 | ||
|
|
22012d4452 | ||
|
|
17d0272089 | ||
|
|
b54bf44dc5 |
2
.github/scripts/setup-env.sh
vendored
2
.github/scripts/setup-env.sh
vendored
@@ -8,7 +8,7 @@
|
|||||||
set -e;
|
set -e;
|
||||||
|
|
||||||
CI_CACHE=$HOME/.cache;
|
CI_CACHE=$HOME/.cache;
|
||||||
POETRY_VERSION=1.1.12;
|
POETRY_VERSION=1.3.2;
|
||||||
|
|
||||||
mkdir --parents "$CI_CACHE";
|
mkdir --parents "$CI_CACHE";
|
||||||
|
|
||||||
|
|||||||
35
.github/workflows/ci.yaml
vendored
35
.github/workflows/ci.yaml
vendored
@@ -7,12 +7,11 @@ on:
|
|||||||
branches: ["devel"]
|
branches: ["devel"]
|
||||||
jobs:
|
jobs:
|
||||||
Test:
|
Test:
|
||||||
|
name: Python ${{ matrix.python.version }}
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
strategy:
|
strategy:
|
||||||
matrix:
|
matrix:
|
||||||
python:
|
python:
|
||||||
- version: "3.6"
|
|
||||||
toxenv: py36
|
|
||||||
- version: "3.7"
|
- version: "3.7"
|
||||||
toxenv: py37
|
toxenv: py37
|
||||||
- version: "3.8"
|
- version: "3.8"
|
||||||
@@ -21,15 +20,20 @@ jobs:
|
|||||||
toxenv: py39
|
toxenv: py39
|
||||||
- version: "3.10"
|
- version: "3.10"
|
||||||
toxenv: py310
|
toxenv: py310
|
||||||
|
- version: "3.11"
|
||||||
|
toxenv: py311
|
||||||
|
fail-fast: true
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
uses: actions/checkout@v2
|
uses: actions/checkout@v2
|
||||||
|
|
||||||
- name: Install Python ${{ matrix.python.version }}
|
- name: Install Python ${{ matrix.python.version }}
|
||||||
uses: actions/setup-python@v1
|
uses: actions/setup-python@v4
|
||||||
with:
|
with:
|
||||||
python-version: ${{ matrix.python.version }}
|
python-version: ${{ matrix.python.version }}
|
||||||
|
|
||||||
- name: Configure Job Cache
|
- name: Configure Job Cache
|
||||||
uses: actions/cache@v2
|
uses: actions/cache@v3
|
||||||
with:
|
with:
|
||||||
path: |
|
path: |
|
||||||
~/.cache/pip
|
~/.cache/pip
|
||||||
@@ -39,38 +43,49 @@ jobs:
|
|||||||
# will be invalidated, and thus all packages will be redownloaded, if the
|
# will be invalidated, and thus all packages will be redownloaded, if the
|
||||||
# lockfile is updated
|
# lockfile is updated
|
||||||
key: ${{ runner.os }}-${{ matrix.python.toxenv }}-${{ hashFiles('**/poetry.lock') }}
|
key: ${{ runner.os }}-${{ matrix.python.toxenv }}-${{ hashFiles('**/poetry.lock') }}
|
||||||
|
|
||||||
- name: Configure Path
|
- name: Configure Path
|
||||||
run: echo "$HOME/.local/bin" >> $GITHUB_PATH
|
run: echo "$HOME/.local/bin" >> $GITHUB_PATH
|
||||||
|
|
||||||
- name: Configure Environment
|
- name: Configure Environment
|
||||||
run: .github/scripts/setup-env.sh
|
run: .github/scripts/setup-env.sh
|
||||||
|
|
||||||
- name: Run Toxenv ${{ matrix.python.toxenv }}
|
- name: Run Toxenv ${{ matrix.python.toxenv }}
|
||||||
run: poetry run tox -e ${{ matrix.python.toxenv }}
|
run: poetry run tox -e ${{ matrix.python.toxenv }}
|
||||||
|
|
||||||
Check:
|
Check:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
uses: actions/checkout@v2
|
uses: actions/checkout@v2
|
||||||
- name: Install Python 3.8
|
|
||||||
uses: actions/setup-python@v1
|
- name: Install Python 3.10
|
||||||
|
uses: actions/setup-python@v4
|
||||||
with:
|
with:
|
||||||
python-version: 3.8
|
python-version: "3.10"
|
||||||
|
|
||||||
- name: Configure Job Cache
|
- name: Configure Job Cache
|
||||||
uses: actions/cache@v2
|
uses: actions/cache@v3
|
||||||
with:
|
with:
|
||||||
path: |
|
path: |
|
||||||
~/.cache/pip
|
~/.cache/pip
|
||||||
~/.cache/pypoetry/cache
|
~/.cache/pypoetry/cache
|
||||||
~/.poetry
|
~/.poetry
|
||||||
# Hardcoded 'py38' slug here lets this cache piggyback on the 'py38' cache
|
# Hardcoded 'py310' slug here lets this cache piggyback on the 'py310' cache
|
||||||
# that is generated for the tests above
|
# that is generated for the tests above
|
||||||
key: ${{ runner.os }}-py38-${{ hashFiles('**/poetry.lock') }}
|
key: ${{ runner.os }}-py310-${{ hashFiles('**/poetry.lock') }}
|
||||||
|
|
||||||
- name: Configure Path
|
- name: Configure Path
|
||||||
run: echo "$HOME/.local/bin" >> $GITHUB_PATH
|
run: echo "$HOME/.local/bin" >> $GITHUB_PATH
|
||||||
|
|
||||||
- name: Configure Environment
|
- name: Configure Environment
|
||||||
run: .github/scripts/setup-env.sh
|
run: .github/scripts/setup-env.sh
|
||||||
|
|
||||||
- name: Run Static Analysis Checks
|
- name: Run Static Analysis Checks
|
||||||
run: poetry run tox -e static
|
run: poetry run tox -e static
|
||||||
|
|
||||||
- name: Run Static Analysis Checks (Tests)
|
- name: Run Static Analysis Checks (Tests)
|
||||||
run: poetry run tox -e static-tests
|
run: poetry run tox -e static-tests
|
||||||
|
|
||||||
- name: Run Security Checks
|
- name: Run Security Checks
|
||||||
run: poetry run tox -e security
|
run: poetry run tox -e security
|
||||||
|
|||||||
99
CHANGELOG.md
99
CHANGELOG.md
@@ -2,6 +2,58 @@
|
|||||||
|
|
||||||
See also: [Github Release Page](https://github.com/enpaul/tox-poetry-installer/releases).
|
See also: [Github Release Page](https://github.com/enpaul/tox-poetry-installer/releases).
|
||||||
|
|
||||||
|
## Version 0.10.3
|
||||||
|
|
||||||
|
View this release on:
|
||||||
|
[Github](https://github.com/enpaul/tox-poetry-installer/releases/tag/0.10.3),
|
||||||
|
[PyPI](https://pypi.org/project/tox-poetry-installer/0.10.3/)
|
||||||
|
|
||||||
|
- Update Poetry requirement to exclude usage with incompatible 1.5 release
|
||||||
|
|
||||||
|
## Version 0.10.2
|
||||||
|
|
||||||
|
View this release on:
|
||||||
|
[Github](https://github.com/enpaul/tox-poetry-installer/releases/tag/0.10.2),
|
||||||
|
[PyPI](https://pypi.org/project/tox-poetry-installer/0.10.2/)
|
||||||
|
|
||||||
|
- Update documentation with best practices and Poetry 1.2+ command syntax
|
||||||
|
- Fix failed install of sdist package not raising an exception in multi-threaded mode.
|
||||||
|
Contributed by [chriskuehl](https://github.com/chriskuehl) (#86)
|
||||||
|
|
||||||
|
## Version 0.10.1
|
||||||
|
|
||||||
|
View this release on:
|
||||||
|
[Github](https://github.com/enpaul/tox-poetry-installer/releases/tag/0.10.1),
|
||||||
|
[PyPI](https://pypi.org/project/tox-poetry-installer/0.10.1/)
|
||||||
|
|
||||||
|
- Add PyPI classifier for Python-3.11 compatibility
|
||||||
|
- Add CI support for Python-3.11
|
||||||
|
- Add support for Poetry-1.3.x (#83)
|
||||||
|
|
||||||
|
## Version 0.10.0
|
||||||
|
|
||||||
|
View this release on:
|
||||||
|
[Github](https://github.com/enpaul/tox-poetry-installer/releases/tag/0.10.0),
|
||||||
|
[PyPI](https://pypi.org/project/tox-poetry-installer/0.10.0/)
|
||||||
|
|
||||||
|
- Add `poetry_dep_groups` option to support installing groups of Poetry dependencies.
|
||||||
|
Contributed by [Oshmoun](https://github.com/oshmoun) (#76)
|
||||||
|
- Deprecate `install_dev_deps` option
|
||||||
|
|
||||||
|
## Version 0.9.0
|
||||||
|
|
||||||
|
View this release on:
|
||||||
|
[Github](https://github.com/enpaul/tox-poetry-installer/releases/tag/0.9.0),
|
||||||
|
[PyPI](https://pypi.org/project/tox-poetry-installer/0.9.0/)
|
||||||
|
|
||||||
|
- Add support for Poetry-1.2.x. Contributed by [Justin Wood](https://github.com/Callek)
|
||||||
|
(#73)
|
||||||
|
- Update Black formatting to stable release version
|
||||||
|
- Remove support for Python-3.6
|
||||||
|
- Remove support for Poetry-1.1.x
|
||||||
|
- Fix installing dependencies multiple times when transient dependencies are duplicated in
|
||||||
|
the dependency tree
|
||||||
|
|
||||||
## Version 0.8.5
|
## Version 0.8.5
|
||||||
|
|
||||||
View this release on:
|
View this release on:
|
||||||
@@ -16,8 +68,8 @@ View this release on:
|
|||||||
[Github](https://github.com/enpaul/tox-poetry-installer/releases/tag/0.8.4),
|
[Github](https://github.com/enpaul/tox-poetry-installer/releases/tag/0.8.4),
|
||||||
[PyPI](https://pypi.org/project/tox-poetry-installer/0.8.4/)
|
[PyPI](https://pypi.org/project/tox-poetry-installer/0.8.4/)
|
||||||
|
|
||||||
- Fix issue where incompatible package versions were selected for installation when multiple
|
- Fix issue where incompatible package versions were selected for installation when
|
||||||
package versions were in the lockfile
|
multiple package versions were in the lockfile
|
||||||
|
|
||||||
## Version 0.8.3
|
## Version 0.8.3
|
||||||
|
|
||||||
@@ -34,9 +86,9 @@ View this release on:
|
|||||||
[PyPI](https://pypi.org/project/tox-poetry-installer/0.8.2/)
|
[PyPI](https://pypi.org/project/tox-poetry-installer/0.8.2/)
|
||||||
|
|
||||||
- Improve debug-level logging for package installation, and time how long installing each
|
- Improve debug-level logging for package installation, and time how long installing each
|
||||||
package takes. Contributed by [Rebecca
|
package takes. Contributed by [Rebecca Turner](https://github.com/9999years) (#63).
|
||||||
Turner](https://github.com/9999years).
|
- Fix crash caused by the package-under-test depending on Poetry's unsafe dependencies
|
||||||
- Fix crash caused by the package-under-test depending on Poetry's unsafe dependencies ([#65](https://github.com/enpaul/tox-poetry-installer/issues/65))
|
([#65](https://github.com/enpaul/tox-poetry-installer/issues/65))
|
||||||
|
|
||||||
## Version 0.8.1
|
## Version 0.8.1
|
||||||
|
|
||||||
@@ -86,7 +138,8 @@ View this release on:
|
|||||||
process
|
process
|
||||||
- Add integration with Poetry's compatibility
|
- Add integration with Poetry's compatibility
|
||||||
[`Marker`](https://github.com/python-poetry/poetry-core/blob/master/poetry/core/version/markers.py)
|
[`Marker`](https://github.com/python-poetry/poetry-core/blob/master/poetry/core/version/markers.py)
|
||||||
object system for determining package compatibility with the current platform ([#43](https://github.com/enpaul/tox-poetry-installer/issues/43))
|
object system for determining package compatibility with the current platform
|
||||||
|
([#43](https://github.com/enpaul/tox-poetry-installer/issues/43))
|
||||||
- Add missing PyPI classifier for Python 3
|
- Add missing PyPI classifier for Python 3
|
||||||
|
|
||||||
## Version 0.6.3
|
## Version 0.6.3
|
||||||
@@ -111,8 +164,8 @@ View this release on:
|
|||||||
[CVE-2020-29651](https://nvd.nist.gov/vuln/detail/CVE-2020-29651)
|
[CVE-2020-29651](https://nvd.nist.gov/vuln/detail/CVE-2020-29651)
|
||||||
- Fix dependency identification failing when the package under test is a transient
|
- Fix dependency identification failing when the package under test is a transient
|
||||||
dependency of a locked dependency specified for installation
|
dependency of a locked dependency specified for installation
|
||||||
- Fix `AttributeError` being raised while creating the Tox self-provisioned environment when
|
- Fix `AttributeError` being raised while creating the Tox self-provisioned environment
|
||||||
using either the
|
when using either the
|
||||||
[`minversion`](https://tox.readthedocs.io/en/latest/config.html#conf-minversion) or
|
[`minversion`](https://tox.readthedocs.io/en/latest/config.html#conf-minversion) or
|
||||||
[`requires`](https://tox.readthedocs.io/en/latest/config.html#conf-requires) Tox config
|
[`requires`](https://tox.readthedocs.io/en/latest/config.html#conf-requires) Tox config
|
||||||
options
|
options
|
||||||
@@ -127,8 +180,8 @@ View this release on:
|
|||||||
installation problems
|
installation problems
|
||||||
- Fix regression around handling of Poetry's unsafe packages when the unsafe package is a
|
- Fix regression around handling of Poetry's unsafe packages when the unsafe package is a
|
||||||
transient dependency ([#33](https://github.com/enpaul/tox-poetry-installer/issues/33))
|
transient dependency ([#33](https://github.com/enpaul/tox-poetry-installer/issues/33))
|
||||||
- Fix handling of Poetry's unsafe packages when the unsafe package is a primary (environment
|
- Fix handling of Poetry's unsafe packages when the unsafe package is a primary
|
||||||
or package) dependency
|
(environment or package) dependency
|
||||||
|
|
||||||
## Version 0.6.0
|
## Version 0.6.0
|
||||||
|
|
||||||
@@ -152,7 +205,8 @@ View this release on:
|
|||||||
[Github](https://github.com/enpaul/tox-poetry-installer/releases/tag/0.5.2),
|
[Github](https://github.com/enpaul/tox-poetry-installer/releases/tag/0.5.2),
|
||||||
[PyPI](https://pypi.org/project/tox-poetry-installer/0.5.2/)
|
[PyPI](https://pypi.org/project/tox-poetry-installer/0.5.2/)
|
||||||
|
|
||||||
- Fix always attempting to install dependencies with incompatible python version constraints
|
- Fix always attempting to install dependencies with incompatible python version
|
||||||
|
constraints
|
||||||
- Fix always attempting to install dependencies with incompatible python platforms
|
- Fix always attempting to install dependencies with incompatible python platforms
|
||||||
|
|
||||||
## Version 0.5.1
|
## Version 0.5.1
|
||||||
@@ -174,8 +228,8 @@ View this release on:
|
|||||||
|
|
||||||
- Add option `locked_deps` to better support both locked and unlocked dependencies in a
|
- Add option `locked_deps` to better support both locked and unlocked dependencies in a
|
||||||
single environment
|
single environment
|
||||||
- Add blocking functionality when using `require_locked_deps = true` to prevent other hooks
|
- Add blocking functionality when using `require_locked_deps = true` to prevent other
|
||||||
from running after this one
|
hooks from running after this one
|
||||||
- Update documentation to include new configuration options and errors
|
- Update documentation to include new configuration options and errors
|
||||||
- Update documentation to improve future maintainability
|
- Update documentation to improve future maintainability
|
||||||
- Update module structure to move from single-file module to multi-file directory module
|
- Update module structure to move from single-file module to multi-file directory module
|
||||||
@@ -199,7 +253,8 @@ View this release on:
|
|||||||
[PyPI](https://pypi.org/project/tox-poetry-installer/0.3.1/)
|
[PyPI](https://pypi.org/project/tox-poetry-installer/0.3.1/)
|
||||||
|
|
||||||
- Fix error when installing an environment with no extras specified in the configuration
|
- Fix error when installing an environment with no extras specified in the configuration
|
||||||
- Fix problem where only the dependencies of the sequentially last extra would be installed
|
- Fix problem where only the dependencies of the sequentially last extra would be
|
||||||
|
installed
|
||||||
- Fix regression causing no project dependencies to be installed
|
- Fix regression causing no project dependencies to be installed
|
||||||
|
|
||||||
## Version 0.3.0
|
## Version 0.3.0
|
||||||
@@ -221,7 +276,8 @@ View this release on:
|
|||||||
[Github](https://github.com/enpaul/tox-poetry-installer/releases/tag/0.2.4),
|
[Github](https://github.com/enpaul/tox-poetry-installer/releases/tag/0.2.4),
|
||||||
[PyPI](https://pypi.org/project/tox-poetry-installer/0.2.4/)
|
[PyPI](https://pypi.org/project/tox-poetry-installer/0.2.4/)
|
||||||
|
|
||||||
- Fix support for Poetry-1.1 ([#2](https://github.com/enpaul/tox-poetry-installer/issues/2))
|
- Fix support for Poetry-1.1
|
||||||
|
([#2](https://github.com/enpaul/tox-poetry-installer/issues/2))
|
||||||
- Include tests in sdist ([#8](https://github.com/enpaul/tox-poetry-installer/issues/8))
|
- Include tests in sdist ([#8](https://github.com/enpaul/tox-poetry-installer/issues/8))
|
||||||
|
|
||||||
## Version 0.2.3
|
## Version 0.2.3
|
||||||
@@ -230,8 +286,10 @@ View this release on:
|
|||||||
[Github](https://github.com/enpaul/tox-poetry-installer/releases/tag/0.2.3),
|
[Github](https://github.com/enpaul/tox-poetry-installer/releases/tag/0.2.3),
|
||||||
[PyPI](https://pypi.org/project/tox-poetry-installer/0.2.3/)
|
[PyPI](https://pypi.org/project/tox-poetry-installer/0.2.3/)
|
||||||
|
|
||||||
- Fix usage of the plugin in non-Poetry based projects ([#1](https://github.com/enpaul/tox-poetry-installer/issues/1))
|
- Fix usage of the plugin in non-Poetry based projects
|
||||||
- Fix treating dependency names as case sensitive when they shouldn't be ([#7](https://github.com/enpaul/tox-poetry-installer/issues/7))
|
([#1](https://github.com/enpaul/tox-poetry-installer/issues/1))
|
||||||
|
- Fix treating dependency names as case sensitive when they shouldn't be
|
||||||
|
([#7](https://github.com/enpaul/tox-poetry-installer/issues/7))
|
||||||
|
|
||||||
## Version 0.2.2
|
## Version 0.2.2
|
||||||
|
|
||||||
@@ -240,7 +298,8 @@ View this release on:
|
|||||||
[PyPI](https://pypi.org/project/tox-poetry-installer/0.2.2/)
|
[PyPI](https://pypi.org/project/tox-poetry-installer/0.2.2/)
|
||||||
|
|
||||||
- Fix breaking when running Tox in projects that do not use Poetry for their
|
- Fix breaking when running Tox in projects that do not use Poetry for their
|
||||||
environment/dependency management ([#1](https://github.com/enpaul/tox-poetry-installer/issues/1))
|
environment/dependency management
|
||||||
|
([#1](https://github.com/enpaul/tox-poetry-installer/issues/1))
|
||||||
|
|
||||||
## Version 0.2.1
|
## Version 0.2.1
|
||||||
|
|
||||||
@@ -291,8 +350,8 @@ View this release on:
|
|||||||
[PyPI](https://pypi.org/project/tox-poetry-installer/0.1.2/)
|
[PyPI](https://pypi.org/project/tox-poetry-installer/0.1.2/)
|
||||||
|
|
||||||
- Test trivial functionality on Python-3.6 and Python-3.7
|
- Test trivial functionality on Python-3.6 and Python-3.7
|
||||||
- Fix disagreement between `pyproject.toml` and module metadata on what the current version
|
- Fix disagreement between `pyproject.toml` and module metadata on what the current
|
||||||
is
|
version is
|
||||||
- Fix constant named for PEP-440 that should have been named for PEP-508
|
- Fix constant named for PEP-440 that should have been named for PEP-508
|
||||||
|
|
||||||
## Version 0.1.1
|
## Version 0.1.1
|
||||||
|
|||||||
@@ -27,9 +27,10 @@ Examples of unacceptable behavior include:
|
|||||||
- The use of sexualized language or imagery, and sexual attention or advances of any kind
|
- The use of sexualized language or imagery, and sexual attention or advances of any kind
|
||||||
- Trolling, insulting or derogatory comments, and personal or political attacks
|
- Trolling, insulting or derogatory comments, and personal or political attacks
|
||||||
- Public or private harassment
|
- Public or private harassment
|
||||||
- Publishing others' private information, such as a physical or email address, without their
|
- Publishing others' private information, such as a physical or email address, without
|
||||||
explicit permission
|
their explicit permission
|
||||||
- Other conduct which could reasonably be considered inappropriate in a professional setting
|
- Other conduct which could reasonably be considered inappropriate in a professional
|
||||||
|
setting
|
||||||
|
|
||||||
## Enforcement Responsibilities
|
## Enforcement Responsibilities
|
||||||
|
|
||||||
@@ -52,8 +53,8 @@ offline event.
|
|||||||
## Enforcement
|
## Enforcement
|
||||||
|
|
||||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the
|
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the
|
||||||
community leaders responsible for enforcement at \[INSERT CONTACT METHOD\]. All
|
community leaders responsible for enforcement at \[INSERT CONTACT METHOD\]. All complaints
|
||||||
complaints will be reviewed and investigated promptly and fairly.
|
will be reviewed and investigated promptly and fairly.
|
||||||
|
|
||||||
All community leaders are obligated to respect the privacy and security of the reporter of
|
All community leaders are obligated to respect the privacy and security of the reporter of
|
||||||
any incident.
|
any incident.
|
||||||
@@ -105,8 +106,8 @@ toward or disparagement of classes of individuals.
|
|||||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
|
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
|
||||||
available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
|
available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
|
||||||
|
|
||||||
Community Impact Guidelines were inspired by [Mozilla's code of conduct
|
Community Impact Guidelines were inspired by
|
||||||
enforcement ladder](https://github.com/mozilla/diversity).
|
[Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
|
||||||
|
|
||||||
For answers to common questions about this code of conduct, see the FAQ at
|
For answers to common questions about this code of conduct, see the FAQ at
|
||||||
https://www.contributor-covenant.org/faq. Translations are available at
|
https://www.contributor-covenant.org/faq. Translations are available at
|
||||||
|
|||||||
4
Makefile
4
Makefile
@@ -30,10 +30,10 @@ source: ## Build Python source distribution package
|
|||||||
poetry build --format sdist
|
poetry build --format sdist
|
||||||
|
|
||||||
test: ## Run the project testsuite(s)
|
test: ## Run the project testsuite(s)
|
||||||
poetry run tox --recreate
|
poetry run tox --recreate --parallel
|
||||||
|
|
||||||
dev: ## Create the local dev environment
|
dev: ## Create the local dev environment
|
||||||
poetry install -E poetry
|
poetry install --extras poetry --sync
|
||||||
poetry run pre-commit install
|
poetry run pre-commit install
|
||||||
|
|
||||||
publish: test wheel source ## Build and upload to pypi (requires $PYPI_API_KEY be set)
|
publish: test wheel source ## Build and upload to pypi (requires $PYPI_API_KEY be set)
|
||||||
|
|||||||
171
README.md
171
README.md
@@ -25,7 +25,6 @@ environment dependencies from the [Poetry](https://python-poetry.org/) lockfile.
|
|||||||
- [Other Notes](#other-notes)
|
- [Other Notes](#other-notes)
|
||||||
- [Unsupported Tox config options](#unsupported-tox-config-options)
|
- [Unsupported Tox config options](#unsupported-tox-config-options)
|
||||||
- [Updating locked dependencies in a testenv](#updating-locked-dependencies-in-a-testenv)
|
- [Updating locked dependencies in a testenv](#updating-locked-dependencies-in-a-testenv)
|
||||||
- [Installing unsafe dependencies](#installing-unsafe-dependencies)
|
|
||||||
- [Using with an unmanaged Poetry installation](#using-with-an-unmanaged-poetry-installation)
|
- [Using with an unmanaged Poetry installation](#using-with-an-unmanaged-poetry-installation)
|
||||||
- [Developing the Plugin](#developer-documentation)
|
- [Developing the Plugin](#developer-documentation)
|
||||||
- [Road Map](#road-map)
|
- [Road Map](#road-map)
|
||||||
@@ -34,16 +33,17 @@ See the
|
|||||||
[Changelog](https://github.com/enpaul/tox-poetry-installer/blob/devel/CHANGELOG.md) for
|
[Changelog](https://github.com/enpaul/tox-poetry-installer/blob/devel/CHANGELOG.md) for
|
||||||
release history.
|
release history.
|
||||||
|
|
||||||
*See also: [official Tox plugins](https://tox.readthedocs.io/en/latest/plugins.html), [Poetry-Dev-Dependencies Tox plugin](https://github.com/sinoroc/tox-poetry-dev-dependencies), [Poetry Tox plugin](https://github.com/tkukushkin/tox-poetry)*
|
*See also: [official Tox plugins](https://tox.readthedocs.io/en/latest/plugins.html) and
|
||||||
|
[the official Poetry documentation on using Tox](https://python-poetry.org/docs/faq/#is-tox-supported)*
|
||||||
|
|
||||||
## Feature Overview
|
## Feature Overview
|
||||||
|
|
||||||
- Manage package versions in exactly one place and with exactly one tool: Poetry.
|
- Manage package versions in exactly one place and with exactly one tool: Poetry.
|
||||||
- Ensure CI/CD and other automation tools are using the same package versions that you are
|
- Ensure CI/CD and other automation tools are using the same package versions that you are
|
||||||
in your local development environment.
|
in your local development environment.
|
||||||
- Add only the packages you need to a Tox test environment, instead of everything in your
|
- Add only the packages or custom groups you need to a Tox test environment, instead of
|
||||||
lockfile.
|
everything in your lockfile.
|
||||||
- Directly integrate with Poetry, re-using your existing package indexes and credentials
|
- Directly integrate with Poetry, re-using your existing package indexes and credentials,
|
||||||
with no additional configuration.
|
with no additional configuration.
|
||||||
- Wherever possible, built-in Tox config options are always respected and their behavior
|
- Wherever possible, built-in Tox config options are always respected and their behavior
|
||||||
kept consistent.
|
kept consistent.
|
||||||
@@ -53,17 +53,19 @@ release history.
|
|||||||
|
|
||||||
## User Documentation
|
## User Documentation
|
||||||
|
|
||||||
*This section is for users looking to integrate the plugin with their project or CI system. For information on contributing to the plugin please see the [Developer Docs](#developer-documentation)*
|
*This section is for users looking to integrate the plugin with their project or CI
|
||||||
|
system. For information on contributing to the plugin please see the
|
||||||
|
[Developer Docs](#developer-documentation)*
|
||||||
|
|
||||||
### Installing
|
### Installing
|
||||||
|
|
||||||
The recommended way to install the plugin is to add it to a project using Poetry:
|
The recommended way to install the plugin is to add it to a project using Poetry:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
poetry add tox-poetry-installer[poetry] --dev
|
poetry add -G dev tox-poetry-installer[poetry]
|
||||||
```
|
```
|
||||||
|
|
||||||
> **Note:** Always install the plugin with the `[poetry]` extra, unless you are
|
> ℹ️ **Note:** Always install the plugin with the `[poetry]` extra, unless you are
|
||||||
> [managing the Poetry installation yourself](#externally-managed-poetry-installation).
|
> [managing the Poetry installation yourself](#externally-managed-poetry-installation).
|
||||||
|
|
||||||
Alternatively, it can be installed directly to a virtual environment using Pip, though
|
Alternatively, it can be installed directly to a virtual environment using Pip, though
|
||||||
@@ -80,16 +82,16 @@ adding the below to `tox.ini`, though this is also not recommended:
|
|||||||
|
|
||||||
```ini
|
```ini
|
||||||
requires =
|
requires =
|
||||||
tox-poetry-installer[poetry] == 0.8.0
|
tox-poetry-installer[poetry] == 0.10.2
|
||||||
```
|
```
|
||||||
|
|
||||||
After installing, check that Tox recognizes the plugin by running
|
After installing, check that Tox recognizes the plugin by running
|
||||||
`poetry run tox --version`. The command should give output similar to below:
|
`poetry run tox --version`. The command should give output similar to below:
|
||||||
|
|
||||||
```
|
```
|
||||||
3.20.0 imported from .venv/lib64/python3.8/site-packages/tox/__init__.py
|
3.20.0 imported from .venv/lib64/python3.10/site-packages/tox/__init__.py
|
||||||
registered plugins:
|
registered plugins:
|
||||||
tox-poetry-installer-0.8.0 at .venv/lib64/python3.8/site-packages/tox_poetry_installer/__init__.py
|
tox-poetry-installer-0.10.2 at .venv/lib64/python3.10/site-packages/tox_poetry_installer/__init__.py
|
||||||
```
|
```
|
||||||
|
|
||||||
### Quick Start
|
### Quick Start
|
||||||
@@ -146,23 +148,24 @@ locked_deps =
|
|||||||
commands = ...
|
commands = ...
|
||||||
```
|
```
|
||||||
|
|
||||||
> **Note:** Settings configured on the main `testenv` environment are inherited by child
|
> ℹ️ **Note:** Settings configured on the main `testenv` environment are inherited by
|
||||||
> test environments (for example, `testenv:foo`). To override this, specify the setting in
|
> child test environments (for example, `testenv:foo`). To override this, specify the
|
||||||
> the child environment with a different value.
|
> setting in the child environment with a different value.
|
||||||
|
|
||||||
Alternatively, we can skip specifying all of our dependencies for a test environment in
|
Alternatively, we can skip specifying all of our dependencies for a test environment in
|
||||||
the Tox config and just install all of our Poetry dev-dependencies automatically:
|
the Tox config and install Poetry dependency groups directly:
|
||||||
|
|
||||||
```ini
|
```ini
|
||||||
[testenv]
|
[testenv]
|
||||||
description = Some very cool tests
|
description = Some very cool tests
|
||||||
require_locked_deps = true
|
require_locked_deps = true
|
||||||
install_dev_deps = true
|
poetry_dep_groups =
|
||||||
|
dev
|
||||||
commands = ...
|
commands = ...
|
||||||
```
|
```
|
||||||
|
|
||||||
> **Note:** Setting `install_dev_deps = true` on an environment that also installs the
|
> ℹ️ **Note:** The `install_dev_deps` configuration option is deprecated. See
|
||||||
> project package is functionally equivalent to running `poetry install`.
|
> [Configuration Options](#configuration-options) for more information.
|
||||||
|
|
||||||
Finally, we can also install an unlocked dependency (a dependency which doesn't take its
|
Finally, we can also install an unlocked dependency (a dependency which doesn't take its
|
||||||
version from the Poetry lockfile) into the test environment alongside the locked ones. We
|
version from the Poetry lockfile) into the test environment alongside the locked ones. We
|
||||||
@@ -190,17 +193,21 @@ All options listed below are Tox environment options and can be applied to one o
|
|||||||
environment sections of the `tox.ini` file. They cannot be applied to the global Tox
|
environment sections of the `tox.ini` file. They cannot be applied to the global Tox
|
||||||
configuration section.
|
configuration section.
|
||||||
|
|
||||||
> **Note:** Settings configured on the main `testenv` environment are inherited by child
|
> ℹ️ **Note:** Settings configured on the main `testenv` environment are inherited by
|
||||||
> test environments (for example, `testenv:foo`). To override this, specify the setting in
|
> child test environments (for example, `testenv:foo`). To override this, specify the
|
||||||
> the child environment with a different value.
|
> setting in the child environment with a different value.
|
||||||
|
|
||||||
| Option | Type | Default | Description |
|
| Option | Type | Default | Description |
|
||||||
| :--------------------- | :-----: | :-----: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
| :--------------------- | :-----: | :-----: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `locked_deps` | List | `[]` | Names of packages to install to the test environment from the Poetry lockfile. Transient dependencies (packages required by these dependencies) are automatically included. |
|
| `locked_deps` | List | `[]` | Names of packages to install to the test environment from the Poetry lockfile. Transient dependencies (packages required by these dependencies) are automatically included. |
|
||||||
| `require_locked_deps` | Boolean | False | Whether the plugin should block attempts to install unlocked dependencies to the test environment. If enabled, then the [`tox_testenv_install_deps`](https://tox.readthedocs.io/en/latest/plugins.html#tox.hookspecs.tox_testenv_install_deps) plugin hook will be intercepted and an error will be raised if the test environment has the `deps` option configured. |
|
| `require_locked_deps` | Boolean | False | Whether the plugin should block attempts to install unlocked dependencies to the test environment. If enabled, then the [`tox_testenv_install_deps`](https://tox.readthedocs.io/en/latest/plugins.html#tox.hookspecs.tox_testenv_install_deps) plugin hook will be intercepted and an error will be raised if the test environment has the `deps` option configured. |
|
||||||
| `install_dev_deps` | Boolean | False | Whether all of the Poetry dev-dependencies should be installed to the test environment. |
|
|
||||||
| `install_project_deps` | Boolean | True | Whether all of the Poetry primary dependencies for the project package should be installed to the test environment. |
|
| `install_project_deps` | Boolean | True | Whether all of the Poetry primary dependencies for the project package should be installed to the test environment. |
|
||||||
| `require_poetry` | Boolean | False | Whether Tox should be forced to fail if the plugin cannot import Poetry locally. If `False` then the plugin will be skipped for the test environment if Poetry cannot be imported. If `True` then the plugin will force the environment to error and the Tox run to fail. |
|
| `require_poetry` | Boolean | False | Whether Tox should be forced to fail if the plugin cannot import Poetry locally. If `False` then the plugin will be skipped for the test environment if Poetry cannot be imported. If `True` then the plugin will force the environment to error and the Tox run to fail. |
|
||||||
|
| `poetry_dep_groups` | List | `[]` | Names of Poetry dependency groups specified in `pyproject.toml` to install to the test environment. |
|
||||||
|
|
||||||
|
> ℹ️ **Note:** The `install_dev_deps` configuration option is deprecated and will be
|
||||||
|
> removed in version 1.0.0. Please set `poetry_dep_groups = [dev]` in `tox.ini` for
|
||||||
|
> environments that install the development dependencies.
|
||||||
|
|
||||||
### Runtime Options
|
### Runtime Options
|
||||||
|
|
||||||
@@ -211,12 +218,12 @@ of the plugin.
|
|||||||
| :--------------------------- | :-----: | :-----: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
| :--------------------------- | :-----: | :-----: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `--parallel-install-threads` | Integer | `10` | Number of worker threads to use to install dependencies in parallel. Installing in parallel with more threads can greatly speed up the install process, but can cause race conditions during install. Pass this option with the value `0` to entirely disable parallel installation. |
|
| `--parallel-install-threads` | Integer | `10` | Number of worker threads to use to install dependencies in parallel. Installing in parallel with more threads can greatly speed up the install process, but can cause race conditions during install. Pass this option with the value `0` to entirely disable parallel installation. |
|
||||||
|
|
||||||
> **Note:** The `--require-poetry` runtime option is deprecated and will be removed in
|
> ℹ️ **Note:** The `--require-poetry` runtime option is deprecated and will be removed in
|
||||||
> version 1.0.0. Please set `require_poetry = true` in `tox.ini` for environments that
|
> version 1.0.0. Please set `require_poetry = true` in `tox.ini` for environments that
|
||||||
> should fail if Poetry is not available.
|
> should fail if Poetry is not available.
|
||||||
|
|
||||||
> **Note:** The `--parallelize-locked-install` option is deprecated and will be removed in
|
> ℹ️ **Note:** The `--parallelize-locked-install` option is deprecated and will be removed
|
||||||
> version 1.0.0. Please use the `--parallel-install-threads` option.
|
> in version 1.0.0. Please use the `--parallel-install-threads` option.
|
||||||
|
|
||||||
### Errors
|
### Errors
|
||||||
|
|
||||||
@@ -233,9 +240,9 @@ error will be set to one of the "Status" values below to indicate what the error
|
|||||||
| `PoetryNotInstalledError` | Indicates that the `poetry` module could not be imported under the current runtime environment, and `require_poetry = true` was specified. |
|
| `PoetryNotInstalledError` | Indicates that the `poetry` module could not be imported under the current runtime environment, and `require_poetry = true` was specified. |
|
||||||
| `RequiresUnsafeDepError` | Indicates that the package-under-test depends on a package that Poetry has classified as unsafe and cannot be installed. |
|
| `RequiresUnsafeDepError` | Indicates that the package-under-test depends on a package that Poetry has classified as unsafe and cannot be installed. |
|
||||||
|
|
||||||
> **Note:** One or more of these errors can be caused by the `pyproject.toml` being out of
|
> ℹ️ **Note:** One or more of these errors can be caused by the `pyproject.toml` being out
|
||||||
> sync with the Poetry lockfile. If this is the case, than a warning will be logged when Tox
|
> of sync with the Poetry lockfile. If this is the case, than a warning will be logged
|
||||||
> is run.
|
> when Tox is run.
|
||||||
|
|
||||||
### Other Notes
|
### Other Notes
|
||||||
|
|
||||||
@@ -246,8 +253,8 @@ these options are made obsolete by the Poetry lockfile: either they aren't neede
|
|||||||
equivalent functionality is instead taken directly from the package details Poetry stores
|
equivalent functionality is instead taken directly from the package details Poetry stores
|
||||||
in its lockfile.
|
in its lockfile.
|
||||||
|
|
||||||
> **Note:** The unsupported Tox config options will still apply to unlocked dependencies
|
> ℹ️ **Note:** The unsupported Tox config options will still apply to unlocked
|
||||||
> being installed with the default Tox installation backend.
|
> dependencies being installed with the default Tox installation backend.
|
||||||
|
|
||||||
- [`install_command`](https://tox.readthedocs.io/en/latest/config.html#conf-install_command)
|
- [`install_command`](https://tox.readthedocs.io/en/latest/config.html#conf-install_command)
|
||||||
- [`pip_pre`](https://tox.readthedocs.io/en/latest/config.html#conf-pip_pre)
|
- [`pip_pre`](https://tox.readthedocs.io/en/latest/config.html#conf-pip_pre)
|
||||||
@@ -268,41 +275,24 @@ built-in
|
|||||||
[`--recreate`](https://tox.readthedocs.io/en/latest/example/basic.html#forcing-re-creation-of-virtual-environments)
|
[`--recreate`](https://tox.readthedocs.io/en/latest/example/basic.html#forcing-re-creation-of-virtual-environments)
|
||||||
option) for the new version to be found and installed.
|
option) for the new version to be found and installed.
|
||||||
|
|
||||||
> **Note:** To force Tox to always recreate a test environment the
|
> ℹ️ **Note:** To force Tox to always recreate a test environment the
|
||||||
> [`recreate`](https://tox.readthedocs.io/en/latest/config.html#conf-recreate) config option
|
> [`recreate`](https://tox.readthedocs.io/en/latest/config.html#conf-recreate) config
|
||||||
> can be set.
|
> option can be set.
|
||||||
|
|
||||||
#### Installing unsafe dependencies
|
|
||||||
|
|
||||||
There are several packages that cannot be installed from the lockfile because they are
|
|
||||||
excluded by Poetry itself. As a result these packages cannot be installed by this plugin
|
|
||||||
either as test environment dependencies passed directly to `locked_deps` or as a transient
|
|
||||||
dependency. When one of these packages is encountered by the plugin a warning will be
|
|
||||||
logged to the console and
|
|
||||||
**the unsafe package will not be installed to the test environment**.
|
|
||||||
|
|
||||||
This list can be found in the Poetry source code
|
|
||||||
[here](https://github.com/python-poetry/poetry/blob/master/poetry/puzzle/provider.py). As
|
|
||||||
of [Poetry 1.1.6](https://github.com/python-poetry/poetry/releases/tag/1.1.6) there are
|
|
||||||
four packages classified as "unsafe" by Poetry and excluded from the lockfile:
|
|
||||||
|
|
||||||
- `setuptools`
|
|
||||||
- `distribute`
|
|
||||||
- `pip`
|
|
||||||
- `wheel`
|
|
||||||
|
|
||||||
#### Using with an unmanaged Poetry installation
|
#### Using with an unmanaged Poetry installation
|
||||||
|
|
||||||
In CI/CD systems, automation environments, or other Python environments where the loaded
|
In CI/CD systems, automation environments, or other Python environments where the loaded
|
||||||
site packages are not managed by Poetry, it can be useful to manage the local installation
|
site packages are not managed by Poetry, it can be useful to manage the local installation
|
||||||
of Poetry externally. This also helps to avoid problems that can be caused by the
|
of Poetry externally. This also helps to avoid problems that can be caused by the
|
||||||
`--no-root`, `--no-dev`, or `--remove-untracked` arguments to the `poetry install` command
|
`--no-root`, `--without dev`, or `--sync` arguments to the `poetry install` command which,
|
||||||
which, in some situations, can cause Poetry to uninstall itself if Poetry is specified as
|
in some situations, can cause Poetry to uninstall itself if Poetry is specified as a
|
||||||
a dependency of one of the packages it is managing (like this plugin). To support these
|
dependency of one of the packages it is managing (like this plugin). To support these use
|
||||||
use cases, this plugin specifies the `poetry` package as an optional dependency that can
|
cases, this plugin specifies the `poetry` package as an optional dependency that can be
|
||||||
be installed using a setuptools extra also named `poetry`.
|
installed using a setuptools extra also named `poetry`.
|
||||||
|
|
||||||
**Critical Warning: This plugin requires Poetry to function. If the plugin is installed without the `poetry` setuptools extra then Poetry must be installed independently for the plugin to function properly.**
|
> ⚠️ **Warning:** This plugin requires Poetry to function. If the plugin is installed
|
||||||
|
> without the `poetry` setuptools extra then Poetry must be installed independently for
|
||||||
|
> the plugin to function properly.
|
||||||
|
|
||||||
To skip installing the `poetry` package as a dependency of `tox-poetry-installer`, do not
|
To skip installing the `poetry` package as a dependency of `tox-poetry-installer`, do not
|
||||||
specify the `poetry` extra when adding the plugin:
|
specify the `poetry` extra when adding the plugin:
|
||||||
@@ -310,11 +300,11 @@ specify the `poetry` extra when adding the plugin:
|
|||||||
```bash
|
```bash
|
||||||
# Adding the package without the "[poetry]" extra specifier so that
|
# Adding the package without the "[poetry]" extra specifier so that
|
||||||
# Poetry is not added as a transient dev-dependency:
|
# Poetry is not added as a transient dev-dependency:
|
||||||
poetry add tox-poetry-installer --dev
|
poetry add -G dev tox-poetry-installer
|
||||||
|
|
||||||
# Adding the package with the "[poetry]" extra specifier, so the Poetry
|
# Adding the package with the "[poetry]" extra specifier, so the Poetry
|
||||||
# package will be added to the environment and tracked in the lockfile:
|
# package will be added to the environment and tracked in the lockfile:
|
||||||
poetry add tox-poetry-installer[poetry] --dev
|
poetry add -G dev tox-poetry-installer[poetry]
|
||||||
```
|
```
|
||||||
|
|
||||||
Once the plugin is installed- either with or without the Poetry extra- you can validate
|
Once the plugin is installed- either with or without the Poetry extra- you can validate
|
||||||
@@ -330,14 +320,15 @@ python -c '\
|
|||||||
'
|
'
|
||||||
```
|
```
|
||||||
|
|
||||||
> **Note:** To force Tox to fail if Poetry is not installed, add the `require_poetry = true`
|
> ℹ️ **Note:** To force Tox to fail if Poetry is not installed, add the
|
||||||
> option to the tox `[testenv]` configuration. See the
|
> `require_poetry = true` option to the tox `[testenv]` configuration. See the
|
||||||
> [Config Options](#configuration-options) for more information.
|
> [Config Options](#configuration-options) for more information.
|
||||||
|
|
||||||
## Developer Documentation
|
## Developer Documentation
|
||||||
|
|
||||||
All project contributors and participants are expected to adhere to the
|
All project contributors and participants are expected to adhere to the
|
||||||
[Contributor Covenant Code of Conduct, v2](CODE_OF_CONDUCT.md) ([external link](https://www.contributor-covenant.org/version/2/0/code_of_conduct/)).
|
[Contributor Covenant Code of Conduct, v2](CODE_OF_CONDUCT.md)
|
||||||
|
([external link](https://www.contributor-covenant.org/version/2/0/code_of_conduct/)).
|
||||||
|
|
||||||
The `devel` branch has the latest (and potentially unstable) changes. The stable releases
|
The `devel` branch has the latest (and potentially unstable) changes. The stable releases
|
||||||
are tracked on [Github](https://github.com/enpaul/tox-poetry-installer/releases),
|
are tracked on [Github](https://github.com/enpaul/tox-poetry-installer/releases),
|
||||||
@@ -352,8 +343,8 @@ are tracked on [Github](https://github.com/enpaul/tox-poetry-installer/releases)
|
|||||||
[fork the repository](https://docs.github.com/en/enterprise/2.20/user/github/getting-started-with-github/fork-a-repo)
|
[fork the repository](https://docs.github.com/en/enterprise/2.20/user/github/getting-started-with-github/fork-a-repo)
|
||||||
and [open a pull request](https://github.com/enpaul/tox-poetry-installer/compare).
|
and [open a pull request](https://github.com/enpaul/tox-poetry-installer/compare).
|
||||||
|
|
||||||
Developing this project requires [Python 3.7+](https://www.python.org/downloads/) and
|
Developing this project requires [Python 3.10+](https://www.python.org/downloads/) and
|
||||||
[Poetry 1.0](https://python-poetry.org/docs/#installation) or later. GNU Make can
|
[Poetry 1.4](https://python-poetry.org/docs/#installation) or later. GNU Make can
|
||||||
optionally be used to quickly setup a local development environment, but this is not
|
optionally be used to quickly setup a local development environment, but this is not
|
||||||
required.
|
required.
|
||||||
|
|
||||||
@@ -368,26 +359,20 @@ git clone git@github.com:enpaul/tox-poetry-installer.git
|
|||||||
|
|
||||||
cd tox-poetry-installer/
|
cd tox-poetry-installer/
|
||||||
|
|
||||||
# Create and configure the local development environment...
|
# Create and configure the local development environment
|
||||||
# ...with make:
|
|
||||||
make dev
|
make dev
|
||||||
# ...manually:
|
|
||||||
poetry install -E poetry --remove-untracked
|
|
||||||
poetry run pre-commit install
|
|
||||||
|
|
||||||
# Run tests and CI locally...
|
# Run tests and CI locally
|
||||||
# ...with make:
|
|
||||||
make test
|
make test
|
||||||
# ...manually:
|
|
||||||
poetry run tox --recreate
|
|
||||||
|
|
||||||
# See additional make targets
|
# See additional make targets
|
||||||
make help
|
make help
|
||||||
```
|
```
|
||||||
|
|
||||||
> **Note:** The pre-commit hooks require dependencies in the Poetry environment to run. To
|
> ℹ️ **Note:** The pre-commit hooks require dependencies in the Poetry environment to run.
|
||||||
> make a commit with the pre-commit hooks, you will need to run `poetry run git commit` or,
|
> To make a commit with the pre-commit hooks, you will need to run `poetry run git commit`
|
||||||
> alternatively, [launch an environment shell](https://python-poetry.org/docs/cli/#shell).
|
> or, alternatively,
|
||||||
|
> [launch an environment shell](https://python-poetry.org/docs/cli/#shell).
|
||||||
|
|
||||||
## Road Map
|
## Road Map
|
||||||
|
|
||||||
@@ -396,35 +381,39 @@ production environments on a provisional basis only.
|
|||||||
|
|
||||||
- Beta classification was assigned with
|
- Beta classification was assigned with
|
||||||
[v0.6.0](https://github.com/enpaul/tox-poetry-installer/releases/tag/0.6.0)
|
[v0.6.0](https://github.com/enpaul/tox-poetry-installer/releases/tag/0.6.0)
|
||||||
- Stable classification will be assigned when the test suite covers an acceptable number of
|
- Stable classification will be assigned when the test suite covers an acceptable number
|
||||||
use cases
|
of use cases
|
||||||
|
|
||||||
### Path to Beta
|
### Path to Beta
|
||||||
|
|
||||||
- [x] Verify that primary package dependencies (from the `.package` env) are installed
|
- [x] Verify that primary package dependencies (from the `.package` env) are installed
|
||||||
correctly using the Poetry backend.
|
correctly using the Poetry backend.
|
||||||
- [x] Support the [`extras`](https://tox.readthedocs.io/en/latest/config.html#conf-extras) Tox
|
- [x] Support the [`extras`](https://tox.readthedocs.io/en/latest/config.html#conf-extras)
|
||||||
configuration option ([#4](https://github.com/enpaul/tox-poetry-installer/issues/4))
|
Tox configuration option ([#4](https://github.com/enpaul/tox-poetry-installer/issues/4))
|
||||||
- [x] Add per-environment Tox configuration option to fall back to default installation
|
- [x] Add per-environment Tox configuration option to fall back to default installation
|
||||||
backend.
|
backend.
|
||||||
- [ ] ~Add warnings when an unsupported Tox configuration option is detected while using the
|
- [ ] ~Add warnings when an unsupported Tox configuration option is detected while using
|
||||||
Poetry backend.~ ([#5](https://github.com/enpaul/tox-poetry-installer/issues/5))
|
the Poetry backend.~ ([#5](https://github.com/enpaul/tox-poetry-installer/issues/5))
|
||||||
- [x] Add trivial tests to ensure the project metadata is consistent between the pyproject.toml
|
- [x] Add trivial tests to ensure the project metadata is consistent between the
|
||||||
and the module constants.
|
pyproject.toml and the module constants.
|
||||||
- [x] Update to use [poetry-core](https://github.com/python-poetry/poetry-core) and improve
|
- [x] Update to use [poetry-core](https://github.com/python-poetry/poetry-core) and
|
||||||
robustness of the Tox and Poetry module imports to avoid potentially breaking API changes
|
improve robustness of the Tox and Poetry module imports to avoid potentially breaking
|
||||||
in upstream packages. ([#2](https://github.com/enpaul/tox-poetry-installer/issues/2))
|
API changes in upstream packages.
|
||||||
|
([#2](https://github.com/enpaul/tox-poetry-installer/issues/2))
|
||||||
- [ ] ~Find and implement a way to mitigate the
|
- [ ] ~Find and implement a way to mitigate the
|
||||||
[UNSAFE_DEPENDENCIES issue](https://github.com/python-poetry/poetry/issues/1584) in
|
[UNSAFE_DEPENDENCIES issue](https://github.com/python-poetry/poetry/issues/1584) in
|
||||||
Poetry.~ ([#6](https://github.com/enpaul/tox-poetry-installer/issues/6))
|
Poetry.~ ([#6](https://github.com/enpaul/tox-poetry-installer/issues/6))
|
||||||
- [x] Fix logging to make proper use of Tox's logging reporter infrastructure ([#3](https://github.com/enpaul/tox-poetry-installer/issues/3))
|
- [x] Fix logging to make proper use of Tox's logging reporter infrastructure
|
||||||
- [x] Add configuration option for installing all dev-dependencies to a testenv ([#14](https://github.com/enpaul/tox-poetry-installer/issues/14))
|
([#3](https://github.com/enpaul/tox-poetry-installer/issues/3))
|
||||||
|
- [x] Add configuration option for installing all dev-dependencies to a testenv
|
||||||
|
([#14](https://github.com/enpaul/tox-poetry-installer/issues/14))
|
||||||
|
|
||||||
### Path to Stable
|
### Path to Stable
|
||||||
|
|
||||||
Everything in Beta plus...
|
Everything in Beta plus...
|
||||||
|
|
||||||
- [ ] Fully replace dependency on `poetry` with dependency on `poetry-core` ([#2](https://github.com/enpaul/tox-poetry-installer/issues/2))
|
- [ ] Fully replace dependency on `poetry` with dependency on `poetry-core`
|
||||||
|
([#2](https://github.com/enpaul/tox-poetry-installer/issues/2))
|
||||||
- [x] Add comprehensive unit tests
|
- [x] Add comprehensive unit tests
|
||||||
- [ ] ~Add tests for each feature version of Tox between 3.8 and 3.20~
|
- [ ] ~Add tests for each feature version of Tox between 3.8 and 3.20~
|
||||||
- [x] Add tests for Python-3.6, 3.7, 3.8, and 3.9
|
- [x] Add tests for Python-3.6, 3.7, 3.8, and 3.9
|
||||||
|
|||||||
4068
poetry.lock
generated
4068
poetry.lock
generated
File diff suppressed because it is too large
Load Diff
@@ -1,6 +1,6 @@
|
|||||||
[tool.poetry]
|
[tool.poetry]
|
||||||
name = "tox-poetry-installer"
|
name = "tox-poetry-installer"
|
||||||
version = "0.8.5"
|
version = "0.10.3"
|
||||||
license = "MIT"
|
license = "MIT"
|
||||||
authors = ["Ethan Paul <24588726+enpaul@users.noreply.github.com>"]
|
authors = ["Ethan Paul <24588726+enpaul@users.noreply.github.com>"]
|
||||||
description = "A plugin for Tox that lets you install test environment dependencies from the Poetry lockfile"
|
description = "A plugin for Tox that lets you install test environment dependencies from the Poetry lockfile"
|
||||||
@@ -23,11 +23,11 @@ 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.6",
|
|
||||||
"Programming Language :: Python :: 3.7",
|
"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 :: Implementation :: CPython",
|
"Programming Language :: Python :: Implementation :: CPython",
|
||||||
]
|
]
|
||||||
|
|
||||||
@@ -35,33 +35,39 @@ classifiers = [
|
|||||||
poetry_installer = "tox_poetry_installer"
|
poetry_installer = "tox_poetry_installer"
|
||||||
|
|
||||||
[tool.poetry.extras]
|
[tool.poetry.extras]
|
||||||
poetry = ["poetry"]
|
poetry = ["poetry", "cleo"]
|
||||||
|
|
||||||
[tool.poetry.dependencies]
|
[tool.poetry.dependencies]
|
||||||
python = "^3.6.1"
|
python = "^3.7"
|
||||||
poetry = {version = ">=1.0.0,<1.2", optional = true}
|
cleo = {version = ">=1.0,<3.0", optional = true}
|
||||||
poetry-core = "^1.0.0"
|
poetry = {version = ">=1.2.0,<1.5.0", optional = true}
|
||||||
|
poetry-core = "^1.1.0"
|
||||||
tox = "^3.8.0"
|
tox = "^3.8.0"
|
||||||
|
|
||||||
[tool.poetry.dev-dependencies]
|
[tool.poetry.group.dev.dependencies]
|
||||||
bandit = "^1.6.2"
|
bandit = "^1.6.2"
|
||||||
black = { version = "^21.12b0", allow-prereleases = true, python = "^3.7" }
|
black = "^22.3.0"
|
||||||
blacken-docs = { version = "^1.8.0", python = "^3.7" }
|
blacken-docs = "^1.8.0"
|
||||||
ipython = { version = "^7.18.1", python = "^3.7" }
|
ipython = {version = "^8.10.1", python = "^3.8"}
|
||||||
mdformat = "^0.6"
|
mdformat = "^0.7"
|
||||||
mdformat-gfm = "^0.2"
|
mdformat-gfm = "^0.3"
|
||||||
mypy = "^0.930"
|
mypy = "^0.930"
|
||||||
pre-commit = "^2.7.1"
|
pre-commit = "^2.7.1"
|
||||||
pre-commit-hooks = "^3.3.0"
|
pre-commit-hooks = "^3.3.0"
|
||||||
pylint = { version = "^2.13.0", python = "^3.7" }
|
pylint = "^2.13.0"
|
||||||
pytest = "^6.0.2"
|
pytest = "^6.0.2"
|
||||||
pytest-cov = "^2.10.1"
|
pytest-cov = "^2.10.1"
|
||||||
reorder-python-imports = "^2.3.5"
|
reorder-python-imports = "^2.3.5"
|
||||||
safety = "^1.9.0"
|
safety = "^2.2.0"
|
||||||
toml = "^0.10.1"
|
toml = "^0.10.1"
|
||||||
tox = "^3.20.0"
|
tox = "^3.20.0"
|
||||||
types-toml = "^0.10.1"
|
types-toml = "^0.10.1"
|
||||||
|
# This is a workaround for this issue with the Poetry export
|
||||||
|
# plugin which was blocking the 'security' CI check:
|
||||||
|
#
|
||||||
|
# https://github.com/python-poetry/poetry-plugin-export/issues/176
|
||||||
|
virtualenv = ">=20.15,<20.16"
|
||||||
|
|
||||||
[build-system]
|
[build-system]
|
||||||
requires = ["poetry-core>=1.0.0"]
|
requires = ["poetry-core>=1.1.0"]
|
||||||
build-backend = "poetry.core.masonry.api"
|
build-backend = "poetry.core.masonry.api"
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import poetry.installation.pip_installer
|
|||||||
import poetry.utils.env
|
import poetry.utils.env
|
||||||
import pytest
|
import pytest
|
||||||
import tox
|
import tox
|
||||||
from poetry.core.packages import Package as PoetryPackage
|
from poetry.core.packages.package import Package as PoetryPackage
|
||||||
|
|
||||||
from tox_poetry_installer import utilities
|
from tox_poetry_installer import utilities
|
||||||
|
|
||||||
|
|||||||
@@ -1,6 +1,8 @@
|
|||||||
# 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, wrong-import-order, unused-import
|
||||||
import time
|
import time
|
||||||
|
from unittest import mock
|
||||||
|
|
||||||
|
import pytest
|
||||||
import tox.venv
|
import tox.venv
|
||||||
from poetry.factory import Factory
|
from poetry.factory import Factory
|
||||||
|
|
||||||
@@ -14,7 +16,7 @@ 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)
|
poetry = Factory().create_poetry(None)
|
||||||
packages: utilities.PackageMap = {
|
packages: utilities.PackageMap = {
|
||||||
item.name: item for item in poetry.locker.locked_repository(False).packages
|
item.name: item for item in poetry.locker.locked_repository().packages
|
||||||
}
|
}
|
||||||
|
|
||||||
venv = tox.venv.VirtualEnv()
|
venv = tox.venv.VirtualEnv()
|
||||||
@@ -29,7 +31,7 @@ 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)
|
poetry = Factory().create_poetry(None)
|
||||||
packages: utilities.PackageMap = {
|
packages: utilities.PackageMap = {
|
||||||
item.name: item for item in poetry.locker.locked_repository(False).packages
|
item.name: item for item in poetry.locker.locked_repository().packages
|
||||||
}
|
}
|
||||||
|
|
||||||
to_install = [
|
to_install = [
|
||||||
@@ -57,3 +59,32 @@ def test_parallelization(mock_venv, mock_poetry_factory):
|
|||||||
assert round(parallel * 5) == round(sequential)
|
assert round(parallel * 5) == round(sequential)
|
||||||
assert round(sequential) == len(set(to_install))
|
assert round(sequential) == len(set(to_install))
|
||||||
assert round(parallel * 5) == len(set(to_install))
|
assert round(parallel * 5) == len(set(to_install))
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize("num_threads", (0, 8))
|
||||||
|
def test_propagates_exceptions_during_installation(
|
||||||
|
mock_venv, mock_poetry_factory, num_threads
|
||||||
|
):
|
||||||
|
"""Assert that an exception which occurs during installation is properly raised.
|
||||||
|
|
||||||
|
Regression test for https://github.com/enpaul/tox-poetry-installer/issues/86
|
||||||
|
"""
|
||||||
|
from tox_poetry_installer import _poetry # pylint: disable=import-outside-toplevel
|
||||||
|
|
||||||
|
poetry = Factory().create_poetry(None)
|
||||||
|
packages: utilities.PackageMap = {
|
||||||
|
item.name: item for item in poetry.locker.locked_repository().packages
|
||||||
|
}
|
||||||
|
to_install = [packages["toml"]]
|
||||||
|
venv = tox.venv.VirtualEnv()
|
||||||
|
fake_exception = ValueError("my testing exception")
|
||||||
|
|
||||||
|
with mock.patch.object(
|
||||||
|
_poetry,
|
||||||
|
"PipInstaller",
|
||||||
|
**{"return_value.install.side_effect": fake_exception},
|
||||||
|
):
|
||||||
|
with pytest.raises(ValueError) as exc_info:
|
||||||
|
installer.install(poetry, venv, to_install, num_threads)
|
||||||
|
|
||||||
|
assert exc_info.value is fake_exception
|
||||||
|
|||||||
15
tox.ini
15
tox.ini
@@ -1,5 +1,5 @@
|
|||||||
[tox]
|
[tox]
|
||||||
envlist = py36, py37, py38, py39, py310, static, static-tests, security
|
envlist = py37, py38, py39, py310, py311, static, static-tests, security
|
||||||
isolated_build = true
|
isolated_build = true
|
||||||
skip_missing_interpreters = true
|
skip_missing_interpreters = true
|
||||||
|
|
||||||
@@ -21,7 +21,7 @@ commands =
|
|||||||
|
|
||||||
[testenv:static]
|
[testenv:static]
|
||||||
description = Static formatting and quality enforcement
|
description = Static formatting and quality enforcement
|
||||||
basepython = python3.8
|
basepython = python3.10
|
||||||
platform = linux
|
platform = linux
|
||||||
ignore_errors = true
|
ignore_errors = true
|
||||||
locked_deps =
|
locked_deps =
|
||||||
@@ -46,7 +46,7 @@ commands =
|
|||||||
|
|
||||||
[testenv:static-tests]
|
[testenv:static-tests]
|
||||||
description = Static formatting and quality enforcement for the tests
|
description = Static formatting and quality enforcement for the tests
|
||||||
basepython = python3.8
|
basepython = python3.10
|
||||||
platform = linux
|
platform = linux
|
||||||
ignore_errors = true
|
ignore_errors = true
|
||||||
locked_deps =
|
locked_deps =
|
||||||
@@ -63,7 +63,7 @@ commands =
|
|||||||
|
|
||||||
[testenv:security]
|
[testenv:security]
|
||||||
description = Security checks
|
description = Security checks
|
||||||
basepython = python3.8
|
basepython = python3.10
|
||||||
platform = linux
|
platform = linux
|
||||||
ignore_errors = true
|
ignore_errors = true
|
||||||
skip_install = true
|
skip_install = true
|
||||||
@@ -83,7 +83,10 @@ commands =
|
|||||||
--format requirements.txt \
|
--format requirements.txt \
|
||||||
--output {envtmpdir}/requirements.txt \
|
--output {envtmpdir}/requirements.txt \
|
||||||
--without-hashes \
|
--without-hashes \
|
||||||
--dev
|
--with dev \
|
||||||
|
--extras poetry
|
||||||
safety check \
|
safety check \
|
||||||
--file {envtmpdir}/requirements.txt \
|
--file {envtmpdir}/requirements.txt \
|
||||||
--json
|
--output text \
|
||||||
|
# https://github.com/pytest-dev/py/issues/287
|
||||||
|
--ignore 51457
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
# pylint: disable=missing-docstring
|
# pylint: disable=missing-docstring
|
||||||
__title__ = "tox-poetry-installer"
|
__title__ = "tox-poetry-installer"
|
||||||
__summary__ = "A plugin for Tox that lets you install test environment dependencies from the Poetry lockfile"
|
__summary__ = "A plugin for Tox that lets you install test environment dependencies from the Poetry lockfile"
|
||||||
__version__ = "0.8.5"
|
__version__ = "0.10.3"
|
||||||
__url__ = "https://github.com/enpaul/tox-poetry-installer/"
|
__url__ = "https://github.com/enpaul/tox-poetry-installer/"
|
||||||
__license__ = "MIT"
|
__license__ = "MIT"
|
||||||
__authors__ = ["Ethan Paul <24588726+enpaul@users.noreply.github.com>"]
|
__authors__ = ["Ethan Paul <24588726+enpaul@users.noreply.github.com>"]
|
||||||
|
|||||||
@@ -28,9 +28,9 @@ from tox_poetry_installer import exceptions
|
|||||||
|
|
||||||
|
|
||||||
try:
|
try:
|
||||||
|
from cleo.io.null_io import NullIO
|
||||||
from poetry.factory import Factory
|
from poetry.factory import Factory
|
||||||
from poetry.installation.pip_installer import PipInstaller
|
from poetry.installation.pip_installer import PipInstaller
|
||||||
from poetry.io.null_io import NullIO
|
|
||||||
from poetry.poetry import Poetry
|
from poetry.poetry import Poetry
|
||||||
from poetry.utils.env import VirtualEnv
|
from poetry.utils.env import VirtualEnv
|
||||||
except ImportError:
|
except ImportError:
|
||||||
|
|||||||
@@ -20,7 +20,8 @@ PEP508_VERSION_DELIMITERS: Tuple[str, ...] = ("~=", "==", "!=", ">", "<")
|
|||||||
REPORTER_PREFIX: str = f"{__about__.__title__}:"
|
REPORTER_PREFIX: str = f"{__about__.__title__}:"
|
||||||
|
|
||||||
# Internal list of packages that poetry has deemed unsafe and are excluded from the lockfile
|
# Internal list of packages that poetry has deemed unsafe and are excluded from the lockfile
|
||||||
UNSAFE_PACKAGES: Set[str] = {"distribute", "pip", "setuptools", "wheel"}
|
# TODO: This functionality is no longer needed, should remove in a future update.
|
||||||
|
UNSAFE_PACKAGES: Set[str] = set()
|
||||||
|
|
||||||
# Number of threads to use for installing dependencies by default
|
# Number of threads to use for installing dependencies by default
|
||||||
DEFAULT_INSTALL_THREADS: int = 10
|
DEFAULT_INSTALL_THREADS: int = 10
|
||||||
|
|||||||
@@ -4,6 +4,7 @@ All implementations of tox hooks are defined here, as well as any single-use hel
|
|||||||
specifically related to implementing the hooks (to keep the size/readability of the hook functions
|
specifically related to implementing the hooks (to keep the size/readability of the hook functions
|
||||||
themselves manageable).
|
themselves manageable).
|
||||||
"""
|
"""
|
||||||
|
from itertools import chain
|
||||||
from typing import Optional
|
from typing import Optional
|
||||||
|
|
||||||
import tox
|
import tox
|
||||||
@@ -114,7 +115,14 @@ def tox_addoption(parser: ToxParser):
|
|||||||
name="install_dev_deps",
|
name="install_dev_deps",
|
||||||
type="bool",
|
type="bool",
|
||||||
default=False,
|
default=False,
|
||||||
help="Automatically install all Poetry development dependencies to the environment",
|
help="(deprecated) Automatically install all Poetry development dependencies to the environment",
|
||||||
|
)
|
||||||
|
|
||||||
|
parser.add_testenv_attribute(
|
||||||
|
name="poetry_dep_groups",
|
||||||
|
type="line-list",
|
||||||
|
default=[],
|
||||||
|
help="List of Poetry dependency groups to install to the environment",
|
||||||
)
|
)
|
||||||
|
|
||||||
parser.add_testenv_attribute(
|
parser.add_testenv_attribute(
|
||||||
@@ -196,6 +204,20 @@ def tox_testenv_install_deps(venv: ToxVirtualEnv, action: ToxAction) -> Optional
|
|||||||
dev_deps = []
|
dev_deps = []
|
||||||
logger.info("Env does not install development dependencies, skipping")
|
logger.info("Env does not install development dependencies, skipping")
|
||||||
|
|
||||||
|
group_deps = utilities.dedupe_packages(
|
||||||
|
list(
|
||||||
|
chain(
|
||||||
|
*[
|
||||||
|
utilities.find_group_deps(group, packages, virtualenv, poetry)
|
||||||
|
for group in venv.envconfig.poetry_dep_groups
|
||||||
|
]
|
||||||
|
)
|
||||||
|
)
|
||||||
|
)
|
||||||
|
logger.info(
|
||||||
|
f"Identified {len(group_deps)} group dependencies to install to env"
|
||||||
|
)
|
||||||
|
|
||||||
env_deps = utilities.find_additional_deps(
|
env_deps = utilities.find_additional_deps(
|
||||||
packages, virtualenv, poetry, venv.envconfig.locked_deps
|
packages, virtualenv, poetry, venv.envconfig.locked_deps
|
||||||
)
|
)
|
||||||
@@ -231,7 +253,9 @@ def tox_testenv_install_deps(venv: ToxVirtualEnv, action: ToxAction) -> Optional
|
|||||||
logger.error(f"Internal plugin error: {err}")
|
logger.error(f"Internal plugin error: {err}")
|
||||||
raise err
|
raise err
|
||||||
|
|
||||||
dependencies = dev_deps + env_deps + project_deps
|
dependencies = utilities.dedupe_packages(
|
||||||
|
dev_deps + group_deps + env_deps + project_deps
|
||||||
|
)
|
||||||
if (
|
if (
|
||||||
venv.envconfig.config.option.parallel_install_threads
|
venv.envconfig.config.option.parallel_install_threads
|
||||||
!= constants.DEFAULT_INSTALL_THREADS
|
!= constants.DEFAULT_INSTALL_THREADS
|
||||||
|
|||||||
@@ -6,10 +6,10 @@ import concurrent.futures
|
|||||||
import contextlib
|
import contextlib
|
||||||
import typing
|
import typing
|
||||||
from datetime import datetime
|
from datetime import datetime
|
||||||
from typing import Sequence
|
from typing import Collection
|
||||||
from typing import Set
|
from typing import Set
|
||||||
|
|
||||||
from poetry.core.packages import Package as PoetryPackage
|
from poetry.core.packages.package import Package as PoetryPackage
|
||||||
from tox.venv import VirtualEnv as ToxVirtualEnv
|
from tox.venv import VirtualEnv as ToxVirtualEnv
|
||||||
|
|
||||||
from tox_poetry_installer import logger
|
from tox_poetry_installer import logger
|
||||||
@@ -22,7 +22,7 @@ if typing.TYPE_CHECKING:
|
|||||||
def install(
|
def install(
|
||||||
poetry: "_poetry.Poetry",
|
poetry: "_poetry.Poetry",
|
||||||
venv: ToxVirtualEnv,
|
venv: ToxVirtualEnv,
|
||||||
packages: Sequence[PoetryPackage],
|
packages: Collection[PoetryPackage],
|
||||||
parallels: int = 0,
|
parallels: int = 0,
|
||||||
):
|
):
|
||||||
"""Install a bunch of packages to a virtualenv
|
"""Install a bunch of packages to a virtualenv
|
||||||
@@ -71,11 +71,20 @@ def install(
|
|||||||
yield lambda func, arg: func(arg)
|
yield lambda func, arg: func(arg)
|
||||||
|
|
||||||
with _optional_parallelize() as executor:
|
with _optional_parallelize() as executor:
|
||||||
|
futures = []
|
||||||
for dependency in packages:
|
for dependency in packages:
|
||||||
if dependency not in installed:
|
if dependency not in installed:
|
||||||
installed.add(dependency)
|
installed.add(dependency)
|
||||||
logger.debug(f"Queuing {dependency}")
|
logger.debug(f"Queuing {dependency}")
|
||||||
executor(logged_install, dependency)
|
future = executor(logged_install, dependency)
|
||||||
|
if future is not None:
|
||||||
|
futures.append(future)
|
||||||
else:
|
else:
|
||||||
logger.debug(f"Skipping {dependency}, already installed")
|
logger.debug(f"Skipping {dependency}, already installed")
|
||||||
logger.debug("Waiting for installs to finish...")
|
logger.debug("Waiting for installs to finish...")
|
||||||
|
|
||||||
|
for future in concurrent.futures.as_completed(futures):
|
||||||
|
# Don't actually care about the return value, just waiting on the
|
||||||
|
# future to ensure any exceptions that were raised in the called
|
||||||
|
# function are propagated.
|
||||||
|
future.result()
|
||||||
|
|||||||
@@ -10,8 +10,8 @@ from typing import List
|
|||||||
from typing import Sequence
|
from typing import Sequence
|
||||||
from typing import Set
|
from typing import Set
|
||||||
|
|
||||||
from poetry.core.packages import Dependency as PoetryDependency
|
from poetry.core.packages.dependency import Dependency as PoetryDependency
|
||||||
from poetry.core.packages import Package as PoetryPackage
|
from poetry.core.packages.package import Package as PoetryPackage
|
||||||
from tox.action import Action as ToxAction
|
from tox.action import Action as ToxAction
|
||||||
from tox.venv import VirtualEnv as ToxVirtualEnv
|
from tox.venv import VirtualEnv as ToxVirtualEnv
|
||||||
|
|
||||||
@@ -59,6 +59,13 @@ def check_preconditions(venv: ToxVirtualEnv, action: ToxAction) -> "_poetry.Poet
|
|||||||
"be removed in version 1.0.0. Please use the '--parallel-install-threads' option."
|
"be removed in version 1.0.0. Please use the '--parallel-install-threads' option."
|
||||||
)
|
)
|
||||||
|
|
||||||
|
if venv.envconfig.install_dev_deps:
|
||||||
|
logger.warning(
|
||||||
|
"DEPRECATION: The 'install_dev_deps' option is deprecated and will be removed in "
|
||||||
|
"version 1.0.0. Please update test environments that install development dependencies "
|
||||||
|
"to set the 'poetry_dev_groups = [dev]' option in tox.ini"
|
||||||
|
)
|
||||||
|
|
||||||
from tox_poetry_installer import _poetry
|
from tox_poetry_installer import _poetry
|
||||||
|
|
||||||
try:
|
try:
|
||||||
@@ -92,7 +99,7 @@ def build_package_map(poetry: "_poetry.Poetry") -> PackageMap:
|
|||||||
: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(True).packages:
|
for package in poetry.locker.locked_repository().packages:
|
||||||
packages[package.name].append(package)
|
packages[package.name].append(package)
|
||||||
|
|
||||||
return packages
|
return packages
|
||||||
@@ -218,7 +225,7 @@ def find_project_deps(
|
|||||||
dep_name.lower(), packages, venv, allow_missing=[poetry.package.name]
|
dep_name.lower(), packages, venv, allow_missing=[poetry.package.name]
|
||||||
)
|
)
|
||||||
|
|
||||||
return dependencies
|
return dedupe_packages(dependencies)
|
||||||
|
|
||||||
|
|
||||||
def find_additional_deps(
|
def find_additional_deps(
|
||||||
@@ -243,7 +250,34 @@ def find_additional_deps(
|
|||||||
dep_name.lower(), packages, venv, allow_missing=[poetry.package.name]
|
dep_name.lower(), packages, venv, allow_missing=[poetry.package.name]
|
||||||
)
|
)
|
||||||
|
|
||||||
return dependencies
|
return dedupe_packages(dependencies)
|
||||||
|
|
||||||
|
|
||||||
|
def find_group_deps(
|
||||||
|
group: str,
|
||||||
|
packages: PackageMap,
|
||||||
|
venv: "_poetry.VirtualEnv",
|
||||||
|
poetry: "_poetry.Poetry",
|
||||||
|
) -> List[PoetryPackage]:
|
||||||
|
"""Find the dependencies belonging to a dependency group
|
||||||
|
|
||||||
|
Recursively identify the Poetry dev dependencies
|
||||||
|
|
||||||
|
: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 venv: Poetry virtual environment to use for package compatibility checks
|
||||||
|
:param poetry: Poetry object for the current project
|
||||||
|
"""
|
||||||
|
return find_additional_deps(
|
||||||
|
packages,
|
||||||
|
venv,
|
||||||
|
poetry,
|
||||||
|
poetry.pyproject.data["tool"]["poetry"]
|
||||||
|
.get("group", {})
|
||||||
|
.get(group, {})
|
||||||
|
.get("dependencies", {})
|
||||||
|
.keys(),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def find_dev_deps(
|
def find_dev_deps(
|
||||||
@@ -257,9 +291,26 @@ def find_dev_deps(
|
|||||||
: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 poetry: Poetry object for the current project
|
||||||
"""
|
"""
|
||||||
return find_additional_deps(
|
dev_group_deps = find_group_deps("dev", packages, venv, poetry)
|
||||||
|
|
||||||
|
# Legacy pyproject.toml poetry format:
|
||||||
|
legacy_dev_group_deps = find_additional_deps(
|
||||||
packages,
|
packages,
|
||||||
venv,
|
venv,
|
||||||
poetry,
|
poetry,
|
||||||
poetry.pyproject.data["tool"]["poetry"].get("dev-dependencies", {}).keys(),
|
poetry.pyproject.data["tool"]["poetry"].get("dev-dependencies", {}).keys(),
|
||||||
)
|
)
|
||||||
|
|
||||||
|
# Poetry 1.2 unions these two toml sections.
|
||||||
|
return dedupe_packages(dev_group_deps + legacy_dev_group_deps)
|
||||||
|
|
||||||
|
|
||||||
|
def dedupe_packages(packages: Sequence[PoetryPackage]) -> List[PoetryPackage]:
|
||||||
|
"""Deduplicates a sequence of PoetryPackages while preserving ordering
|
||||||
|
|
||||||
|
Adapted from StackOverflow: https://stackoverflow.com/a/480227
|
||||||
|
"""
|
||||||
|
seen: Set[PoetryPackage] = set()
|
||||||
|
# Make this faster, avoid method lookup below
|
||||||
|
seen_add = seen.add
|
||||||
|
return [p for p in packages if not (p in seen or seen_add(p))]
|
||||||
|
|||||||
Reference in New Issue
Block a user