[python] Add bool to supported types and improve type specification
#141
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 adds boolean to the supported sparse coordinate types and also
improves the type definition of coordinate types to ensure that the
values in each type are homogeneous:
BadCoord = Union[int, str]
BadCoords = Union[BadCoord, Sequence[BadCoord]]
# ["this", 1] is bad, but is a valid as a BadCoords value
GoodCoord = TypeVar("GoodCoord", int, str)
GoodCoords = Union[GoodCoord, Sequence[GoodCoord]]
# ["this", 1] is bad, and is *not* valid as a GoodCoords value
# ["this", "that"] is a valid as a GoodCoords value
# [1, 2] is valid as a GoodCoords value
bkmartinjr
reviewed
Feb 24, 2023
| types.Slice[pa.TimestampType], | ||
| SparseCoord, | ||
| Sequence[SparseCoord], | ||
| types.Slice[SparseCoord], | ||
| pa.Array, | ||
| pa.ChunkedArray, | ||
| npt.NDArray[np.integer], |
There was a problem hiding this comment.
should we also have a numpy-array-like for np.float, np.datetime64, etc?
There was a problem hiding this comment.
This is a good idea but I think it makes sense for a future change. (Also, I am not familiar enough with the numpy typing system at the moment to do the right thing here.)
bkmartinjr
approved these changes
Feb 24, 2023
johnkerl
approved these changes
Feb 24, 2023
| types.Slice[pa.TimestampType], | ||
| SparseCoord, | ||
| Sequence[SparseCoord], | ||
| types.Slice[SparseCoord], | ||
| pa.Array, | ||
| pa.ChunkedArray, | ||
| npt.NDArray[np.integer], |
johnkerl
changed the title
bool to supported types and improve type specification.bool to supported types and improve type specification
thetorpedodog
added a commit
that referenced
this pull request
Mar 3, 2023
My previous change which used TypeVar for coordinate types [1] was actually a Bad Idea. While it was better in that it prohibited heterogeneous collections and slices, it was worse in that made the SparseDFCoord type (and derived types) into generic types, which we do not want. The *right* way to avoid repeating all the possible types is to make a union of the possible *containers*, and then specify *that* with all the possible contents that may go into those containers. [1]: #141
thetorpedodog
added a commit
that referenced
this pull request
Mar 3, 2023
My previous change which used TypeVar for coordinate types [1] was actually a Bad Idea. While it was better in that it prohibited heterogeneous collections and slices, it was worse in that made the SparseDFCoord type (and derived types) into generic types, which we do not want. The *right* way to avoid repeating all the possible types is to make a union of the possible *containers*, and then specify *that* with all the possible contents that may go into those containers. [1]: #141
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 adds boolean to the supported sparse coordinate types and also improves the type definition of coordinate types to ensure that the values in each type are homogeneous:
I don’t see a bug entry for this but it was something we discussed earlier today, and in the process I realized another thing we could improve.
Context: #960