Skip to content
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

Cleanup json schema validation #10074

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Secrus
Copy link
Member

@Secrus Secrus commented Jan 18, 2025

Pull Request Check List

Resolves: #2965

Some changes towards better resource management, especially for repackaged use of poetry. Twin to python-poetry/poetry-core#819

Summary by Sourcery

Load JSON schemas from package resources.

Enhancements:

  • Use package resources to access schema files.

Chores:

  • Removed unused imports.

Copy link

sourcery-ai bot commented Jan 18, 2025

Reviewer's Guide by Sourcery

This pull request improves resource management by loading JSON schemas from package resources instead of relying on file paths. This change is particularly beneficial when Poetry is repackaged. Additionally, it removes unused imports.

Sequence diagram for JSON schema validation flow

sequenceDiagram
    participant Client
    participant Validator
    participant PackageResources

    Client->>Validator: validate_object(obj)
    Validator->>PackageResources: Load poetry.json schema
    PackageResources-->>Validator: Return schema content
    Validator->>PackageResources: Load poetry-schema.json from poetry.core
    PackageResources-->>Validator: Return core schema content
    Note over Validator: Compile and validate schemas
    Validator-->>Client: Return validation errors (if any)
Loading

File-Level Changes

Change Details Files
Load JSON schemas from package resources.
  • Replaced direct file path access with importlib.resources.files to load JSON schemas.
  • Updated schema loading to use package resources for both poetry and poetry-core schemas.
src/poetry/json/__init__.py
tests/json/test_schema.py
Removed unused imports.
  • Removed unused Path import.
src/poetry/json/__init__.py

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.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a 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. You can also use
    this command to specify where the summary should be inserted.

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

@Secrus Secrus marked this pull request as draft January 18, 2025 15:20
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 @Secrus - I've reviewed your changes and they look great!

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.

@Secrus Secrus marked this pull request as ready for review January 18, 2025 15:44
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 @Secrus - I've reviewed your changes and they look great!

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Can not load package data resources when running in a zipapp
1 participant