Introduces Linting (pylint) and Static Checking (mypy) for the SDK #411
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed changes
Implements: #390
This PR is pretty large, to say the least, because it introduces linting (using
pylint
) and static checking (usingmypy
- previously, I was going to usepyright
). To introduce linting and static checking for PRs, you need to fix all of the issues that it flags. This happened to be a lot issues because during the development of v3 of this SDK, style (aka linting) and certain type checks (aka mypy) was lacking intentionally in order to meet the timeline for release. Since python is pretty forgiving in the type check department, we deferred that until now.The user can test their compliance with
pylint
andmypy
locally by invoking the same process used in the GitHub actions as follows:make lint
make static
GitHub actions run for this PR:
Other notable changes:
pylint
andmypy
issues for new PRs and on main_
for class scoping@dataclass_json
annotations (now just extends theDataClassJsonMixin
class indataclass_json
because the project doesn't implement apylint
plugin for lintingLatest
classes, these just needed to be alias definitions instead of extending the class since the linter through that was better (agreed because we weren't introducing any new variables, functions, etc)NOTES:
Types of changes
What types of changes does your code introduce to the community Python SDK?
Put an
x
in the boxes that applyChecklist
Put an
x
in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.Further comments
NA