-
Notifications
You must be signed in to change notification settings - Fork 62
Update Poetry description #496
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -389,15 +389,15 @@ is currently undocumented. Thus, we don't recommend using Poetry for more comple | |
:widths: 20,5,50 | ||
:delim: "|" | ||
|
||
Add dependencies to your pyproject.toml file |✅|Poetry helps you add dependencies to your `pyproject.toml` metadata. _NOTE: currently Poetry adds dependencies using an approach that is slightly out of alignment with current Python peps - however there is a plan to fix this in an upcoming release._ Poetry also allows you to organize dependencies in groups such as documentation, packaging and tests. | ||
Add dependencies to your pyproject.toml file |✅|Poetry helps you add dependencies to your `pyproject.toml` metadata. | ||
Dependency specification |✅ |Poetry allows you to be specific about version of dependencies that you add to your package's pyproject.toml file. However, it's default upper bound approach can be problematic for some packages (We suggest you override the default setting when adding dependencies). Read below for more. | ||
Environment management |✅ | Poetry allows you to either use its built in environment or you can select the environment type that you want to use for managing your package. [Read more about its built in environment management options](https://python-poetry.org/docs/basic-usage/#using-your-virtual-environment). | ||
Lock files| ✅ | Poetry creates a **poetry.lock** file that you can use if you need a lock file for your build. | ||
Publish to PyPI and test PyPI|✅|Poetry supports publishing to both test PyPI and PyPI | ||
Version Control based versioning|✅ | The plugin [Poetry dynamic versioning](https://github.com/mtkennerly/poetry-dynamic-versioning) supports versioning using git tags with Poetry. | ||
Version bumping| ✅ | Poetry supports you bumping the version of your package using standard semantic version terms patch; minor; major | ||
Follows current packaging standards|✖✅|Poetry does not quite support current packaging standards for adding metadata to the **pyproject.toml** file but plans to fix this in an upcoming release. | ||
Install your package in editable mode|✅|Poetry supports installing your package in editable mode using `--editable` | ||
Follows current packaging standards|✖✅|Since version 2.0 (released January 2025), Poetry supports most current project metadata standards. However, not all standards are supported, and it also supports the legacy Poetry format. Read below for more. | ||
Install your package in editable mode|✅|Poetry supports installing your package in editable mode. | ||
Build your sdist and wheel distributions|✅|Poetry will build your sdist and wheel distributions using `poetry build` | ||
``` | ||
|
||
|
@@ -408,11 +408,11 @@ Build your sdist and wheel distributions|✅|Poetry will build your sdist and wh | |
|
||
Some challenges of Poetry include: | ||
|
||
- Poetry, by default, pins dependencies using an "upper bound" limit specified with the `^` symbol by default. However, this behavior can be over-written by specifying the dependency when you use `Poetry add` as follows: `poetry add "requests>=2.1"` See breakout below for more discussion on issues surrounding upper-bounds pinning. | ||
- _Minor Challenge:_ The way Poetry currently adds metadata to your pyproject.toml file does not follow current Python standards. However, this is going to be addressed with Poetry release version 2.0. | ||
- Poetry has its own concept of grouped dependencies (`poetry add --group=GROUP_NAME DEPENDENCY`). Dependencies added as grouped dependencies are not optional and there is no Python standard for this type of dependency. This should not be confused with "optional" dependencies (`poetry add --optional=GROUP_NAME DEPENDENCY`), which is standardised and lets you group your dependencies into several optional groups. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 👍 this is a great synopsis of Poetry's dependency flavours |
||
- While Poetry supports "development" dependencies (i.e. dependencies you use for development but not running the code, such as `pytest`), Poetry does not yet follow the standardised format for specifying such dependencies. | ||
- Poetry, by default, pins dependencies using an "upper bound" limit (which is specified with the `^` symbol in the legacy format). However, this behavior can be over-written by specifying the dependency when you use `poetry add` as follows: `poetry add "requests>=2.1"` See breakout below for more discussion on issues surrounding upper-bounds pinning. | ||
|
||
Poetry is an excellent tool. Use caution when using it to pin dependencies as | ||
Poetry's approach to pinning can be problematic for many builds. If you use Poetry, we strongly suggest that you override the default upper bound dependency option. | ||
Poetry is a popular packaging tool and introduced many very useful features. However, if you decide to use it, then use caution when adding dependencies as Poetry's approach to pinning can be problematic for many builds. If you use Poetry, we strongly suggest that you override the default upper bound dependency option. | ||
|
||
<!--https://github.com/py-pkgs/py-pkgs/issues/95#issuecomment-1035584750 | ||
discusses the slight differences in how poetry adds deps....--> | ||
|
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this change justifies removing the
✖
IMHO the timestamp is not needed. It is nice for now, but it seems like a task for cleanup in the year 2027 when no one remembers 1.X
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We had a quick chat with Henry today @ucodery - my understanding is that poetry is doing a better job of supporting some standards, but not all. So I'm torn between the x/check combo because of that. Henry suggested that they still have ways to go. I haven't looked closely enough at Poetry lately to know what is still not following standards.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, I realize that not all standards are followed, but my thinking was that often projects don't support every community standard; even more so when looking at historical versions. I didn't want to come back to this point every time Poetry does a minor version release and check if it is compliant enough to get a full check.
I would just note some of the bigger standards deviation in the Notes section, as is already done a bit. But if Henry thinks Poetry is still that far from an expected level of stardards following, I am also okay with leaving in the X.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
heya @ucodery you make a good point. And I 1000% trust your thoughts here. I worry my last message sounded like Henry was directing the decision, or I was using that in some way. Please know that's not the case! We just had a chat, and that was a takeaway I had. Let's do what you suggest. Let's make it a check and then add a * with a note that the maintainer team is working toward PEP compliance. Does that sound reasonable? ✨
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actually, that statement in the table is super clear. Let's leave as is and just potentially (if @MarieRoald agrees) remove the x!!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removing the x is fine by me! (Btw, I co-authored this PR with @yngvem ✨)