wrapper/construct-typing
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

further extended README.md

Browse source
This commit is contained in:
Tim Rid 2020-12-13 16:01:24 +01:00
parent 0f84b85c8f
commit 2731cb45f2
1 changed files with 7 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -12,7 +12,12 @@ You just have to type:
pip install construct-typing
```
## Stubs
## Usage
I'm mostly working with VSCode and Pylance (which works really great) ??? But i have also tested the stubs with mypy. ????
## Explanation
### Stubs
The **construct-stubs** is used for creating type hints for the orignial `construct` package. In particular the `build` and `parse` methods get type hints. So the core of the stubs are the `TypeVar`s `ParsedType` and `BuildTypes`:
- The `build` method of a `Construct` converts an object of one of the types defined by `BuildTypes` to a `bytes` object.
- The `parse` method of a `Construct` converts a `bytes` object to an object of type `ParsedType`.
@ -30,7 +35,7 @@ Currently only the very unspecific type `Any` can be used as type hint (maybe in
The biggest disadvantage is that autocompletion for the named subcons is not available.
## Typed
### Typed
To further enhance the type hints and include and autocompletion for these complex constructs the **construct_typed** package is used.
It implements the following new types:
@ -40,12 +45,6 @@ It implements the following new types:
- TypedUnion
## Usage
I'm mostly working with VSCode and Pylance (which works really great) ??? But i have also tested the stubs with mypy. ????
## Examples
An example of the added `TypedStruct` class:
```python