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.

Sign up for GitHub

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

Jump to bottom

chore: add pyright type checking to workflows python code #429

Open
wants to merge 26 commits into
base: main
Choose a base branch
from
Open

chore: add pyright type checking to workflows python code #429

wants to merge 26 commits into from

Conversation

stevekeay
Copy link
Contributor

@stevekeay stevekeay commented Nov 1, 2024 •
edited
Loading

We have two options - mypy or pyright. This PR explores the pyright option. #424 explores the other

@github-actions GitHub Actions
Copy link

github-actions bot commented Nov 1, 2024 •
edited
Loading

☂️ Python Coverage

current status: ✅

Overall Coverage

Lines Covered Coverage Threshold Status
178 85 48% 0% 🟢

New Files

No new covered files...

Modified Files

No covered modified files...

updated for commit: 1a0b48d by action🐍

@stevekeay stevekeay changed the title Add pyright type checking to workflows python code Chore: add pyright type checking to workflows python code Nov 1, 2024
@stevekeay stevekeay changed the title Chore: add pyright type checking to workflows python code chore: add pyright type checking to workflows python code Nov 1, 2024
@stevekeay stevekeay mentioned this pull request Nov 1, 2024
Open
Steve Keay added 5 commits November 1, 2024 14:36
Refactor: rename local variable
fe90615
Add missing fields to example graphql query response
4c1a847 
The graphql query was changed at some point, but the example was never updated to suit
Refactor: Parse Nautobot data into a dataclass instead of a dict
f762a3d
Refactor method - use list comprehension instead of for loop
b3a82b0
Add pyright type checking for understack-workflows python code
488b8af 
Note that we hard-code python deps because the pre-commit checker operates in
its own independent venv and cannot access the deps that poetry installs.  This
seems broken, as it allows the versions to drift.  However it is better than
nothing.
Steve Keay added 19 commits November 1, 2024 14:42
Remove dead code
1932275
Base Mock on original class to satisfy type checker
e64fe72
Add explicit return to give a consistent return type
79c35fd
Fix return type on method signature
b47d3a5
Add null value checks to avoid pyright warning and runtime errors
d7f666b
Fix types in method signature to match implementation
8d0161e
Cast to string to avoid pyright false positive
5abe471
Catch null value to avoid pyright error and possible runtime error
c3c867b
Refactor code to avoid typing issues
2f87235
Update type signature to match implementation
e3e20a0
Supply missing argument to avoid linter warning
8baee74
Refactor code for readability and to avoid type issues
edb64b1
Add null checks to satisfy type checker and avoid runtime errors
7b78dc6
Refactor code to avoid type errors and avoid naming clash
7e3acef
Cast to string to avoid typeing issue
703a79e
Suppress pyright checking for imports that don't play nicely
5ab1fb6
Add checks, casts and update signatures to avoid typing errors
ebfddb4
Allow for null Interface attributes
4a7e3cb
Fail hard if there is a missing mac_addr in HP payload
b640762
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@stevekeay