Skip to main content

json-tag

Python support for JSON#.

Configures pydantic to use the JSON# convention.

Install

pip install json-tag

Usage

Define your types:

class Circle(JsonTagModel):
    radius: float

class Rectangle(JsonTagModel):
    width: float
    height: float

Shape = tagged_union(Circle, Rectangle)

Serialize:

circle = Circle(radius=4.0)
circle.to_json()
# {"#type":"Circle","radius":4}

Deserialize:

from pydantic import TypeAdapter

shape = TypeAdapter(Shape).validate_json('{"#type":"Circle","radius":4}')
# Circle(radius=4.0)

Custom tag names via __json_tag_name__ class variable:

class PersonalVehicle(JsonTagModel):
    __json_tag_name__ = "Car"
    make: str

API

Export Description
JsonTagModel Base model — subclasses get #type automatically
tagged_union(*types) Create a discriminated union with #type
TYPE_FIELD The "#type" constant

Metadata

Release files for json-tag 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for json-tag 1.0.0
File Size Uploaded
json_tag-1.0.0.tar.gz 3.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for json-tag 1.0.0
File Interpreter ABI Platform
json_tag-1.0.0-py3-none-any.whl Python 3 none any Details

Total release size: 7.3 kB

Release files / json_tag-1.0.0.tar.gz

Download URL json_tag-1.0.0.tar.gz
Size 3.9 kB
Tags Source
SHA-256 checksum
How to use checksums
b6cfde2eee13ea0b58c7f4eed6cc59f1f68e603e117797fc3404b584eb745127
BLAKE2b-256 checksum
How to use checksums
8e9454676b693d620a0b4244cdcdcc82012f3c1ebe0ec77a82b4f697745c90a5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.13

Release files / json_tag-1.0.0-py3-none-any.whl

Download URL json_tag-1.0.0-py3-none-any.whl
Size 3.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
f33c3536bb9a9b8daf646aec53738af9a8d8f459e5ba1d3486c0e19666b9745c
BLAKE2b-256 checksum
How to use checksums
c5151df4d59c16c34c73b5d730638a32e953666a4d98edb61c5f32e4eff8ee0a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.13

Release history Release notifications | RSS feed

This release

1.0.0 This release

2 release files

0.1.7

2 release files

0.1.6

2 release files

0.1.5

2 release files

0.1.4

2 release files

0.1.2

2 release files

0.1.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page