Skip to content

build: configure type checkers to run on min supported version#2474

Merged
peterschutt merged 9 commits intomainfrom
type-check-on-3.8
Oct 21, 2023
Merged

build: configure type checkers to run on min supported version#2474
peterschutt merged 9 commits intomainfrom
type-check-on-3.8

Conversation

@peterschutt
Copy link
Copy Markdown
Contributor

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 modifies our type-checking to run on the minimum supported version, instead of the latest.

Rationale:

  • Reduce incidence of backward incompatible changes.
  • Improve local development workflow - prior to this change, local development requires 2 python environments, 1 for 3.8 for dev/running tests, and one for 3.12 to run the type checkers. After this change developers will only have to run a single python environment for running both tests and type-checks.

Close Issue(s)

This PR modifies our type-checking to run on the minimum supported version, instead of the latest.

Rationale:
- Reduce incidence of backward incompatible changes.
- Improve local development workflow - prior to this change, local development requires 2 python environments, 1 for 3.8 for dev/running tests, and one for 3.12 to run the type checkers. After this change developers will only have to run a single python environment for running both tests and type-checks.
@peterschutt peterschutt requested review from a team as code owners October 20, 2023 00:02
Comment thread .github/workflows/ci.yml Outdated
Comment thread pyproject.toml Outdated
Comment thread tests/helpers.py Outdated
Copy link
Copy Markdown
Member

@JacobCoffee JacobCoffee left a comment

Choose a reason for hiding this comment

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

Maybe can suggest RTX as well

Copy link
Copy Markdown
Member

@JacobCoffee JacobCoffee left a comment

Choose a reason for hiding this comment

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

Are these required for end users or just available? Sorry I haven't caught up to this new change

Comment thread .github/workflows/ci.yml
Comment thread pyproject.toml Outdated
@peterschutt
Copy link
Copy Markdown
Contributor Author

Are these required for end users or just available? Sorry I haven't caught up to this new change

Sorry @JacobCoffee can you clarify the question please?

@peterschutt
Copy link
Copy Markdown
Contributor Author

Maybe can suggest RTX as well

In CONTRIBUTING? I don't have any experience with it - if you'd like to add something, I'm open to it.

Copy link
Copy Markdown
Member

@sobolevn sobolevn left a comment

Choose a reason for hiding this comment

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

Last final nit :)

Comment thread CONTRIBUTING.rst Outdated
Co-authored-by: Nikita Sobolev <[email protected]>
@sonarqubecloud
Copy link
Copy Markdown

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

Copy link
Copy Markdown
Member

@sobolevn sobolevn left a comment

Choose a reason for hiding this comment

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

Thank you! Great work!

@github-actions
Copy link
Copy Markdown

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

@peterschutt peterschutt merged commit 68de124 into main Oct 21, 2023
@peterschutt peterschutt deleted the type-check-on-3.8 branch October 21, 2023 05:57
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.

4 participants