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

feat: support annotation with Constraints #411

Merged
merged 2 commits into from
Oct 18, 2023
Merged

feat: support annotation with Constraints #411

merged 2 commits into from
Oct 18, 2023

Conversation

guacs
Copy link
Member

@guacs guacs commented Oct 18, 2023

Pull Request Checklist

  • New code has 100% test coverage
  • (If applicable) The prose documentation has been updated to reflect the changes introduced by this PR
  • (If applicable) The reference documentation has been updated to reflect the changes introduced by this PR
  • Pre-Commit Checks were ran and passed
  • Tests were ran and passed

Description

  • This PR enables annotating any types with Constraints to specify the constraints. It is important to note that this does NOT mean that these constraints will be validated at runtime, but that polyfactory will take them into account when creating the model instances.

@guacs guacs requested review from a team as code owners October 18, 2023 05:40
Copy link
Contributor

@Alc-Alc Alc-Alc left a comment

Choose a reason for hiding this comment

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

nit: probably use double backticks?

@guacs
Copy link
Member Author

guacs commented Oct 18, 2023

nit: probably use double backticks?

Isn't that usually done in documentation though?

Copy link
Member

@cofin cofin left a comment

Choose a reason for hiding this comment

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

lgtm

@guacs guacs enabled auto-merge (squash) October 18, 2023 15:48
@sonarcloud
Copy link

sonarcloud bot commented Oct 18, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

100.0% 100.0% Coverage
0.0% 0.0% Duplication

@guacs guacs merged commit e1f7a47 into main Oct 18, 2023
21 checks passed
@guacs guacs deleted the support-constraints branch October 18, 2023 15:53
@github-actions
Copy link

Documentation preview will be available shortly at https://litestar-org.github.io/polyfactory-docs-preview/411

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.

None yet

3 participants