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

Make end in DateRangeSchema not required #589

Merged
merged 3 commits into from
Dec 15, 2024
Merged

Conversation

ejimsan
Copy link
Member

@ejimsan ejimsan commented Dec 15, 2024

Summary by Sourcery

Enhancements:

  • Make the 'end' field in DateRangeSchema optional by setting 'required' to False.

Copy link
Contributor

sourcery-ai bot commented Dec 15, 2024

Reviewer's Guide by Sourcery

This PR modifies the date schemas to make them more flexible by making certain fields optional and allowing null values. The main changes involve updating field requirements in PartialDateSchema and DateRangeSchema.

Updated class diagram for Date Schemas

classDiagram
    class PartialDateSchema {
        - Integer year
        + Integer year allow_none=True
        Integer month allow_none=True
        Integer day allow_none=True
        String notes allow_none=True load_default=""
    }
    class DateRangeSchema {
        Nested PartialDateSchema start allow_none=True
        - Nested PartialDateSchema end allow_none=True
        + Nested PartialDateSchema end allow_none=True required=False
        String notes allow_none=True
    }
Loading

File-Level Changes

Change Details Files
Modified field requirements in date schemas to be more permissive
  • Changed year field to allow null values instead of being required
  • Made the end field explicitly optional in date ranges while maintaining null value support
ebl/fragmentarium/application/date_schemas.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

Copy link
Contributor

@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 @ejimsan - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Making year optional in PartialDateSchema seems problematic - what's the use case for having a date without a year? This could lead to validation issues downstream. Please provide justification for this change.
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.

Copy link

codeclimate bot commented Dec 15, 2024

Code Climate has analyzed commit c3d426b and detected 0 issues on this pull request.

The test coverage on the diff in this pull request is 100.0% (75% is the threshold).

This pull request will bring the total coverage in the repository to 91.5% (0.0% change).

View more on Code Climate.

@ejimsan ejimsan merged commit d2bcf2d into master Dec 15, 2024
12 checks passed
@ejimsan ejimsan deleted the make-date-end-not-required branch December 15, 2024 16:36
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.

1 participant