- Notifications
You must be signed in to change notification settings - Fork56
CLI Tool for converting pydantic models into typescript definitions
License
phillipdupuis/pydantic-to-typescript
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
A simple CLI tool for converting pydantic models into typescript interfaces.It supports all versions of pydantic, with polyfills for older versions to ensure that the resulting typescript definitions are stable and accurate.
Useful for any scenario in which python and javascript applications are interacting, since it allows you to have a single source of truth for type definitions.
This tool requires that you have the lovely json2ts CLI utility installed.Instructions can be found here:https://www.npmjs.com/package/json-schema-to-typescript
$ pip install pydantic-to-typescript
If you are encountering issues withpydantic>2, it is most likely because you're using an old version ofpydantic-to-typescript.Runpip install 'pydantic-to-typescript>2' and/or addpydantic-to-typescript>=2 to your project requirements.
You can now usepydantic-to-typescript to automatically validate and/or update typescript definitions as part of your CI/CD pipeline.
The github action can be found here:https://github.com/marketplace/actions/pydantic-to-typescript.The available inputs are documented here:https://github.com/phillipdupuis/pydantic-to-typescript/blob/master/action.yml.
| Prop | Description |
|---|---|
| ‑‑module | name or filepath of the python module you would like to convert. All the pydantic models within it will be converted to typescript interfaces. Discoverable submodules will also be checked. |
| ‑‑output | name of the file the typescript definitions should be written to. Ex: './frontend/apiTypes.ts' |
| ‑‑exclude | name of a pydantic model which should be omitted from the resulting typescript definitions. This option can be defined multiple times, ex:--exclude Foo --exclude Bar to exclude both the Foo and Bar models from the output. |
| ‑‑json2ts‑cmd | optional, the command used to invoke json2ts. The default is 'json2ts'. Specify this if you have it installed locally (ex: 'yarn json2ts') or if the exact path to the executable is required (ex: /myproject/node_modules/bin/json2ts) |
Define your pydantic models (ex: /backend/api.py):
fromfastapiimportFastAPIfrompydanticimportBaseModelfromtypingimportList,Optionalapi=FastAPI()classLoginCredentials(BaseModel):username:strpassword:strclassProfile(BaseModel):username:strage:Optional[int]hobbies:List[str]classLoginResponseData(BaseModel):token:strprofile:Profile@api.post('/login/',response_model=LoginResponseData)deflogin(body:LoginCredentials):profile=Profile(**body.dict(),age=72,hobbies=['cats'])returnLoginResponseData(token='very-secure',profile=profile)
Execute the command for converting these models into typescript definitions, via:
$ pydantic2ts --module backend.api --output ./frontend/apiTypes.ts
or:
$ pydantic2ts --module ./backend/api.py --output ./frontend/apiTypes.ts
or:
frompydantic2tsimportgenerate_typescript_defsgenerate_typescript_defs("backend.api","./frontend/apiTypes.ts")
The models are now defined in typescript...
/* tslint:disable *//**/* This file was automatically generated from pydantic models by running pydantic2ts./* Do not modify it by hand - just update the pydantic models and then re-run the script*/exportinterfaceLoginCredentials{username:string;password:string;}exportinterfaceLoginResponseData{token:string;profile:Profile;}exportinterfaceProfile{username:string;age?:number;hobbies:string[];}
...and can be used in your typescript code with complete confidence.
import{LoginCredentials,LoginResponseData}from"./apiTypes.ts";asyncfunctionlogin(credentials:LoginCredentials,resolve:(data:LoginResponseData)=>void,reject:(error:string)=>void){try{constresponse:Response=awaitfetch("/login/",{method:"POST",headers:{"Content-Type":"application/json"},body:JSON.stringify(credentials),});constdata:LoginResponseData=awaitresponse.json();resolve(data);}catch(error){reject(error.message);}}
About
CLI Tool for converting pydantic models into typescript definitions
Topics
Resources
License
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Packages0
Uh oh!
There was an error while loading.Please reload this page.
Contributors5
Uh oh!
There was an error while loading.Please reload this page.