genericconfig¶
Generic data model for configuration attributes.
AttrDict
¶
Bases: BaseModel
, MutableMapping
An object whose attributes can also be accessed through subscription, like with a dictionary.
Special pydantic configuration settings:
extra
Allow any attributes/fields to be defined - this is what makes this pydantic model an attribute dictionary.validate_assignment
Validate and cast set values. This is mainly relevant for sub-classes ofAttrDict
, where specific attributes have been defined.arbitrary_types_allowed
If a custom type is used for an attribute that doesn't have avalidate()
method, don't fail setting the attribute.
Source code in oteapi/models/genericconfig.py
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 |
|
model_config = ConfigDict(extra='allow', validate_assignment=True, arbitrary_types_allowed=True)
class-attribute
instance-attribute
¶
clear()
¶
Source code in oteapi/models/genericconfig.py
103 104 105 106 107 108 109 |
|
get(key, default=None)
¶
Source code in oteapi/models/genericconfig.py
66 67 |
|
items()
¶
Source code in oteapi/models/genericconfig.py
57 58 |
|
keys()
¶
Source code in oteapi/models/genericconfig.py
60 61 |
|
pop(key, default=PydanticUndefined)
¶
Source code in oteapi/models/genericconfig.py
143 144 145 146 147 148 149 150 151 152 153 |
|
popitem()
¶
MutableMapping popitem
-method.
Important
Unlike the regular dict.popitem()
method, this one does not respect
LIFO (last-in, first-out).
This is due to the fact that attributes are stored in a random order when
initializing the model.
However, it will respect LIFO with respect to the internal model_fields
.
Source code in oteapi/models/genericconfig.py
155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 |
|
reset_field(field)
¶
Reset a field to its default value.
Warning
This will remove/delete a field that is not part of the model schema.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
field |
str
|
The field to reset. |
required |
Source code in oteapi/models/genericconfig.py
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 |
|
update(other=None, **kwargs)
¶
Source code in oteapi/models/genericconfig.py
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 |
|
values()
¶
Source code in oteapi/models/genericconfig.py
63 64 |
|
GenericConfig
¶
Bases: BaseModel
Generic class for configuration objects.
Special pydantic configuration settings:
validate_assignment
Validate and cast set values. This is mainly relevant for sub-classes ofAttrDict
, where specific attributes have been defined.arbitrary_types_allowed
If a custom type is used for an attribute that doesn't have avalidate()
method, don't fail setting the attribute.
Source code in oteapi/models/genericconfig.py
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 |
|