schemas
__all__ = ['BaseSchema', 'PolymorphicSchema', 'Bytes', 'Union']
module-attribute
BaseSchema
Bases: Schema
Source code in griptape/schemas/base_schema.py
15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 |
|
DATACLASS_TYPE_MAPPING = {None: Schema.TYPE_MAPPING, dict: fields.Dict, bytes: Bytes, Any: fields.Raw}
class-attribute
instance-attribute
Meta
from_attrs_cls(attrs_cls)
classmethod
Generate a Schema from an attrs class.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
attrs_cls |
type
|
An attrs class. |
required |
Source code in griptape/schemas/base_schema.py
Bytes
Bases: Field
Source code in griptape/schemas/bytes_field.py
PolymorphicSchema
Bases: BaseSchema
PolymorphicSchema is based on https://github.com/marshmallow-code/marshmallow-oneofschema.
Source code in griptape/schemas/polymorphic_schema.py
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 |
|
inner_class = inner_class
instance-attribute
type_field = 'type'
class-attribute
instance-attribute
type_field_remove = True
class-attribute
instance-attribute
__init__(inner_class, **kwargs)
dump(obj, *, many=None, **kwargs)
Source code in griptape/schemas/polymorphic_schema.py
get_data_type(data)
Returns name of the schema during load() calls, given the data being loaded. Defaults to looking up type_field
in the data.
Source code in griptape/schemas/polymorphic_schema.py
get_obj_type(obj)
load(data, *, many=None, partial=None, unknown=None, **kwargs)
Source code in griptape/schemas/polymorphic_schema.py
validate(data, *, many=None, partial=None)
Source code in griptape/schemas/polymorphic_schema.py
Union
Bases: Field
Field that accepts any one of multiple fields.
Source: https://github.com/adamboche/python-marshmallow-union Each argument will be tried until one succeeds.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
fields |
list[Field]
|
The list of candidate fields to try. |
required |
reverse_serialize_candidates |
bool
|
Whether to try the candidates in reverse order when serializing. |
False
|