Add mypy to CI pipeline and improve code quality checks -> v1.1.2
#6
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Add `mypy` type checking to CI pipeline (`ci.yml`) - Rename `lint` job to `code-quality` - Rename `test` job to `code-tests` - Add and configure pytest options in `pyproject.toml` - Simplify pytest call in `ci.yml` - Specify version numbers for dependencies - Improve type annotations in `casregnum.py` to comply with mypy - Add `casregnum.pyi` type stub for static type checking - Add `py.typed` marker file to indicate typed package - Extend CI matrix to multiple OS and Python versions - Bump version to 1.1.2
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This pull request introduces several improvements to the codebase, focusing on code quality, type safety, and workflow enhancements. The most notable changes include stricter type annotations and error handling in the
CASclass, the addition of a type stub file for better static analysis, and updates to the CI workflow to include type checking and improved dependency management.Code quality and type safety improvements:
CASclass methods (__format__,__eq__, and__lt__) to use more precise type annotations (objectinstead ofCASfor comparison methods), added docstrings for clarity, and improved error handling when comparing objects of different types.casregnum.pyithat provides explicit type signatures for all public methods and properties of theCASclass, enhancing static type checking and editor support.Continuous Integration and dependency management:
test→code-tests,lint→code-quality), running tests using configuration frompyproject.toml, and adding a step formypytype checking. [1] [2] [3]pyproject.tomlto specify minimum versions, addedmypy, and moved test coverage options into the pytest configuration for consistency. [1] [2]Version update:
1.1.1to1.1.2to reflect these improvements.