-
-
Notifications
You must be signed in to change notification settings - Fork 43
build: switch to basedpyright #1001
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
Conversation
Reviewer's GuideThis PR replaces Pyright with Basedpyright as the project’s static type checker by updating the CI pipeline, project dependencies and configuration, CLI commands, and documentation to use and configure basedpyright. Class diagram for CLI dev commands type checker switchclassDiagram
class DevCommands {
+format_code() int
+type_check() int
+pre_commit() int
}
DevCommands : type_check() now runs basedpyright
DevCommands : type_check() previously ran pyright
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.OpenSSF Scorecard
Scanned Files
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @electron271 - I've reviewed your changes and they look great!
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Deploying tux with
|
Latest commit: |
f75fcaa
|
Status: | ✅ Deploy successful! |
Preview URL: | https://336457f8.tux-afh.pages.dev |
Branch Preview URL: | https://basedpyright.tux-afh.pages.dev |
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #1001 +/- ##
=====================================
Coverage 9.57% 9.57%
=====================================
Files 123 123
Lines 10415 10415
Branches 1279 1279
=====================================
Hits 997 997
Misses 9316 9316
Partials 102 102
*This pull request uses carry forward flags. Click here to find out more.
☔ View full report in Codecov by Sentry. |
Description
basedpyright allows for a lot of nicer features, one of the main ones being significantly better compatibility with non vscode editors
see https://docs.basedpyright.com/latest/ and the "Benefits over pyright" section on the documentation for more info
Guidelines
My code follows the style guidelines of this project (formatted with Ruff)
I have performed a self-review of my own code
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation if needed
My changes generate no new warnings
I have tested this change
Any dependent changes have been merged and published in downstream modules
I have added all appropriate labels to this PR
I have followed all of these guidelines.
How Has This Been Tested? (if applicable)
ran
basedpyright
to check typesScreenshots (if applicable)
Please add screenshots to help explain your changes.
Additional Information
Please add any other information that is important to this PR.
Summary by Sourcery
Switch from Pyright to BasedPyright for static type checking across the project
Enhancements:
Build:
Documentation:
Chores: