Skip to main content

A microlibrary that defines a Json type alias for Python.

Project description

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jsonalias-0.1.2.tar.gz (2.6 kB view hashes)

Uploaded Source

Built Distribution

jsonalias-0.1.2-py3-none-any.whl (2.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page