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

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 Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

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

exdrf_gen_al2pd-0.1.11-py3-none-any.whl (26.4 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for exdrf_gen_al2pd-0.1.11-py3-none-any.whl
Algorithm Hash digest
SHA256 b952138ea85ac125f1e34af61f2992256609a691262fca30ba5c19573413a5eb
MD5 ad76485ffda3992024b8fe5855330e74
BLAKE2b-256 46a90317c03697ef16476ed88b0efeae24a9efaf9c64aace13c3a6edf0218ccd

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