canonicalize dependency group names#10387
Merged
radoering merged 1 commit intopython-poetry:mainfrom May 28, 2025
Merged
Conversation
Reviewer's GuideThis PR introduces consistent normalization of dependency group names across the codebase by using packaging.utils.canonicalize_name (NormalizedName) in type hints, data processing (locker, solver, transaction, transitive info), CLI commands, and tests, and updates the pyproject.toml to reference the poetry-core Git URL as required. Updated Class Diagrams for Command ClassesclassDiagram
class GroupCommand {
+activated_groups: set[NormalizedName]
}
class InstallCommand {
+activated_groups: set[NormalizedName]
}
class SelfCommand {
+ADDITIONAL_PACKAGE_GROUP: NormalizedName
+activated_groups: set[NormalizedName]
}
class SelfShowCommand {
+activated_groups: set[NormalizedName]
}
SelfCommand <|-- SelfShowCommand
class SelfInstallCommand {
+activated_groups: set[NormalizedName]
}
SelfCommand <|-- SelfInstallCommand
InstallCommand <|-- SelfInstallCommand
Updated Class Diagram for TransitivePackageInfoclassDiagram
class TransitivePackageInfo {
+depth: int
+groups: set[NormalizedName]
+markers: dict[NormalizedName, BaseMarker]
+get_marker(groups: Iterable[NormalizedName]) BaseMarker
}
Updated Class Diagram for LockerclassDiagram
class Locker {
+locked_packages() dict[Package, TransitivePackageInfo]
#_dump_package(package: Package, transitive_info: TransitivePackageInfo, dependencies: dict[str, list[str]]) Table
}
Updated Class Diagram for InstallerclassDiagram
class Installer {
-_groups: Iterable[NormalizedName] | None
+only_groups(groups: Iterable[NormalizedName]) Installer
}
Updated Class Diagram for TransactionclassDiagram
class Transaction {
+__init__(..., groups: set[NormalizedName] | None)
}
Updated Class Diagram for PackageNodeclassDiagram
class PackageNode {
+groups: frozenset[NormalizedName]
}
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @radoering - I've reviewed your changes - here's some feedback:
- The
DEV_GROUPconstant is defined locally in multiple test files; consider using a shared definition, possibly frompoetry-coreif appropriate, similar toMAIN_GROUP.
Here's what I looked at during the review
- 🟢 General issues: all looks good
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Member
Author
I do not think it is worth it: While the name of the main group is really a constant, "dev" is not. It is just "coincidence" that multiple tests use the same arbitrary group name. Moving this one liner into a common module and replacing it by an import, is probably not worth it. |
finswimmer
previously approved these changes
May 27, 2025
radoering
force-pushed
the
normalize-dependency-group-names
branch
from
0c786c9 to
a7cbe23
Compare
There was a problem hiding this comment.
Hey @radoering - I've reviewed your changes and they look great!
Here's what I looked at during the review
- 🟡 General issues: 1 issue found
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
radoering
force-pushed
the
normalize-dependency-group-names
branch
from
a7cbe23 to
daa3f20
Compare
finswimmer
approved these changes
May 27, 2025
|
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. |
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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
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.
Pull Request Check List
Requires: python-poetry/poetry-core#868
Summary by Sourcery
Normalize dependency group handling by canonicalizing group names across API, CLI, lock file parsing/dumping, and tests to ensure consistent use of packaging.utils.canonicalize_name.
Bug Fixes:
Enhancements:
Build:
Tests: