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

allow FullCleanOptions in full_clean arg annotation #667

Merged
merged 1 commit into from
Dec 8, 2024

Conversation

g-as
Copy link
Contributor

@g-as g-as commented Dec 3, 2024

Description

Types of Changes

  • Core
  • Bugfix
  • New feature
  • Enhancement/optimization
  • Documentation

Issues Fixed or Closed by This PR

Checklist

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • I have tested the changes and verified that they work and don't break anything (as well as I can manage).

Summary by Sourcery

Bug Fixes:

  • Fix the type annotation for the 'full_clean' argument in the DjangoMutationCUD class to accept both boolean and FullCleanOptions types.

Copy link
Contributor

sourcery-ai bot commented Dec 3, 2024

Reviewer's Guide by Sourcery

This PR enhances type annotations in the Django mutation field by allowing the FullCleanOptions type as an alternative to boolean for the full_clean parameter. The implementation modifies the type hint of the full_clean parameter in the DjangoMutationCUD class initialization method.

Updated class diagram for DjangoMutationCUD

classDiagram
    class DjangoMutationCUD {
        +DjangoMutationCUD(type input_type, bool|FullCleanOptions full_clean=True, string argument_name, string key_attr, kwargs)
    }
    class FullCleanOptions
    DjangoMutationCUD --> FullCleanOptions : full_clean
Loading

File-Level Changes

Change Details Files
Updated type annotation for the full_clean parameter
  • Added import for FullCleanOptions type
  • Modified full_clean parameter type hint from bool to Union[bool, FullCleanOptions]
strawberry_django/mutations/fields.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 @g-as - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider adding type checking tests to verify the FullCleanOptions type works as expected in different contexts.
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.

@bellini666 bellini666 merged commit 1dd34ad into strawberry-graphql:main Dec 8, 2024
21 of 22 checks passed
@g-as g-as deleted the bugfix/full_clean branch December 9, 2024 08:28
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.

2 participants