Feature/improve typing slightly #5
Conversation
pyproject.toml
Outdated
| @@ -8,7 +8,7 @@ readme = "README.md" | |||
| homepage = "https://github.com/harrymander/dataclasses-struct" | |||
| repository = "https://github.com/harrymander/dataclasses-struct" | |||
| documentation = "https://github.com/harrymander/dataclasses-struct/blob/main/README.md#usage" | |||
| packages = [{include = "dataclasses_struct"}] | |||
| packages = [{ include = "dataclasses_struct" }, { include = "dataclasses_struct/py.typed" }] | |||
There was a problem hiding this comment.
This is not needed since Poetry automatically includes everything in the package source dir. (You can check by installing in a virtualenv and the py.typed file should be in the lib/site-packages/dataclasses_struct dir)
There was a problem hiding this comment.
Right. Was basing this on a few examples that specifically add it in setup.py as it isn't a normal source file, but I guess Poetry knows about it and included it already.
|
I don't use pylance/VS Code regularly for Python dev, so I assume the provided mypy extension is not compatible? I originally had tried annotating If pylance supports it out the gate then that's cool. Do you know if it possible to add tests for this similar to how I have done for mypy (doesn't need to be in this PR)? BTW - thanks for all the PRs, will get round to the others soon when I get the chance :) |
dataclasses_struct/dataclass.py
Outdated
| @@ -275,7 +280,7 @@ def from_packed(cls, data: bytes) -> cls_type: | |||
|
|
|||
| def _make_class( | |||
| cls: type, endian: str, allow_native: bool, validate: bool | |||
| ) -> type: | |||
| ) -> type[DataclassStructProtocol]: | |||
There was a problem hiding this comment.
This needs to be Type to support Python 3.8 - see CI error.
The mypy extension is not useful for PyLance. I'm trying to improve things as PyLance is both edit-time type checking (rather than just on-save) and provides all the autocomplete information, so having it understand these classes would be ideal. Currently using It appears the @dataclass_transform is discarding the relevant information. Unfortunately when I experimentally added a second decorator to add the protocol type information it still wasn't a complete solution - it meant you could no longer inherit from one of these structs.
Thanks for the project! Took a while to find and add the changes I need, but certainly a lot better than the alternative of making my own. |
* Avoids a `struct` name clash that was confusing PyLance * Add `from_packed` and `pack` to `DataclassStructProtocol` * Expose `DataclassStructProtocol` in top-level module
harrymander
force-pushed
the
feature/improve-typing-slightly
branch
from
5f0328e to
9a9b4b7
Compare
Clean up some minor typing issues.
structname clash that was confusing PyLance (VSCode)from_packedandpackmethods to the protocol