izxxr / oblate Goto Github PK

Description

Allow using type annotations for registering the fields similar to how dataclasses and pydantic register fields.

This needs consideration on which standard type maps to which Oblate field along with several other design constraints such as dealing with PEP 563. Should be implemented before #6

Types mapping table

F: field mapping to some type

[1] It needs consideration whether there should be a generic class that maps to the TypeExpr field
[2] These types would be provided by the new oblate.types module (e.g. oblate.types.NotRequired etc.)

This was a feature in 0.x version but was removed in 1.x rewrite due to various design constraints but with the introduction of contextual objects and various other features that resolves those design issues, this could be reconsidered.

Fields

• fields.primitive.String
• fields.primitive.Integer
• fields.primitive.Float
• fields.primitive.Boolean

• fields.nesting.Object
• fields.nesting.Partial

• fields.types.Union
• fields.types.Any
• fields.types.Literal
• fields.types.TypeExpr

• fields.structs.Dict
• fields.structs.TypedDict
• fields.structs.List
• fields.structs.Set
• fields.structs.Tuple

• fields.stdlib.Date
• fields.stdlib.DateTime
• fields.stdlib.Enum
• fields.stdlib.UUID

• fields.special.Email
• fields.special.URL
• fields.special.PhoneNumber
• fields.special.PaymentCardNumber
• fields.special.Color
• fields.special.Coordinates
• fields.special.FilePath

Validators

• validate.Length
• validate.RegEx
• validate.Range
• validate.Exclude
• validate.Or