Collections of pydantic models

Last update: Dec 26, 2022

Overview

pydantic-collections

The pydantic-collections package provides BaseCollectionModel class that allows you to manipulate collections of pydantic models (and any other types supported by pydantic).

Requirements

Python >= 3.7
pydantic >= 1.8.2

Installation

pip install pydantic-collections

Usage

Basic usage

from datetime import datetime

from pydantic import BaseModel
from pydantic_collections import BaseCollectionModel


class User(BaseModel):
    id: int
    name: str
    birth_date: datetime


class UserCollection(BaseCollectionModel[User]):
    pass


 user_data = [
        {'id': 1, 'name': 'Bender', 'birth_date': '2010-04-01T12:59:59'},
        {'id': 2, 'name': 'Balaganov', 'birth_date': '2020-04-01T12:59:59'},
    ]

users = UserCollection(user_data)
print(users)
#> UserCollection([User(id=1, name='Bender', birth_date=datetime.datetime(2010, 4, 1, 12, 59, 59)), User(id=2, name='Balaganov', birth_date=datetime.datetime(2020, 4, 1, 12, 59, 59))])
print(users.dict())
#> [{'id': 1, 'name': 'Bender', 'birth_date': datetime.datetime(2010, 4, 1, 12, 59, 59)}, {'id': 2, 'name': 'Balaganov', 'birth_date': datetime.datetime(2020, 4, 1, 12, 59, 59)}]
print(users.json())
#> [{"id": 1, "name": "Bender", "birth_date": "2010-04-01T12:59:59"}, {"id": 2, "name": "Balaganov", "birth_date": "2020-04-01T12:59:59"}]

Strict assignment validation

By default BaseCollectionModel has a strict assignment check

...
users = UserCollection()
users.append(User(id=1, name='Bender', birth_date=datetime.utcnow()))  # OK
users.append({'id': 1, 'name': 'Bender', 'birth_date': '2010-04-01T12:59:59'})
#> pydantic.error_wrappers.ValidationError: 1 validation error for UserCollection
#> __root__ -> 2
#>  instance of User expected (type=type_error.arbitrary_type; expected_arbitrary_type=User)

This behavior can be changed via Model Config

...
class UserCollection(BaseCollectionModel[User]):
    class Config:
        validate_assignment_strict = False
        
users = UserCollection()
users.append({'id': 1, 'name': 'Bender', 'birth_date': '2010-04-01T12:59:59'})  # OK
assert users[0].__class__ is User
assert users[0].id == 1

Using as a model field

BaseCollectionModel is a subclass of BaseModel, so you can use it as a model field

...
class UserContainer(BaseModel):
    users: UserCollection = []
        
data = {
    'users': [
        {'id': 1, 'name': 'Bender', 'birth_date': '2010-04-01T12:59:59'},
        {'id': 2, 'name': 'Balaganov', 'birth_date': '2020-04-01T12:59:59'},
    ]
}

container = UserContainer(**data)
container.users.append(User(...))
...

vartests is a Python library to perform some statistic tests to evaluate Value at Risk (VaR) Models

vartests is a Python library to perform some statistic tests to evaluate Value at Risk (VaR) Models, such as: T-test: verify if mean of distribution i

5 Jan 3, 2023

A model checker for verifying properties in epistemic models

Epistemic Model Checker This is a model checker for verifying properties in epistemic models. The goal of the model checker is to check for Pluralisti

2 Dec 22, 2021

Fit models to your data in Python with Sherpa.

Table of Contents Sherpa License How To Install Sherpa Using Anaconda Using pip Building from source History Release History Sherpa Sherpa is a modeli

134 Jan 7, 2023

pydantic-i18n is an extension to support an i18n for the pydantic error messages.

pydantic-i18n is an extension to support an i18n for the pydantic error messages

48 Dec 21, 2022

Python collections that are backended by sqlite3 DB and are compatible with the built-in collections

sqlitecollections Python collections that are backended by sqlite3 DB and are compatible with the built-in collections Installation $ pip install git+

11 Feb 3, 2022

Seamlessly integrate pydantic models in your Sphinx documentation.

71 Dec 26, 2022

🪄 Auto-generate Streamlit UI from Pydantic Models and Dataclasses.

Streamlit Pydantic Auto-generate Streamlit UI elements from Pydantic models. Getting Started • Documentation • Support • Report a Bug • Contribution •

103 Dec 25, 2022

Hyperlinks for pydantic models

Hyperlinks for pydantic models In a typical web application relationships between resources are modeled by primary and foreign keys in a database (int

10 Apr 18, 2022

Pydantic models for pywttr and aiopywttr.

2 Dec 8, 2022

EMNLP 2021 Adapting Language Models for Zero-shot Learning by Meta-tuning on Dataset and Prompt Collections

Adapting Language Models for Zero-shot Learning by Meta-tuning on Dataset and Prompt Collections Ruiqi Zhong, Kristy Lee*, Zheng Zhang*, Dan Klein EMN

42 Nov 3, 2022

PyTorch implementation of "Representing Shape Collections with Alignment-Aware Linear Models" paper.

deep-linear-shapes PyTorch implementation of "Representing Shape Collections with Alignment-Aware Linear Models" paper. If you find this code useful i

27 Sep 24, 2022

flask extension for integration with the awesome pydantic package

Flask-Pydantic Flask extension for integration of the awesome pydantic package with Flask. Installation python3 -m pip install Flask-Pydantic Basics v

249 Jan 6, 2023

flask extension for integration with the awesome pydantic package

Flask-Pydantic Flask extension for integration of the awesome pydantic package with Flask. Installation python3 -m pip install Flask-Pydantic Basics v

249 Jan 6, 2023

A curated list of awesome things related to Pydantic! 🌪️

Awesome Pydantic A curated list of awesome things related to Pydantic. These packages have not been vetted or approved by the pydantic team. Feel free

186 Jan 5, 2023

Pydantic model support for Django ORM

318 Jan 3, 2023

flask extension for integration with the awesome pydantic package

249 Jan 6, 2023

Flask Sugar is a web framework for building APIs with Flask, Pydantic and Python 3.6+ type hints.

Flask Sugar is a web framework for building APIs with Flask, Pydantic and Python 3.6+ type hints. check parameters and generate API documents automatically. Flask Sugar是一个基于flask,pyddantic,类型注解的API框架, 可以检查参数并自动生成API文档

162 Dec 26, 2022

Pydantic-ish YAML configuration management.

18 Oct 27, 2022

(A)sync client for sms.ru with pydantic responses

🚧 aioSMSru Send SMS Check SMS status Get SMS cost Get balance Get limit Get free limit Get my senders Check login/password Add to stoplist Remove fro

4 Jul 3, 2022

Comments

Bug dict() method: ignore or raised exception when using dict function attribute (ex. include, exclude, etc.)

Hi there, I tried to use the method dict but i got an error: KeyError(__root__) Here an example:

Model structure:


from datetime import datetime, time
from typing import Optional, Union
from pydantic import Field, validator, BaseModel
from pydantic_collections import BaseCollectionModel

class OpeningTime(BaseModel):
    weekday: int = Field(..., alias="weekday")
    day: Optional[str] = Field(alias="day")  # NB: keep it after number_weekday attribute
    from_time: Optional[time] = Field(alias="fromTime")
    to_time: Optional[time] = Field(alias="toTime")

    @validator("day", pre=True)
    def generate_weekday(cls, weekday: str, values) -> str:
        if weekday is None or len(weekday) == 0:
            return WEEKDAYS[str(values["weekday"])]
        return weekday



class OpeningTimes(BaseCollectionModel[OpeningTime]):
    pass


class PaymentMethod(BaseModel):
    type: str = Field(..., alias="type")
    card_type: str = Field(..., alias="cardType")


class PaymentMethods(BaseCollectionModel[PaymentMethod]):
    pass


class FuelType(BaseModel):
    type: str = Field(..., alias="Fuel")


class FuelTypes(BaseCollectionModel[FuelType]):
    pass


class AdditionalInfoStation(BaseModel):
    opening_times: Optional[OpeningTimes] = Field(alias="openingTimes")
    car_wash_opening_times: Optional[OpeningTimes] = Field(alias="openingTimesCarWash")
    payment_methods: PaymentMethods = Field(..., alias="paymentMethods")
    fuel_types: FuelTypes = Field(..., alias="fuelTypes")


class Example(BaseModel):
    hash_key: int = Field(..., alias="hashKey")
    range_key: str = Field(..., alias="rangeKey")
    location_id: str = Field(..., alias="locationId")
    name: str = Field(..., alias="name")
    street: str = Field(..., alias="street")
    address_number: str = Field(..., alias="addressNumber")
    zip_code: int = Field(..., alias="zipCode")
    city: str = Field(..., alias="city")
    region: str = Field(..., alias="region")
    country: str = Field(..., alias="country")
    additional_info: Union[AdditionalInfoStation] = Field(..., alias="additionalInfo")


class ExampleList(BaseCollectionModel[EniGeoPoint]):
    pass

Imagine that there is an ExampleList populated object and needed filters field during apply of dict method:

example_list: ExampleList = ExampleList.parse_obj([{......}])

#This istruction raised exception
example_list.dict(by_alias=True, inlcude={"hash_key", "range_key"})

The last istruction raise an error: Message: KeyError('__root__')

My env is:

pydantic==1.9.1
pydantic-collections==0.2.0
python version 3.9.7

If you need more info please contact me.

opened by aferrari94 6

Releases(v0.4.0)

v0.4.0(Oct 16, 2022)

Source code(tar.gz)
Source code(zip)
v0.3.0(Aug 8, 2022)

Source code(tar.gz)
Source code(zip)
v0.2.2(Jul 28, 2022)

Source code(tar.gz)
Source code(zip)
v0.2.1(Jun 28, 2022)

Source code(tar.gz)
Source code(zip)
v0.2.0(Nov 13, 2021)

Cache __getitem__ of BaseCollectionModelMeta
Source code(tar.gz)
Source code(zip)
v0.1.1(Oct 26, 2021)

Improve Optional types handling
Source code(tar.gz)
Source code(zip)
v0.1.0(Oct 23, 2021)

Source code(tar.gz)
Source code(zip)

Owner

Roman Snegirev

GitHub Repository

Collections of pydantic models

Related tags

Overview

pydantic-collections

Requirements

Installation

Usage

Basic usage

Strict assignment validation

Using as a model field

You might also like...

vartests is a Python library to perform some statistic tests to evaluate Value at Risk (VaR) Models

A model checker for verifying properties in epistemic models

Fit models to your data in Python with Sherpa.

pydantic-i18n is an extension to support an i18n for the pydantic error messages.

Python collections that are backended by sqlite3 DB and are compatible with the built-in collections

Seamlessly integrate pydantic models in your Sphinx documentation.

🪄 Auto-generate Streamlit UI from Pydantic Models and Dataclasses.

Hyperlinks for pydantic models

Pydantic models for pywttr and aiopywttr.

EMNLP 2021 Adapting Language Models for Zero-shot Learning by Meta-tuning on Dataset and Prompt Collections

PyTorch implementation of "Representing Shape Collections with Alignment-Aware Linear Models" paper.

flask extension for integration with the awesome pydantic package

flask extension for integration with the awesome pydantic package

A curated list of awesome things related to Pydantic! 🌪️

Pydantic model support for Django ORM

flask extension for integration with the awesome pydantic package

Flask Sugar is a web framework for building APIs with Flask, Pydantic and Python 3.6+ type hints.

Pydantic-ish YAML configuration management.

(A)sync client for sms.ru with pydantic responses

Comments

Bug dict() method: ignore or raised exception when using dict function attribute (ex. include, exclude, etc.)

Releases(v0.4.0)

v0.4.0(Oct 16, 2022)

v0.3.0(Aug 8, 2022)

v0.2.2(Jul 28, 2022)

v0.2.1(Jun 28, 2022)

v0.2.0(Nov 13, 2021)

v0.1.1(Oct 26, 2021)

v0.1.0(Oct 23, 2021)

Owner

Roman Snegirev

VHub - An API that permits uploading of vulnerability datasets and return of the serialized data

🌍 Create 3d-printable STLs from satellite elevation data 🌏

A forecasting system dedicated to smart city data

Tools for the analysis, simulation, and presentation of Lorentz TEM data.

Data Analytics: Modeling and Studying data relating to climate change and adoption of electric vehicles

MapReader: A computer vision pipeline for the semantic exploration of maps at scale

MidTerm Project for the Data Analysis FT Bootcamp, Adam Tycner and Florent ZAHOUI

Aggregating gridded data (xarray) to polygons

PySpark Structured Streaming ROS Kafka ApacheSpark Cassandra

Pyspark Spotify ETL

This cosmetics generator allows you to generate the new Fortnite cosmetics, Search pak and search cosmetics!

Using Python to derive insights on particular Pokemon, Types, Generations, and Stats

INFO-H515 - Big Data Scalable Analytics

A Python 3 library making time series data mining tasks, utilizing matrix profile algorithms

A tool to compare differences between dataframes and create a differences report in Excel

Create HTML profiling reports from pandas DataFrame objects

A Python Tools to imaging the shallow seismic structure

Flenser is a simple, minimal, automated exploratory data analysis tool.

This python script allows you to manipulate the audience data from Sl.ido surveys

Python library for creating data pipelines with chain functional programming