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

YDX-2147483647 · 2023-01-31T14:07:55Z

Let poetry check command checks existence of referenced readme files.

Reason:

Prevent typo.
Help to debug poetry install. (See poetry install checks README.md, but poetry check does not. #6937)

Pull Request Check List

Resolves: #6937

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

Implementation

[Removed] `warnings: list[str] = []` in `CheckCommand.validate_readme`

To be consistent with validate_classifiers from #2881 and pass mypy.

On case-sensitivity

I try to raise warnings for inconsistent cases, but I cannot find any good way to detect the real cases…

str(Path.resolve) == str(Path.absolute) is tricky and doesn’t work for symbolic links.

Details: pathlib doc and os.path implementation.
Path.iterdir or os.listdir can be too heavy.

Update on 2023-06-10

I guess there will be a big change in poetry check in near future. (#6756) This PR might be obsolete after #8015 is merged.

2023-06-14: #8015 was merged and conflicts were resolved.

Resolves: python-poetry#6937

github-actions · 2023-06-11T14:44:57Z

Deploy preview for website ready!

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

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

radoering

LGTM. Just a minor nitpick: I'd invert the error message.

src/poetry/console/commands/check.py

Co-authored-by: Randy Döring <30527984+radoering@users.noreply.github.com>

YDX-2147483647 · 2023-06-11T15:18:55Z

Hi! I agree with you, and I've committed the change.

As I mentioned above, this PR might conflict with #8015, as they both change poetry check. Feel free to review this PR later if #8015 is more important/urgent.

YDX-2147483647 · 2023-06-14T14:52:52Z

Sorry tests failed because I forgot to update the error message there. Now fixed.

radoering · 2023-06-14T15:46:07Z

#8015 is merged now. Can you please resolve the conflicts?

YDX-2147483647 · 2023-06-14T16:18:40Z

Sure!

I've resolved the conflicts, and poetry run pytest -k check (with empty $TERM) passed. Now waiting for the CI.

src/poetry/console/commands/check.py

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:51:10Z

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.

YDX-2147483647 changed the title ~~poetry check command validates readme (files must exist)~~ poetry check command validates readme (files must exist) Feb 3, 2023

YDX-2147483647 added 2 commits February 3, 2023 11:21

poetry check command validates readme (files must exist)

e272527

Resolves: python-poetry#6937

docs: case-sensitivity of readme paths

98174c6

YDX-2147483647 force-pushed the check-readme branch from 9b8c24e to 98174c6 Compare February 3, 2023 03:21

YDX-2147483647 and others added 9 commits February 7, 2023 10:29

Merge branch 'master' into check-readme

d433120

Merge branch 'master' into check-readme

52a5591

Merge branch 'master' into check-readme

e111dc5

Merge branch 'master' into check-readme

978801c

Merge branch 'master' into check-readme

c1418c2

Merge branch 'master' into check-readme

61ee7c4

Merge branch 'master' into check-readme

bde0fd1

Merge branch 'master' into check-readme

69e8f47

Merge branch 'master' into check-readme

da8fc8a

radoering added the impact/docs Contains or requires documentation changes label Jun 11, 2023

radoering requested changes Jun 11, 2023

View reviewed changes

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

YDX-2147483647 and others added 2 commits June 11, 2023 23:09

Invert the error message

f9f4e14

Co-authored-by: Randy Döring <30527984+radoering@users.noreply.github.com>

Merge branch 'master' into check-readme

c149451

YDX-2147483647 added 3 commits June 13, 2023 17:14

Merge branch 'master' into check-readme

4700b34

fix: Update the error message of the test

8ca2c28

Merge branch 'master' into check-readme

b61ab99

Merge branch 'master' into check-readme

f7c829a

eamanu reviewed Jun 14, 2023

View reviewed changes

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

refactor: Remove unused warnings = []

6969ded

YDX-2147483647 force-pushed the check-readme branch from 61eee4c to 6969ded Compare June 16, 2023 05:31

YDX-2147483647 requested a review from radoering June 16, 2023 15:57

radoering approved these changes Jun 17, 2023

View reviewed changes

radoering merged commit f691320 into python-poetry:master Jun 17, 2023
30 checks passed

YDX-2147483647 deleted the check-readme branch June 17, 2023 07:53

radoering mentioned this pull request Aug 20, 2023

release: bump version to 1.6.0 #8333

Merged

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

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

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

YDX-2147483647 commented Jan 31, 2023 •

edited

github-actions bot commented Jun 11, 2023 •

edited

radoering left a comment

YDX-2147483647 commented Jun 11, 2023 •

edited

YDX-2147483647 commented Jun 14, 2023

radoering commented Jun 14, 2023

YDX-2147483647 commented Jun 14, 2023

github-actions bot commented Mar 3, 2024

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

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

Conversation

YDX-2147483647 commented Jan 31, 2023 • edited

Pull Request Check List

Implementation

[Removed] warnings: list[str] = [] in CheckCommand.validate_readme

On case-sensitivity

Update on 2023-06-10

github-actions bot commented Jun 11, 2023 • edited

radoering left a comment

Choose a reason for hiding this comment

YDX-2147483647 commented Jun 11, 2023 • edited

YDX-2147483647 commented Jun 14, 2023

radoering commented Jun 14, 2023

YDX-2147483647 commented Jun 14, 2023

github-actions bot commented Mar 3, 2024

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

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

YDX-2147483647 commented Jan 31, 2023 •

edited

[Removed] `warnings: list[str] = []` in `CheckCommand.validate_readme`

github-actions bot commented Jun 11, 2023 •

edited

YDX-2147483647 commented Jun 11, 2023 •

edited