Add support for multiple README files (retrocompatible) #248
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
wagnerluis1982
added a commit
to wagnerluis1982/poetry
that referenced
this pull request
Nov 16, 2021
This makes poetry aware about the upcoming changes in poetry-core in order to support declaration of multiple readme files in pyproject.toml Relates python-poetry#873 Enable python-poetry/poetry-core#248
This was referenced Nov 16, 2021
This code reuses the `"readme"` entry in a way to allow the user to
declare in the old way or the new way.
With the changes, the two following declarations are valid:
**Single file**
```toml
readme = "README.rst"
```
**Multiple files**
```toml
readme = [
"README.rst",
"HISTORY.rst"
]
```
If the user declares files in different formats, the strict validation
will issue.
NOTICE:
The class `Package` suffered an important change: `readme` was renamed
to the plural `readmes`. Properties for the single form were introduced
to ensure retrocompatibility.
wagnerluis1982
force-pushed
the
rework-support-multiple-readme-files
branch
from
cbe43f3
to
eb8883e
Compare
wagnerluis1982
changed the title
neersighted
requested changes
Nov 20, 2021
src/poetry/core/factory.py
Outdated
| @@ -421,6 +426,14 @@ def validate(cls, config: dict, strict: bool = False) -> Dict[str, List[str]]: | |||
| ) | |||
| ) | |||
|
|
|||
| # Checking types of all readme files (must match) | |||
| if "readme" in config and not isinstance(config["readme"], str): | |||
| readme_types = [readme_content_type(r) for r in config["readme"]] | |||
There was a problem hiding this comment.
Suggested change
| readme_types = [readme_content_type(r) for r in config["readme"]] | |
| readme_types = {readme_content_type(r) for r in config["readme"]} |
No reason not to use a set from the start...
There was a problem hiding this comment.
Yeah, I took this decision prematurely, motivated by the fact the set gives non-predictable order (which is important for me in the unit test). I am solving this by adding sorted(readme_types) in the error message value.
src/poetry/core/factory.py
Outdated
| # Checking types of all readme files (must match) | ||
| if "readme" in config and not isinstance(config["readme"], str): | ||
| readme_types = [readme_content_type(r) for r in config["readme"]] | ||
| if len(set(readme_types)) > 1: |
There was a problem hiding this comment.
...which means we can drop the set() call.
src/poetry/core/packages/package.py
Outdated
| import warnings | ||
|
|
||
| warnings.warn( | ||
| "`readme` is deprecated: you are getting only the first readme file. Please use the plural form `readmes`", |
There was a problem hiding this comment.
Let's add a period to the end of this sentence.
src/poetry/core/packages/package.py
Outdated
| import warnings | ||
|
|
||
| warnings.warn( | ||
| "`readme` is deprecated. Please assign a tuple to the plural form `readmes`", |
@neersighted I have to say that I deeply consider about this decision. But the lack of a new helper would mean to store the content type into Package, which doesn't fit IMHO. So I decided to have the helper. |
neersighted
approved these changes
Nov 21, 2021
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
This code was merged before on #118 and reverted on #235, due to the breaking of
Package.readmeis renamed toPackage.readmesand it is aTuple[Path]instead of simplyPath.In this PR you will find mostly the same thing of #118 with a few little improvements.
Description
This code reuses the
"readme"entry in a way to allow the user to declare in the old way or the new way.With the changes, the two following declarations are valid:
Single file
Multiple files
If the user declares files in different formats, the strict validation will issue.
Notice
The class
Packagesuffered an important change:readmewas renamed to the pluralreadmes. Properties for the single form were introduced to ensure retrocompatibility.Pull Request Check List
Resolves: python-poetry/poetry#873