msgspec-extras 0.1.0

No project description provided

msgspec-extras

A small collection of types that extend msgspec's built-in type support.

Installation

pdm add msgspec-extras

Type Support

msgspec-extras supports all msgspec native types - see the full list in the msgspec documentation. It also adds the following custom types.

Datetime

• PastDate - must be earlier than today
• PastDatetime - must be earlier than now
• FutureDate - must be later than today
• FutureDatetime - must be later than now

These types require the enc_hook/dec_hook to be passed to msgspec's encode/decode calls.

from datetime import datetime, date

import msgspec
from msgspec_extras import PastDate, PastDatetime, FutureDate, FutureDatetime, enc_hook, dec_hook

past_date = msgspec.json.decode('"2020-03-21"', type=PastDate, dec_hook=dec_hook)
past_date_json = msgspec.json.encode(past_date, enc_hook=enc_hook)

msgspec.json.decode('"2020-03-21"', type=FutureDate, dec_hook=dec_hook)
# Raises `msgspec.ValidationError` as the date isn't in the future

Numeric

Type	Constraint
PositiveInt	> 0
PositiveFloat	> 0
NonNegativeInt	>= 0
NonNegativeFloat	>= 0
NegativeInt	< 0
NegativeFloat	< 0
NonPositiveInt	<= 0
NonPositiveFloat	<= 0

String

• HttpUrl - must be a valid HTTP or HTTPS URL

Usage

The numeric and string types are just Annotated aliases over msgspec's native types (e.g. Annotated[int, msgspec.Meta(gt=0)]), so they need no hooks and work as drop-in replacements anywhere you'd use int, float, or str:

import msgspec
from msgspec_extras import PositiveFloat


class Product(msgspec.Struct):
    name: str
    price: PositiveFloat


product = msgspec.json.decode(b'{"name": "Widget", "price": 5.1}', type=Product)
msgspec.json.encode(product)

Socials