Hyperlinks for pydantic models

Last update: Apr 18, 2022

Overview

Hyperlinks for pydantic models

In a typical web application relationships between resources are modeled by primary and foreign keys in a database (integers, UUIDs etc.). The most natural way to represent relationships in REST APIs is by URLs to the related resources (explained in this blog).

hrefs makes it easy to add hyperlinks between pydantic models in a declarative way. Just declare a Href field and the library will automatically convert between keys and URLs:

class Book(ReferrableModel):
    id: int

    class Config:
        details_view = "get_book"

class Library(BaseModel):
    books: List[Href[Book]]

@app.get("/library")
def get_library():
    # Will produce something like:
    # {"books":["http://example.com/books/1","http://example.com/books/2","http://example.com/books/3"]}
    return Library(books=[1,2,3]).json()

hrefs was written especially with FastAPI in mind, but integrates to any application or framework using pydantic to parse and serialize models.

Check out the documentation to get started!

Installation

Install the library using pip or your favorite package management tool:

$ pip install hrefs

Comments

`Href` JSON schema

The JSON schema of Href should be that of its URL type. Right now pydantic doesn't support examining subfields of generic models, but provided it did, the Href.__modify_schema__() method should be implemented to use that.

Re: https://github.com/samuelcolvin/pydantic/discussions/2902

opened by jasujm 0

Configurable key type

I would like to configure keys so that they could be called something else than just id. They could even be composite and support more complicated URL structures:

class Page(ReferrableModel):
    book: Href[Book]
    page_number: int

    class Config:
        details_view = "get_page"

@app.get("/books/{book_id}/pages/{page_number}", response_model=Page)
def get_page(book_id: UUID, page_number: int):
    ...

# Href[Page] would have key type consisting of (book_id, page_number): Tuple[UUID, int])

opened by jasujm 0

Self references
I would like to be able to write self href fields for models, so that they would be identified with URL in API responses:

class Book(ReferrableModel): self: Href[ForwardRef(Book)] Book.update_forward_refs()

I would like to populate the self reference from field that may not necessarily be self (i.e. the id field of the underlying database model)

The real primary key of the underlying (database) model doesn't appear in the model definition, so it needs to be configurable

Book(id=123) # this should work and produce -> {"self":"http://example.com/books/123"} or similar
opened by jasujm 0

Releases(0.5.1)

0.5.1(Mar 23, 2022)
Fixed

.readthedocs.yaml file syntax

Source code(tar.gz)
Source code(zip)
0.5(Mar 22, 2022)
Added

Implement Href.__hash__()

hypothesis build strategy for hyperlinks

hrefs.starlette.href_context() for setting things other than Starlette requests as hyperlink context

Source code(tar.gz)
Source code(zip)
0.4(Jan 17, 2022)
Added

Support Python 3.10

Changed

Use URL type in Href schema if using pydantic version 1.9 or later

Fixed

Require pydantic version 1.8 or later, since 1.7 doesn't work with the library

Source code(tar.gz)
Source code(zip)
0.3.1(Dec 29, 2021)
Added

Updated documentation about inheritance

Fixed

Minor documentation fixes

Add package metadata back to PKG-INFO

Source code(tar.gz)
Source code(zip)
0.3(Dec 27, 2021)
Added

tox for test automation

Support for hyperlinks as model keys

Changed

Replace get_key_type() and get_key_url() with parse_as_key() and parse_as_url(), respectively

Source code(tar.gz)
Source code(zip)
0.2(Dec 17, 2021)
Added

Implement Href.__modify_schema__()

Make it possible to configure model key by using hrefs.PrimaryKey annotation.

Changed

Split Referrable.href_types() into get_key_type() and get_url_type(), respectively

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

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 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

A Proof of concept of a modern python CLI with click, pydantic, rich and anyio

httpcli This project is a proof of concept of a modern python networking cli which can be simple and easy to maintain using some of the best packages

17 Nov 15, 2022

MongoX is an async python ODM for MongoDB which is built on top Motor and Pydantic.

MongoX MongoX is an async python ODM (Object Document Mapper) for MongoDB which is built on top Motor and Pydantic. The main features include: Fully t

112 Dec 4, 2022

Comprehensive OpenAPI schema generator for Django based on pydantic

🗡️ Djagger Automated OpenAPI documentation generator for Django. Djagger helps you generate a complete and comprehensive API documentation of your Dj

13 Nov 26, 2022

A Fast Command Analyser based on Dict and Pydantic

Alconna Alconna 隶属于ArcletProject，在Cesloi内有内置 Alconna 是 Cesloi-CommandAnalysis 的高级版，支持解析消息链一般情况下请当作简易的消息链解析器/命令解析器文档暂时的文档 Example from arclet.alcon

19 Jan 3, 2023

🪛 A simple pydantic to Form FastAPI model converter.

pyfa-converter Makes it pretty easy to create a model based on Field [pydantic] and use the model for www-form-data. How to install? pip install pyfa_

20 Dec 22, 2022

A RESTful API for creating and monitoring resource components of a hypothetical build system. Built with FastAPI and pydantic. Complete with testing and CI.

diskspace-monitor-CRUD Background The build system is part of a large environment with a multitude of different components. Many of the components hav

67 Dec 14, 2022

Ever felt tired after preprocessing the dataset, and not wanting to write any code further to train your model? Ever encountered a situation where you wanted to record the hyperparameters of the trained model and able to retrieve it afterward? Models Playground is here to help you do that. Models playground allows you to train your models right from the browser.

Models Playground 🗂️ Upload a Preprocessed Dataset 🌠 Choose whether to perform Classification or Regression 🦹 Enter the Dependent Variable ?

19 Dec 10, 2022

pyhsmm - library for approximate unsupervised inference in Bayesian Hidden Markov Models (HMMs) and explicit-duration Hidden semi-Markov Models (HSMMs), focusing on the Bayesian Nonparametric extensions, the HDP-HMM and HDP-HSMM, mostly with weak-limit approximations.

Bayesian inference in HSMMs and HMMs This is a Python library for approximate unsupervised inference in Bayesian Hidden Markov Models (HMMs) and expli

527 Dec 4, 2022

An implementation of model parallel GPT-3-like models on GPUs, based on the DeepSpeed library. Designed to be able to train models in the hundreds of billions of parameters or larger.

GPT-NeoX An implementation of model parallel GPT-3-like models on GPUs, based on the DeepSpeed library. Designed to be able to train models in the hun

3.1k Jan 8, 2023

CDIoU and CDIoU loss is like a convenient plug-in that can be used in multiple models. CDIoU and CDIoU loss have different excellent performances in several models such as Faster R-CNN, YOLOv4, RetinaNet and . There is a maximum AP improvement of 1.9% and an average AP of 0.8% improvement on MS COCO dataset, compared to traditional evaluation-feedback modules. Here we just use as an example to illustrate the code.

CDIoU-CDIoUloss CDIoU and CDIoU loss is like a convenient plug-in that can be used in multiple models. CDIoU and CDIoU loss have different excellent p

24 Jul 19, 2022

Code for pre-training CharacterBERT models (as well as BERT models).

Pre-training CharacterBERT (and BERT) This is a repository for pre-training BERT and CharacterBERT. DISCLAIMER: The code was largely adapted from an o

31 Dec 5, 2022

Hyperlinks for pydantic models

Related tags

Overview

Hyperlinks for pydantic models

Installation

You might also like...

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

A Proof of concept of a modern python CLI with click, pydantic, rich and anyio

MongoX is an async python ODM for MongoDB which is built on top Motor and Pydantic.

Comprehensive OpenAPI schema generator for Django based on pydantic

A Fast Command Analyser based on Dict and Pydantic

🪛 A simple pydantic to Form FastAPI model converter.

A RESTful API for creating and monitoring resource components of a hypothetical build system. Built with FastAPI and pydantic. Complete with testing and CI.

pyhsmm - library for approximate unsupervised inference in Bayesian Hidden Markov Models (HMMs) and explicit-duration Hidden semi-Markov Models (HSMMs), focusing on the Bayesian Nonparametric extensions, the HDP-HMM and HDP-HSMM, mostly with weak-limit approximations.

An implementation of model parallel GPT-3-like models on GPUs, based on the DeepSpeed library. Designed to be able to train models in the hundreds of billions of parameters or larger.

Code for pre-training CharacterBERT models (as well as BERT models).

Comments

`Href` JSON schema

Configurable key type

Self references

Releases(0.5.1)

0.5.1(Mar 23, 2022)

0.5(Mar 22, 2022)

0.4(Jan 17, 2022)

0.3.1(Dec 29, 2021)

0.3(Dec 27, 2021)

0.2(Dec 17, 2021)

Owner

Jaakko Moisio

FastAPI CRUD template using Deta Base

Fast, simple API for Apple firmwares.

FastAPI interesting concepts.

Fastapi-ml-template - Fastapi ml template with python

Fastapi performans monitoring

Adds integration of the Chameleon template language to FastAPI.

A server hosts a FastAPI application and multiple clients can be connected to it via SocketIO.

API written using Fast API to manage events and implement a leaderboard / badge system.

Complete Fundamental to Expert Codes of FastAPI for creating API's

An extension library for FastAPI framework

Pagination support for flask

Reusable utilities for FastAPI

Keycloak integration for Python FastAPI

Browse JSON API in a HTML interface.

Easy and secure implementation of Azure AD for your FastAPI APIs 🔒

Cube-CRUD is a simple example of a REST API CRUD in a context of rubik's cube review service.

API Simples com python utilizando a biblioteca FastApi

fastapi-cache is a tool to cache fastapi response and function result, with backends support redis and memcached.

Sample-fastapi - A sample app using Fastapi that you can deploy on App Platform

Opentracing support for Starlette and FastApi