dict
DictConvertible
Bases: ABC
Mixin class enabling conversion of an object to/from a Python dict.
Subclasses should override to_dict
and from_dict
to implement the conversion.
Source code in fancy_dataclass/dict.py
from_dict(d, **kwargs)
abstractmethod
classmethod
Constructs an object from a dictionary of (attribute, value) pairs.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
d |
AnyDict
|
Dict to convert into an object |
required |
kwargs |
Any
|
Keyword arguments |
{}
|
Returns:
Type | Description |
---|---|
Self
|
Converted object of this class |
Source code in fancy_dataclass/dict.py
to_dict(**kwargs)
abstractmethod
Converts an object to a dict.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
kwargs |
Any
|
Keyword arguments |
{}
|
Returns:
Type | Description |
---|---|
AnyDict
|
A Python dict |
DictDataclass
Bases: DataclassMixin
Mixin class for dataclasses that can be converted to and from a Python dict.
A subclass may configure settings by using DictDataclassSettings
fields as keyword arguments when inheriting from DictDataclass
.
Per-field settings can be passed into the metadata
argument of each dataclasses.field
. See DictDataclassFieldSettings
for the full list of settings.
Source code in fancy_dataclass/dict.py
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 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 |
|
from_dict(d, **kwargs)
classmethod
Constructs an object from a dictionary of fields.
This may also perform some basic type/validity checking.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
d |
AnyDict
|
Dict to convert into an object |
required |
kwargs |
Any
|
Keyword arguments
|
{}
|
Returns:
Type | Description |
---|---|
Self
|
Converted object of this class |
Source code in fancy_dataclass/dict.py
to_dict(**kwargs)
Converts the object to a Python dict which, by default, suppresses values matching their dataclass defaults.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
kwargs |
Any
|
Keyword arguments
|
{}
|
Returns:
Type | Description |
---|---|
AnyDict
|
A dict whose keys match the dataclass's fields |
Source code in fancy_dataclass/dict.py
DictDataclassFieldSettings
dataclass
Bases: FieldSettings
Settings for DictDataclass
fields.
Each field may define a metadata
dict containing any of the following entries:
suppress
: suppress this field in the dict representation- Note: if the field is a class variable, it is excluded by default; you can set
suppress=False
to force the field's inclusion.
- Note: if the field is a class variable, it is excluded by default; you can set
suppress_default
: suppress this field in the dict if it matches its default value (overrides class-levelsuppress_defaults
)
Source code in fancy_dataclass/dict.py
DictDataclassSettings
dataclass
Bases: DataclassMixinSettings
Class-level settings for the DictDataclass
mixin.
Subclasses of DictDataclass
may set the following boolean flags as keyword arguments during inheritance:
suppress_defaults
: suppress default values in its dictstore_type
: store the object's type in its dictqualified_type
: fully qualify the object type's name in its dictflattened
: ifTrue
,DictDataclass
subfields fields will be merged together with the main fields (provided there are no name collisions); otherwise, they are nestedvalidate
: ifTrue
, attempt to validate data when converting from a dict