Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bojiang/typing_utils
Backport Python 3.8+ typing utils & add issubtype & more
https://github.com/bojiang/typing_utils
Last synced: 12 days ago
JSON representation
Backport Python 3.8+ typing utils & add issubtype & more
- Host: GitHub
- URL: https://github.com/bojiang/typing_utils
- Owner: bojiang
- License: apache-2.0
- Created: 2020-11-20T14:32:44.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-11-09T04:50:26.000Z (almost 2 years ago)
- Last Synced: 2024-10-14T09:19:22.769Z (25 days ago)
- Language: Python
- Homepage:
- Size: 33.2 KB
- Stars: 12
- Watchers: 1
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-python-typing - typing-utils - Backport 3.8+ runtime typing utils(for eg: get_origin) & add issubtype & more. (Backports and improvements)
README
# typing-utils
Backport Python3.8+ typing utils & issubtype & more
- [Install](#install)
- [API](#api)
- [issubtype](#issubtype)
- [get_origin](#get_origin)
- [get_args](#get_args)
- [get_type_hints](#get_type_hints)
[](https://pypistats.org/packages/typing_utils)
[](https://github.com/bojiang/typing_utils/actions/workflows/py36.yml)
[](https://github.com/bojiang/typing_utils/actions/workflows/py37.yml)
[](https://github.com/bojiang/typing_utils/actions/workflows/py38.yml)
[](https://github.com/bojiang/typing_utils/actions/workflows/py39.yml)
## Install
``` bash
pip install typing_utils
```
## API
- [issubtype](#issubtype)
- [get_origin](#get_origin)
- [get_args](#get_args)
- [get_type_hints](#get_type_hints)
### issubtype
Check that the left argument is a subtype of the right.
For unions, check if the type arguments of the left is a subset of the right.
Also works for nested types including ForwardRefs.
Examples:
```python
from typing_utils import issubtype
issubtype(typing.List, typing.Any) == True
issubtype(list, list) == True
issubtype(list, typing.List) == True
issubtype(list, typing.Sequence) == True
issubtype(typing.List[int], list) == True
issubtype(typing.List[typing.List], list) == True
issubtype(list, typing.List[int]) == False
issubtype(list, typing.Union[typing.Tuple, typing.Set]) == False
issubtype(typing.List[typing.List], typing.List[typing.Sequence]) == True
JSON = typing.Union[
int, float, bool, str, None, typing.Sequence["JSON"],
typing.Mapping[str, "JSON"]
]
issubtype(str, JSON, forward_refs={'JSON': JSON}) == True
issubtype(typing.Dict[str, str], JSON, forward_refs={'JSON': JSON}) == True
issubtype(typing.Dict[str, bytes], JSON, forward_refs={'JSON': JSON}) == False
```
### get_origin
Get the unsubscripted version of a type.
This supports generic types, Callable, Tuple, Union, Literal, Final and ClassVar.
Return None for unsupported types.
Examples:
```python
from typing_utils import get_origin
get_origin(Literal[42]) is Literal
get_origin(int) is None
get_origin(ClassVar[int]) is ClassVar
get_origin(Generic) is Generic
get_origin(Generic[T]) is Generic
get_origin(Union[T, int]) is Union
get_origin(List[Tuple[T, T]][int]) == list
```
### get_args
Get type arguments with all substitutions performed.
For unions, basic simplifications used by Union constructor are performed.
Examples:
```python
from typing_utils import get_args
get_args(Dict[str, int]) == (str, int)
get_args(int) == ()
get_args(Union[int, Union[T, int], str][int]) == (int, str)
get_args(Union[int, Tuple[T, int]][str]) == (int, Tuple[str, int])
get_args(Callable[[], T][int]) == ([], int)
```
### get_type_hints
Return type hints for an object.
This is often the same as obj.__annotations__, but it handles
forward references encoded as string literals, and if necessary
adds Optional[t] if a default value equal to None is set.
The argument may be a module, class, method, or function. The annotations
are returned as a dictionary. For classes, annotations include also
inherited members.
TypeError is raised if the argument is not of a type that can contain
annotations, and an empty dictionary is returned if no annotations are
present.
BEWARE -- the behavior of globalns and localns is counterintuitive
(unless you are familiar with how eval() and exec() work). The
search order is locals first, then globals.
- If no dict arguments are passed, an attempt is made to use the
globals from obj (or the respective module's globals for classes),
and these are also used as the locals. If the object does not appear
to have globals, an empty dictionary is used.
- If one dict argument is passed, it is used for both globals and
locals.
- If two dict arguments are passed, they specify globals and
locals, respectively.