[NOT READY FOR REVIEW] Update pre-commit to all files and Mypy setup #247

Ckk3 · 2025-05-15T15:51:42Z

Description

This PR introduces a mypy configuration similar to the one used in the main Strawberry project, and integrates a type-checking step into the CI workflows to ensure type safety is enforced consistently across the codebase.

Additionally, I ran pre-commit on all files, as many had not been formatted previously and did not follow the project's linting architecture. This helps standardize the codebase and reduce noise in future diffs.

Types of Changes

Issues Fixed or Closed by This PR

Fixes Add mypy setup like the main strawberry project #239

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

Enforce consistent code formatting and enhance type safety by updating pre-commit hooks and Mypy setup, with a test to validate lint enforcement

Enhancements:

Add taplo-format hook to pre-commit config and reformat all files
Extend Mypy configuration with Pydantic plugin alongside Strawberry plugin

Tests:

Introduce a dummy test in mapper.py to enforce pre-commit linting

sourcery-ai · 2025-05-15T15:51:46Z

Reviewer's Guide

This PR standardizes code formatting by updating the pre-commit setup to include the Taplo TOML formatter and reformatting all files, enhances type safety by extending the mypy configuration with the pydantic plugin, and adds a dummy function to enforce lint/pre-commit checks.

File-Level Changes

Change	Details	Files
Extend pre-commit configuration and reformat codebase	Added Taplo TOML formatter hook to pre-commit config Ran pre-commit formatting across all files to align with lint rules	`.pre-commit-config.yaml`
Enhance type checking with pydantic plugin	Modified mypy.ini to include pydantic.mypy alongside the existing plugin Targeted project source directory for consistent type checks	`mypy.ini`
Introduce dummy lint enforcement test	Added test_without_pre_commit function to validate pre-commit enforcement	`src/strawberry_sqlalchemy_mapper/mapper.py`

Assessment against linked issues

Issue	Objective	Addressed	Explanation
#239	Add a mypy setup similar to the main strawberry project.	✅
#239	Add a check to CI workflows to ensure type checking is enforced consistently.	✅

Possibly linked issues

Add mypy setup like the main strawberry project #239: The PR adds the requested mypy setup and CI checks to fix issue 239.

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!

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

Contact our support team for questions or feedback.
Visit our documentation for detailed guides and information.
Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

botberry · 2025-05-15T15:55:26Z

Thanks for adding the RELEASE.md file!

Here's a preview of the changelog:

This release does not introduce any new features or bug fixes. It focuses solely on internal code quality improvements.

Changes:

Added mypy configuration aligned with the main Strawberry project.
Enforced type checking via CI to ensure consistency.
Ran pre-commit across all files to standardize formatting and follow the project's linting architecture.

These changes aim to improve maintainability and ensure better development practices moving forward.

sourcery-ai

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

Remove the test_without_pre_commit dummy function before merging, as it’s only intended to trigger lint failures.
Add a mypy type‐checking step to your CI workflows (e.g. GitHub Actions) to ensure the new mypy.ini is actually enforced.
Make sure the pydantic mypy plugin is added to the project’s dev dependencies so mypy can load it successfully.

Here's what I looked at during the review

🟡 General issues: 1 issue found
🟡 Testing: 1 issue found
🟢 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.}

sourcery-ai · 2025-05-15T15:56:20Z

src/strawberry_sqlalchemy_mapper/mapper.py

@@ -883,7 +883,8 @@ def interface(self, model: Type[BaseModelType]) -> Callable[[Type[object]], Any]
        ):
            raise InterfaceModelNotPolymorphic(model)
        return self.type(model, make_interface=True)
-
+    def test_without_pre_commit():


issue (testing): Unexpected test method inside mapper – remove or relocate

That test method on the mapper class lacks a self parameter and will break the API—remove it or move it to the proper test suite.

.pre-commit-config.yaml

codspeed-hq · 2025-05-15T16:25:28Z

CodSpeed Performance Report

Merging #247 will not alter performance

_{Comparing Ckk3:run-precommit-in-all-files (4e54534) with main (7f2cbaf)}

Summary

✅ 1 untouched benchmarks

codecov-commenter · 2025-05-15T16:26:37Z

Codecov Report

Attention: Patch coverage is 0% with 18 lines in your changes missing coverage. Please review.

Project coverage is 88.94%. Comparing base (7f2cbaf) to head (4e54534).

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #247      +/-   ##
==========================================
- Coverage   89.94%   88.94%   -1.01%     
==========================================
  Files          17       17              
  Lines        1939     1953      +14     
  Branches      141      141              
==========================================
- Hits         1744     1737       -7     
- Misses        123      141      +18     
- Partials       72       75       +3

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

…nvalid rules in lint

Ckk3 added 2 commits May 15, 2025 12:46

Update pre-commit and mypy .ini just like the main strawberry project

97fcd53

add a lint error on purpose to test lint

1438dbf

Ckk3 marked this pull request as ready for review May 15, 2025 15:54

sourcery-ai bot reviewed May 15, 2025

View reviewed changes

add a release md and add file attr to tmol pre-commit

fe06304

botberry added bot:has-release-file bot:release-type-patch labels May 15, 2025

Ckk3 added 3 commits May 15, 2025 13:13

fix test action to run when a PR is ready for review

02e8b96

test mappe

dd930aa

fix action

cc0f7bd

continue with tests in lint in nox file

0eb03fc

Ckk3 changed the title ~~Update pre-commit to all files and Mypy setup~~ [NOT READY FOR REVIEW] Update pre-commit to all files and Mypy setup May 15, 2025

Ckk3 added 12 commits May 15, 2025 13:42

remove pydantic.mypy plugin

7779489

made first lint ajustment, but still missing lint test

8183f72

add ruff and black to lint te

59891f5

Fix nox file and add ruff to pyptoject toml

0bda534

fix poetry lock

e653367

fix command to raise error

18b1149

make ruff output errors

adf32a4

bring back black to pre-commit

75c902d

remove --diff from ruff because we want to run in all fil 8000 es, remove i…

5ba4a2a

…nvalid rules in lint

update pre-commit to ruff run lint and formatter

a8ecbff

separate ruff lint from formater in noxfile

ca21f70

remove test function from mapper

4e54534

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[NOT READY FOR REVIEW] Update pre-commit to all files and Mypy setup #247

[NOT READY FOR REVIEW] Update pre-commit to all files and Mypy setup #247

Interacting with Sourcery

Customizing Your Experience

Getting Help

[NOT READY FOR REVIEW] Update pre-commit to all files and Mypy setup #247

Are you sure you want to change the base?

[NOT READY FOR REVIEW] Update pre-commit to all files and Mypy setup #247

Conversation

Description

Types of Changes

Issues Fixed or Closed by This PR

Checklist

Summary by Sourcery

Reviewer's Guide

File-Level Changes

Assessment against linked issues

Possibly linked issues

Interacting with Sourcery

Customizing Your Experience

Getting Help

Choose a reason for hiding this comment

Choose a reason for hiding this comment

CodSpeed Performance Report

Merging #247 will not alter performance

Summary

Codecov Report