Skip to main content

Generate pydantic models content using DRF from sqlalchemy models.

Project description

exdrf-gen-al2pd

exdrf-gen-al2pd is an exdrf-gen plugin that generates Pydantic ExModel classes from SQLAlchemy-backed ExDataset metadata (same field partitioning idea as bk-one db2m). Generated modules pair with exdrf-gen-al2r when you want matching FastAPI routers.

Python 3.12.2+ is required.

Generated models per resource

For each ExResource the emitter writes one module (snake-case plural stem, e.g. widgets.py) under the resource’s category path containing:

  • Xxx — label fields (minimum_field_set) plus primary keys.
  • XxxEx(Xxx) — extra scalars and relations (PagedList[Related] / optional nested related label types), with forward refs where needed.
  • XxxCreate — writable create payload: excludes derived columns, depends_on FK scalars, read_only, audit names created_on / updated_on, and the lone PK when is_primary_simple. To-many relations use {rel}_ids (single related PK) or {rel}_keys (list[dict[str, Any]] for composite related PKs).
  • XxxEdit — same payload rules for updates but no primary-key fields. Omitted when the resource is a composite-PK link with only PK scalars (then only XxxCreate is emitted).

The package also writes api.py at the output root with re-exports, and adds __init__.py files so the tree is importable as a package.

Command-line usage

exdrf-gen al2pd DATASET OUT-PATH

Or: python -m exdrf_gen al2pd DATASET OUT-PATH.

  • DATASETmodule.path:DeclarativeBase for SQLAlchemy (same as other al2* plugins).
  • OUT-PATH — required unless EXDRF_AL2PD_PATH is set; directory for generated Python modules.

Dependencies

See pyproject.toml: exdrf, exdrf-al, exdrf-gen, exdrf-pd, click, pydantic.

Plugin registration

[project.entry-points.'exdrf.plugins']
exdrf_gen = 'exdrf_gen_al2pd'

See also

  • exdrf-gen-al2r — FastAPI routers that import these schemas.
  • exdrf-genREADME.md.

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

exdrf_gen_al2pd-0.1.19.tar.gz (22.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

exdrf_gen_al2pd-0.1.19-py3-none-any.whl (23.8 kB view details)

Uploaded Python 3

File details

Details for the file exdrf_gen_al2pd-0.1.19.tar.gz.

File metadata

  • Download URL: exdrf_gen_al2pd-0.1.19.tar.gz
  • Upload date:
  • Size: 22.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for exdrf_gen_al2pd-0.1.19.tar.gz
Algorithm Hash digest
SHA256 426f655f16092020f7b29a1b559a9180381fef45681d9e10af3c3f4fe8754013
MD5 27b63950690a149c9c6b4913bad931fa
BLAKE2b-256 7b784cb30ec41b720c5c1d02f9559cec81244d3da56b6ba8f2791cc0d7c7e210

See more details on using hashes here.

File details

Details for the file exdrf_gen_al2pd-0.1.19-py3-none-any.whl.

File metadata

File hashes

Hashes for exdrf_gen_al2pd-0.1.19-py3-none-any.whl
Algorithm Hash digest
SHA256 a6a84fc253545abec179603c2ae17a48259903157a9ccf38a12d88c75387a0a4
MD5 70d76eb9e0ec5a4250afd68de1e42bac
BLAKE2b-256 9604e11f49172d77c4d1b55087699a5fa89bb7b5f0258b57b272432aa892190c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page