Moving "poetry lock --check" to "poetry check --lock" #8015

samypr100 · 2023-05-25T22:56:33Z

Pull Request Check List

Resolves: #6756

Added tests for changed code.
Updated documentation for changed code.

This PR moves poetry lock --check to poetry check --lock while still retaining functionality on the old command. It also marks the old command as deprecated. I've also updated the docs and CI (see below notice) to use the moved command.

My only question is do we have concerns with poetry self lock --check? It currently inherits from LockCommand causing it to be a valid option after running poetry self lock. If we need support it, we can add a new poetry/console/commands/self/check.py but I wasn't sure yet. I didn't see any tests for poetry/console/commands/self/lock.py either, but I'm assuming that's intentional.

Important: A change in GH Action's main.yml will need to be made post merge

      - name: Check lock file
-       run: poetry lock --check
+       run: poetry check --lock

Old Command Deprecation Notice

New Command

ralbertazzi · 2023-05-28T16:59:39Z

As most projects are expected to include a lockfile, what about checking the lockfile as a default option and having a --no-lock file to exclude validation in projects that do not include it?

samypr100 · 2023-05-30T15:42:40Z

As most projects are expected to include a lockfile, what about checking the lockfile as a default option and having a --no-lock file to exclude validation in projects that do not include it?

@ralbertazzi Good idea 💯 , I'm curious if others think we should go that direction

radoering · 2023-06-03T08:49:34Z

As most projects are expected to include a lockfile, what about checking the lockfile as a default option and having a --no-lock file to exclude validation in projects that do not include it?

First of all, I like the option to only check the lockfile (having a direct equivalent to poetry lock --check).

Nevertheless, it might make sense to check the lockfile per default (at least if there is a lockfile). I'm not sure if we should raise an error per default if there is no lockfile because poetry install handles "no lockfile" just fine (only "inconsistent lockfile" is an issue).

My suggestion would be:

poetry check --lock: error if no lockfile or inconsistent lockfile
poetry check: no error if no lockfile, error if inconsistent lockfile
Do we still need a --no-lock?

src/poetry/console/commands/check.py

samypr100 · 2023-06-04T02:02:39Z

As most projects are expected to include a lockfile, what about checking the lockfile as a default option and having a --no-lock file to exclude validation in projects that do not include it?

First of all, I like the option to only check the lockfile (having a direct equivalent to poetry lock --check).

Nevertheless, it might make sense to check the lockfile per default (at least if there is a lockfile). I'm not sure if we should raise an error per default if there is no lockfile because poetry install handles "no lockfile" just fine (only "inconsistent lockfile" is an issue).

My suggestion would be:

poetry check --lock: error if no lockfile or inconsistent lockfile

poetry check: no error if no lockfile, error if inconsistent lockfile

Do we still need a --no-lock?

@radoering Thanks!, implemented suggestions in 6125b6a

It will always error if there is an inconsistent lockfile now, regardless of --lock being used
It will error when a lockfile doesn't not exist only when --lock is used

docs/cli.md

src/poetry/console/commands/check.py

radoering

I think we need an additional test that checks the different behavior when the lockfile is missing.

docs/cli.md

tests/console/commands/test_check.py

samypr100 · 2023-06-12T15:56:43Z

I think we need an additional test that checks the different behavior when the lockfile is missing.

@radoering I had made a change to the existing test_check_invalid to use tester.execute("--lock") which would add a new line as part of it's error report Error: poetry.lock was not found. to validate.

I initially assumed that would good to test the case where poetry.lock file was missing. Are you thinking of a different scenario where the lockfile doesn't exist or mainly decoupling that into a separate test?

I added test_check_lock_outdated and test_check_lock_up_to_date both test when the lock file exists which are very similar to what was in test_lock.py.

radoering · 2023-06-12T16:25:22Z

I had made a change to the existing test_check_invalid to use tester.execute("--lock") which would add a new line as part of it's error report Error: poetry.lock was not found. to validate.

I missed that. Nevertheless, I think it would be better to add a separate (parametrized) test case and especially also test that the command succeeds if --lock is not passed.

samypr100 · 2023-06-12T19:02:10Z

I had made a change to the existing test_check_invalid to use tester.execute("--lock") which would add a new line as part of it's error report Error: poetry.lock was not found. to validate.

I missed that. Nevertheless, I think it would be better to add a separate (parametrized) test case and especially also test that the command succeeds if --lock is not passed.

Added one more parametrized test for this in a801b74

github-actions · 2023-06-14T15:28:13Z

Deploy preview for website ready!

✅ Preview
https://website-rcn0bvqlc-python-poetry.vercel.app

Built with commit e7e0b08.
This pull request is being automatically deployed with vercel-action

Poetry 1.6.0 deprecated `poetry lock --check` python-poetry/poetry#8015

This PR contains the following updates: | Package | Update | Change | |---|---|---| | [poetry](https://python-poetry.org/) ([source](https://github.com/python-poetry/poetry), [changelog](https://python-poetry.org/history/)) | minor | `1.5.1` -> `1.6.1` | --- ### Release Notes <details> <summary>python-poetry/poetry (poetry)</summary> ### [`v1.6.1`](https://github.com/python-poetry/poetry/blob/HEAD/CHANGELOG.md#161---2023-08-21) [Compare Source](python-poetry/poetry@1.6.0...1.6.1) ##### Fixed - Update the minimum required version of `requests` ([#8336](python-poetry/poetry#8336)). ### [`v1.6.0`](https://github.com/python-poetry/poetry/blob/HEAD/CHANGELOG.md#160---2023-08-20) [Compare Source](python-poetry/poetry@1.5.1...1.6.0) ##### Added - **Add support for repositories that do not provide a supported hash algorithm** ([#8118](python-poetry/poetry#8118)). - **Add full support for duplicate dependencies with overlapping markers** ([#7257](python-poetry/poetry#7257)). - **Improve performance of `poetry lock` for certain edge cases** ([#8256](python-poetry/poetry#8256)). - Improve performance of `poetry install` ([#8031](python-poetry/poetry#8031)). - `poetry check` validates that specified `readme` files do exist ([#7444](python-poetry/poetry#7444)). - Add a downgrading note when updating to an older version ([#8176](python-poetry/poetry#8176)). - Add support for `vox` in the `xonsh` shell ([#8203](python-poetry/poetry#8203)). - Add support for `pre-commit` hooks for projects where the pyproject.toml file is located in a subfolder ([#8204](python-poetry/poetry#8204)). - Add support for the `git+http://` scheme ([#6619](python-poetry/poetry#6619)). ##### Changed - **Drop support for Python 3.7** ([#7674](python-poetry/poetry#7674)). - Move `poetry lock --check` to `poetry check --lock` and deprecate the former ([#8015](python-poetry/poetry#8015)). - Change future warning that PyPI will only be disabled automatically if there are no primary sources ([#8151](python-poetry/poetry#8151)). ##### Fixed - Fix an issue where `build-system.requires` were not respected for projects with build scripts ([#7975](python-poetry/poetry#7975)). - Fix an issue where the encoding was not handled correctly when calling a subprocess ([#8060](python-poetry/poetry#8060)). - Fix an issue where `poetry show --top-level` did not show top level dependencies with extras ([#8076](python-poetry/poetry#8076)). - Fix an issue where `poetry init` handled projects with `src` layout incorrectly ([#8218](python-poetry/poetry#8218)). - Fix an issue where Poetry wrote `.pth` files with the wrong encoding ([#8041](python-poetry/poetry#8041)). - Fix an issue where `poetry install` did not respect the source if the same version of a package has been locked from different sources ([#8304](python-poetry/poetry#8304)). ##### Docs - Document **official Poetry badge** ([#8066](python-poetry/poetry#8066)). - Update configuration folder path for macOS ([#8062](python-poetry/poetry#8062)). - Add a warning about pip ignoring lock files ([#8117](python-poetry/poetry#8117)). - Clarify the use of the `virtualenvs.in-project` setting. ([#8126](python-poetry/poetry#8126)). - Change `pre-commit` YAML style to be consistent with pre-commit's own examples ([#8146](python-poetry/poetry#8146)). - Fix command for listing installed plugins ([#8200](python-poetry/poetry#8200)). - Mention the `nox-poetry` package ([#8173](python-poetry/poetry#8173)). - Add an example with a PyPI source in the pyproject.toml file ([#8171](python-poetry/poetry#8171)). - Use `reference` instead of deprecated `callable` in the scripts example ([#8211](python-poetry/poetry#8211)). ##### poetry-core ([`1.7.0`](https://github.com/python-poetry/poetry-core/releases/tag/1.7.0)) - Improve performance of marker handling ([#609](python-poetry/poetry-core#609)). - Allow `|` as a value separator in markers with the operators `in` and `not in` ([#608](python-poetry/poetry-core#608)). - Put pretty name (instead of normalized name) in metadata ([#620](python-poetry/poetry-core#620)). - Update list of supported licenses ([#623](python-poetry/poetry-core#623)). - Fix an issue where PEP 508 dependency specifications with names starting with a digit could not be parsed ([#607](python-poetry/poetry-core#607)). - Fix an issue where Poetry considered an unrelated `.gitignore` file resulting in an empty wheel ([#611](python-poetry/poetry-core#611)). ##### poetry-plugin-export ([`^1.5.0`](https://github.com/python-poetry/poetry-plugin-export/releases/tag/1.5.0)) - Fix an issue where markers for dependencies required by an extra were not generated correctly ([#209](python-poetry/poetry-plugin-export#209)). </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  Reviewed-on: https://git.walbeck.it/walbeck-it/docker-python-poetry/pulls/846 Co-authored-by: renovate-bot <bot@walbeck.it> Co-committed-by: renovate-bot <bot@walbeck.it>

github-actions · 2024-03-03T20:50:07Z

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

samypr100 added 5 commits May 25, 2023 18:40

Moving "poetry lock --check" to "poetry check --lock"

475e8c6

Updating Docs to use poetry lock --check

bc7f2b8

Updating GH Action Workflow to use poetry lock --check

b3b5270

Reverting b3b5270 to make CI pass

b708f9d

fix: typo in docs

ed67a83

Merge branch 'python-poetry:master' into migrate-poetry-check-lock

15fba34

radoering requested changes Jun 3, 2023

View reviewed changes

src/poetry/console/commands/check.py Outdated Show resolved Hide resolved

src/poetry/console/commands/check.py Outdated Show resolved Hide resolved

samypr100 added 3 commits June 3, 2023 21:52

Merge branch 'master' into migrate-poetry-check-lock

fe4e9cd

Update check command description to match docs

e0fab00

Incorporating suggestions

6125b6a

samypr100 requested a review from radoering June 4, 2023 02:03

Merge branch 'python-poetry:master' into migrate-poetry-check-lock

5e69a19

YDX-2147483647 mentioned this pull request Jun 10, 2023

poetry check command validates readme (files must exist) #7444

Merged

2 tasks

radoering requested changes Jun 11, 2023

View reviewed changes

docs/cli.md Show resolved Hide resolved

docs/cli.md Outdated Show resolved Hide resolved

src/poetry/console/commands/check.py Outdated Show resolved Hide resolved

samypr100 added 3 commits June 11, 2023 16:53

docs: improve description in check command

8aab9f4

docs: improve description in self lock command

dc4e667

Merge branch 'python-poetry:master' into migrate-poetry-check-lock

0affebf

radoering reviewed Jun 12, 2023

View reviewed changes

docs/cli.md Show resolved Hide resolved

tests/console/commands/test_check.py Outdated Show resolved Hide resolved

tests/console/commands/test_check.py Outdated Show resolved Hide resolved

parametrize check tests

275ff17

adding additional tests

a801b74

Merge branch 'python-poetry:master' into migrate-poetry-check-lock

26f97cc

radoering added area/cli Related to the command line impact/changelog Requires a changelog entry labels Jun 14, 2023

radoering added impact/docs Contains or requires documentation changes impact/deprecation Introduces or relates to a deprecation labels Jun 14, 2023

update description analogous to cli help

e7e0b08

radoering approved these changes Jun 14, 2023

View reviewed changes

radoering merged commit 6d57e84 into python-poetry:master Jun 14, 2023

samypr100 deleted the migrate-poetry-check-lock branch July 22, 2023 18:15

radoering mentioned this pull request Aug 20, 2023

release: bump version to 1.6.0 #8333

Merged

samypr100 mentioned this pull request Aug 21, 2023

ci: update gha workflow to use new poetry check --lock #8344

Merged

2 tasks

carlcsaposs-canonical added a commit to canonical/mysql-operator that referenced this pull request Aug 23, 2023

Replace poetry lock --check with poetry check --lock

3642d48

Poetry 1.6.0 deprecated `poetry lock --check` python-poetry/poetry#8015

carlcsaposs-canonical mentioned this pull request Aug 23, 2023

Replace poetry lock --check with poetry check --lock canonical/mysql-operator#304

Merged

carlcsaposs-canonical added a commit to canonical/mysql-operator that referenced this pull request Aug 24, 2023

Replace poetry lock --check with poetry check --lock (#304)

b0f8f90

Poetry 1.6.0 deprecated `poetry lock --check` python-poetry/poetry#8015

github-actions bot locked as resolved and limited conversation to collaborators Mar 3, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Moving "poetry lock --check" to "poetry check --lock" #8015

Moving "poetry lock --check" to "poetry check --lock" #8015

samypr100 commented May 25, 2023 •

edited

Loading

ralbertazzi commented May 28, 2023

samypr100 commented May 30, 2023 •

edited

Loading

radoering commented Jun 3, 2023

samypr100 commented Jun 4, 2023

radoering left a comment

samypr100 commented Jun 12, 2023

radoering commented Jun 12, 2023

samypr100 commented Jun 12, 2023

github-actions bot commented Jun 14, 2023 •

edited

Loading

github-actions bot commented Mar 3, 2024

Moving "poetry lock --check" to "poetry check --lock" #8015

Moving "poetry lock --check" to "poetry check --lock" #8015

Conversation

samypr100 commented May 25, 2023 • edited Loading

Pull Request Check List

Old Command Deprecation Notice

New Command

ralbertazzi commented May 28, 2023

samypr100 commented May 30, 2023 • edited Loading

radoering commented Jun 3, 2023

samypr100 commented Jun 4, 2023

radoering left a comment

Choose a reason for hiding this comment

samypr100 commented Jun 12, 2023

radoering commented Jun 12, 2023

samypr100 commented Jun 12, 2023

github-actions bot commented Jun 14, 2023 • edited Loading

github-actions bot commented Mar 3, 2024

samypr100 commented May 25, 2023 •

edited

Loading

samypr100 commented May 30, 2023 •

edited

Loading

github-actions bot commented Jun 14, 2023 •

edited

Loading