Skip to main content

Tool to generate Python types based on TypedDict from a JSON Schema

Project description

JSON Schema generate Python types

Tools to generate Python types based on TypedDict from a JSON schema

Quick start

install:

python3 -m pip install --user jsonschema-gentypes

Convert a JSON schema to a Python file contains the types:

jsonschema-gentypes --json-schema=<JSON schema> --python=<destination Python file>

Config file

You can also write a config file named jsonschema-gentypes.yaml with:

headers: >
  # Automatically generated file from a JSON schema
# Used to correctly format the generated file
callbacks:
  - - black
  - - isort
generate:
  - # JSON schema file path
    source: jsonschema_gentypes/schema.json
    # Python file path
    destination: jsonschema_gentypes/configuration.py
    # The name of the root element
    root_name: Config
    # Argument passed to the API
    api_arguments:
      additional_properties: Only explicit
    # Rename an element
    name_mapping: {}
    # The minimum Python version that the code should support. By default the
    # currently executing Python version is chosen. Note that the output
    # may require typing_extensions to be installed.
    python_version: '3.11'

And just run:

jsonschema-gentypes

Default

The default values are exported in the Python file, then you can do something like that:

value_with_default = my_object.get('field_name', my_schema.FIELD_DEFAULT)

Limitations

Requires Python 3.8

See the issues with label "limitation".

Pre-commit hooks

This project provides pre-commit hooks to automatically generate the files.

repos:
  - repo: https://github.com/camptocamp/jsonschema-gentypes
    rev: <version> # Use the ref you want to point at
    hools:
      - id: jsonschema-gentypes
        files: |
          (?x)^(
              jsonschema-gentypes\.yaml|
              <schema_path>\.json
          )$

See also the pre_commit section in the configuration to run the pre-commit just after the generation, for example with:

pre_commit:
  enabled: true
  arguments:
    - --color=never

OpenAPI3

We can also generate types for OpenAPI3 schemas (automatically detected).

The result of our example in tests/openapi3.json can be used in pyramid with for example:

import pyramid.request
from pyramid.view import view_config
from openaoi3 import *

def open_api(func):
    def wrapper(request: pyramid.request.Request, **kwargs) -> Any:
        typed_request = {}
        try:
            typed_request{'request_body'} = request.json
        except Exception as e:
            pass
        typed_request{'path'} = request.matchdict
        typed_request{'query'} = request.params

        return = func(request, request_typed=typed_request, **kwargs)

    return wrapper


@view_config(route_name="route_name", renderer="json")
@open_api
def view(
  request: pyramid.request.Request,
  request_typed: OgcapiCollectionsCollectionidGet,
) -> OgcapiCollectionsCollectionidGetResponse:
    return {...}

Contributing

Install the pre-commit hooks:

pip install pre-commit
pre-commit install --allow-missing-config

The prospector tests should pass.

The code should be typed.

The code should be tested with pytests.

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

jsonschema_gentypes-2.2.1.tar.gz (25.5 kB view details)

Uploaded Source

Built Distribution

jsonschema_gentypes-2.2.1-py3-none-any.whl (40.0 kB view details)

Uploaded Python 3

File details

Details for the file jsonschema_gentypes-2.2.1.tar.gz.

File metadata

  • Download URL: jsonschema_gentypes-2.2.1.tar.gz
  • Upload date:
  • Size: 25.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.6

File hashes

Hashes for jsonschema_gentypes-2.2.1.tar.gz
Algorithm Hash digest
SHA256 ef6b37def0184019e76dbcd5bb0a863b1c8cc7183e8f4fced6e79a15a1c884c8
MD5 de79cb6bac1ffe9d6878182a115a9f39
BLAKE2b-256 f194dcda5f332af04a105feaf74c691520e3656505d56baa17c985882586f655

See more details on using hashes here.

Provenance

File details

Details for the file jsonschema_gentypes-2.2.1-py3-none-any.whl.

File metadata

File hashes

Hashes for jsonschema_gentypes-2.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 52f7595590761eb184e0ee5fbb3412767f8a8b9443d4195e7280daf669e15a1b
MD5 dd8deb85f6d023bf71fa710bf54bf771
BLAKE2b-256 02ffcdc71cde2743e7672ebd8a6f2becaf6a4123af60c391e8d2337bb607dd44

See more details on using hashes here.

Provenance

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