Added a py.typed for type checkers #35
Closed
Conversation
This file contains 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
Fix `hs.plot.plot_roi_map` when using `CircleROI` and improvements
Co-authored-by: Jonas Lähnemann <[email protected]>
Release 2.1.0
Bumps [softprops/action-gh-release](https://github.com/softprops/action-gh-release) from 2.0.4 to 2.0.5. - [Release notes](https://github.com/softprops/action-gh-release/releases) - [Changelog](https://github.com/softprops/action-gh-release/blob/master/CHANGELOG.md) - [Commits](softprops/action-gh-release@9d7c94c...69320db) --- updated-dependencies: - dependency-name: softprops/action-gh-release dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]>
updates: - [github.com/astral-sh/ruff-pre-commit: v0.4.2 → v0.4.4](astral-sh/ruff-pre-commit@v0.4.2...v0.4.4)
…onfig [pre-commit.ci] pre-commit autoupdate
…ons/RELEASE_next_patch/softprops/action-gh-release-2.0.5 Bump softprops/action-gh-release from 2.0.4 to 2.0.5
Co-authored-by: Eric Prestat <[email protected]>
Co-authored-by: Eric Prestat <[email protected]>
Co-authored-by: Eric Prestat <[email protected]>
Co-authored-by: Eric Prestat <[email protected]>
… backend - various issues fixed in matplotlib 3.9
New Feature: Add sub-figure plotting
Co-authored-by: Carter Francis <[email protected]>
Add parameters to specify matplotlib axes in `hs.plot.plot_*`
This tells type checkers like pyright that this project includes type hints and does not require a type stub for type elucidation
|
Well, something went wrong with the commits here due to a rebase. Closing. |
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.
Description of the change
In order for type checkers like pyright to "turn on" type checking for an installed package, that package must either provide a type stub (a .pyi "dummy" python file that only includes type signatures) or it must include an empty
py.typedfile in the package directory. See PEP561 for reference.My change adds the py.typed file and also ensures that it is installed via setuptools.
Now, installing it in a venv as
pip install <path-to-hyperspy>, I go from this error message and no hints:to this successful type hinting:
Progress of the PR
upcoming_changesfolder (seeupcoming_changes/README.rst),readthedocsdoc build of this PR (link in github checks)