Skip to content

A microlibrary that defines a Json type alias for Python

License

Notifications You must be signed in to change notification settings

kevinheavey/jsonalias

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

jsonalias

A microlibrary that defines a Json type alias for Python.

This README is longer than the library

Seriously, this is all the code:

from typing import Dict, List, Union

Json = Union[Dict[str, "Json"], List["Json"], str, int, float, bool, None]

If we only supported Python >= 3.10, it would fit on one line:

Json = dict[str, 'Json'] | list['Json'] | str | int | float | bool | None

Then why make a library out of it?

I want to use this type alias in multiple projects and it's just about long enough to be annoying.

This alias should probably get added to the Python typing module. If it does and I haven't put a big notice on this README, please open a PR.

Example

from jsonalias import Json

d: Json = {"foo": ["bar", {"x": "y"}]}

It's not working please help???

Make sure you're using mypy >= 0.981 and running with the --enable-recursive-aliases flag.

Special Thanks

GitHub user wbolster for this comment notifying us that mypy could now do JSON.

About

A microlibrary that defines a Json type alias for Python

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages