Comments (1)
Actually, I'm not sure the overriding @property
is the best approach to implement this. This could potentially cause issues with code inspection tools.
Instead, a class argument could be added to enable this:
# Serialise all properties defined in the class
@dataclass
class Rectangle(JsonSchemaMixin, serialise_properties=True):
width: int
height: int
@property
def area(self) -> int:
return width * height
# Serialise only the named properties
@dataclass
class Rectangle(JsonSchemaMixin, serialise_properties=("area",)):
width: int
height: int
@property
def area(self) -> int:
return width * height
The following will iterate through the property type annotations:
def get_property_annotations(klass):
members = inspect.getmembers(klass, inspect.isdatadescriptor)
for name, member in members:
if name != "__weakref__":
yield (name, member.fget.__annotations__['return'])
from dataclasses-jsonschema.
Related Issues (20)
- Verify that literal values are valid when decoding HOT 2
- JsonSchemaMixin not working with multiple inheritance. HOT 1
- Optional object is not working HOT 3
- Support discriminators when used with Union types
- Dataclass from json schema
- support for range type?
- apply JsonSchema via class decorator (instead of inheritance)
- The declaration of `ForwardRef` in `get_class_type_hints` doesn't include `is_class`, which breaks evaluation on Python >=3.9.8
- _NULL_TYPE not JSON serializable
- Optional List of dataclasses does not allow None Value HOT 2
- Tuples don't work properly
- Order in `Union` field containing `JsonSchemaMixin` matters (i.e. throws for some orders)
- Support for Python 3.10
- Schema for tuple types incompatible with OpenAPI Spec 3.0
- FieldEncoder `json_schema` property not used by validator HOT 1
- Dataclass: Unable to create schema for 'str | None' HOT 1
- TypeError thrown from valid Union type HOT 2
- Pipe | as alternative of Union is not working properly HOT 3
- Validation: How to validate from "bad" dataclass object directly? HOT 1
- schema doesn't support inline definition
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from dataclasses-jsonschema.