Skip to content

Comments

Update project schema for local versions to allow upper case letters#859

Merged
radoering merged 4 commits intopython-poetry:mainfrom
noootch:Update_project_schema
Apr 27, 2025
Merged

Update project schema for local versions to allow upper case letters#859
radoering merged 4 commits intopython-poetry:mainfrom
noootch:Update_project_schema

Conversation

@noootch
Copy link
Contributor

@noootch noootch commented Apr 23, 2025 •
edited by radoering
Loading

Resolves: python-poetry/poetry#10229

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

Question: Is the documentation task needed here?

Changes

Added support for upper case local version as allowed by PEP 440:

ASCII letters ([a-zA-Z])
ASCII digits ([0-9])
periods (.)

Summary by Sourcery

Add support for local version validation in Poetry's project schema

New Features:

  • Introduced validation for local version strings according to PEP440 in Poetry's project schema

Tests:

  • Added a new test case to validate local version format in project schema

@sourcery-ai
Copy link

sourcery-ai bot commented Apr 23, 2025 •
edited
Loading

Reviewer's Guide by Sourcery

This pull request updates the project schema to allow local versions according to PEP440. It also adds a test case to validate the new schema.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Added a test case to validate the project schema with a local version.
  • Added a new test case test_validate_local_version to test_factory.py.
  • The test case loads a local_version.toml fixture and validates it against the project schema.
 tests/test_factory.py
Added a new fixture file local_version.toml.
  • The fixture file contains a valid project configuration with a local version string.
 tests/fixtures/local_version.toml
Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

sourcery-ai[bot]
sourcery-ai bot reviewed Apr 23, 2025
View reviewed changes
Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @noootch - I've reviewed your changes - here's some feedback:

Overall Comments:

  • It would be helpful to include the schema changes in the pull request description.
  • Consider adding a test case that validates the schema with an invalid local version to ensure proper error handling.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good
Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@radoering radoering force-pushed the Update_project_schema branch from 49f67ec to cc8af2f Compare April 27, 2025 09:42
@radoering radoering changed the title Update project schema Update project schema for local versions to allow upper case letters Apr 27, 2025
@radoering radoering merged commit af3a1f9 into python-poetry:main Apr 27, 2025
18 checks passed
This was referenced May 4, 2025
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

@radoering radoering radoering approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Poetry v2 doesn't accept version with -SNAPSHOT unless using v1.8-style pyproject.toml

2 participants

@noootch @radoering