Add shapely stubs #12033
Merged
Add shapely stubs #12033
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
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
srittau
approved these changes
May 25, 2024
stubs/shapely/shapely/__init__.pyi
Outdated
| from .set_operations import * | ||
| from .strtree import * | ||
|
|
||
| __version__: str |
There was a problem hiding this comment.
Nit (needs import):
Suggested change
| __version__: str | |
| __version__: Literal[str] |
There was a problem hiding this comment.
I think you meant Final. Fixed.
stubs/shapely/shapely/_typing.pyi
Outdated
Comment on lines
55
to
61
| @type_check_only | ||
| class SupportsRead(Protocol[_T_co]): | ||
| def read(self) -> _T_co: ... | ||
|
|
||
| @type_check_only | ||
| class SupportsWrite(Protocol[_T_contra]): | ||
| def write(self, s: _T_contra, /) -> object: ... |
There was a problem hiding this comment.
Considering that these are copies from _typeshed, maybe we should just re-export them? (Not that it matters terribly.)
There was a problem hiding this comment.
I deleted these definitions and used the typeshed one's instead. There is no need to redefine them.
|
Diff from mypy_primer, showing the effect of this PR on open source code: psycopg (https://github.com/psycopg/psycopg)
+ psycopg/psycopg/types/shapely.py:47: error: Unused "type: ignore" comment [unused-ignore]
+ psycopg/psycopg/types/shapely.py:52: error: Unused "type: ignore" comment [unused-ignore]
|
srittau
approved these changes
May 25, 2024
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.
I basically copied the stubs from https://github.com/hamdanal/python-stubs/tree/5ecdeaede3a5d97b00b5d4298f13b7028c01e6eb/stubs/shapely-stubs
Note that these stubs are somewhat complete as I've been working on them for quiet some time. There is an extensive test suite which passes both mypy and pyright in addition to runtime type checking. I've also been testing those stubs in VS Code (through Pylance, no actual type checking) for a while and they seem to work as expected. Hopefully this will make the review a bit easier.
I haven't ported any of the tests to typeshed for now. I might add a subset of them later to avoid regressions.
Technical notes:
BaseGeometry->Geometry->object. For input types, I useshapely.Geometryas much as possible. For output types, I useshapely.geometry.BaseGeometry. This is becauseBaseGeometryis an implementation detail that should not be required to be imported by users -- they should be able to annotate their code usingGeometry. For output types,Geometryis not very useful as it doesn't have any attributes or methods.Related: shapely/shapely#1741 (comment)