Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gowee/json2pyi
Generate Python type definitions from a JSON sample (both Pydantic BaseModel and TypedDict are supported)
https://github.com/gowee/json2pyi
dataclass json mypy pep589 pydantic python typeddict web-app
Last synced: 3 months ago
JSON representation
Generate Python type definitions from a JSON sample (both Pydantic BaseModel and TypedDict are supported)
- Host: GitHub
- URL: https://github.com/gowee/json2pyi
- Owner: Gowee
- Created: 2020-12-01T07:30:49.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-06-22T15:48:06.000Z (over 1 year ago)
- Last Synced: 2024-10-30T01:56:57.684Z (3 months ago)
- Topics: dataclass, json, mypy, pep589, pydantic, python, typeddict, web-app
- Language: Rust
- Homepage: https://json2pyi.pages.dev
- Size: 4.34 MB
- Stars: 44
- Watchers: 2
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# JSON to Python Types
*json2pyi* infers a type schema from a sample JSON file and generates Python type definitions ([`dataclass`](https://docs.python.org/3/library/dataclasses.html), Pydantic [`BaseModel`](https://pydantic-docs.helpmanual.io/usage/models/) or PEP-589 [`TypedDict`](https://www.python.org/dev/peps/pep-0589/)) accordingly. It runs in browser, requiring no installation.
__🌐 Available online 🔗__:
## Example
**Input:**
```jsonc
{
"page": {
"id": "kctbh9vrtdwd",
"name": "GitHub",
"url": "https://www.githubstatus.com",
"time_zone": "Etc/UTC",
"updated_at": "2020-12-03T08:11:21.385Z"
},
"components": [
{
"id": "8l4ygp009s5s",
"name": "Git Operations",
"status": "operational",
"created_at": "2017-01-31T20:05:05.370Z",
"updated_at": "2020-10-29T22:51:43.831Z",
"position": 1,
"description": "Performance of git clones, pulls, pushes, and associated operations",
"showcase": false,
"start_date": null,
"group_id": null,
"page_id": "kctbh9vrtdwd",
"group": false,
"only_show_if_degraded": false
},
/* ... */
],
"incidents": [],
"scheduled_maintenances": [],
"status": {
"indicator": "none",
"description": "All Systems Operational"
}
}
```
**Output:**
```python
@dataclass
class Page:
id = str
name = str
url = str
time_zone = str
updated_at = str
@dataclass
class Components:
id = str
name = str
status = str
created_at = str
updated_at = str
position = int
description = Optional[str]
showcase = bool
start_date = None
group_id = None
page_id = str
group = bool
only_show_if_degraded = bool
@dataclass
class Status:
indicator = str
description = str
@dataclass
class RootObject:
page = Page
components = List[Components]
incidents = List[Any]
scheduled_maintenances = List[Any]
status = Status
```
Or:
```python
from typing import TypedDict, Optional, List
from datetime import datetime
IncidentUpdate = TypedDict("IncidentUpdate", {"body": str, "created_at": datetime, "display_at": datetime, "id": str, "incident_id": str, "status": str, "updated_at": datetime})
IncidentOrScheduledMaintenance = TypedDict("IncidentOrScheduledMaintenance", {"created_at": datetime, "id": str, "impact": str, "incident_updates": List[IncidentUpdate], "monitoring_at": None, "name": str, "page_id": str, "resolved_at": None, "shortlink": str, "status": str, "updated_at": datetime, "scheduled_for": Optional[datetime], "scheduled_until": Optional[datetime]})
Component = TypedDict("Component", {"created_at": datetime, "description": None, "id": str, "name": str, "page_id": str, "position": int, "status": str, "updated_at": datetime})
Status = TypedDict("Status", {"description": str, "indicator": str})
Page = TypedDict("Page", {"id": str, "name": str, "url": str, "updated_at": datetime})
RootObject = TypedDict("UnnammedType3C2BC8", {"page": Page, "status": Status, "components": List[Component], "incidents": List[IncidentOrScheduledMaintenance], "scheduled_maintenances": List[IncidentOrScheduledMaintenance]})
```
## TODO
- [ ] Detect tuple (array)
- [x] Detect UUID / datetime
- [ ] Detect Enum
- [x] Merge data types with similar structure and common name prefix/suffix
- [x] Detect recursive type definition (e.g. tree)
- [x] Include imports of non-primitive types
- [x] Generate type alias for complex Union
- [ ] Improve the logic of determining whether a Union ix complex or not
- [x] Generate TypedDict
- [x] ~~Refactor to unify TypedDict and dataclass generation~~ Seperated intendedly for clear code structure.
- [x] Compile to WASM and provide a Web-based app
- [ ] Allow to tweak more options on Web app (partially blocked by )
- [ ] Avoid merging data types with totally different structures in a union
- [ ] Avoid unnecessary heap allocation by reducing one-time usage of Vec
- [ ] Allow specifying the order of generated data types
- [ ] Support more input types, such as JSON Schema
- [ ] Support more target languages
- [ ] Add usage instructions
## Credits
The project is inspired by:
-
-
-
-