Simple fields¶
Fields for basic data types.
-
class
yadm.fields.simple.
BooleanField
(default=<class 'yadm.markers.AttributeNotSet'>, *, choices=None, **kwargs)¶ Field for boolean values.
-
get_fake
(document, faker, depth)¶ Return fake data for testing.
-
type
¶ alias of
builtins.bool
-
-
class
yadm.fields.simple.
FloatField
(default=<class 'yadm.markers.AttributeNotSet'>, *, choices=None, **kwargs)¶ Field for float.
-
get_fake
(document, faker, depth)¶ Return fake data for testing.
-
type
¶ alias of
builtins.float
-
-
class
yadm.fields.simple.
IntegerField
(default=<class 'yadm.markers.AttributeNotSet'>, *, choices=None, **kwargs)¶ Field for integer.
-
get_fake
(document, faker, depth)¶ Return fake data for testing.
-
type
¶ alias of
builtins.int
-
-
class
yadm.fields.simple.
ObjectIdField
(default_gen=False)¶ Field for ObjectId.
Parameters: default_gen (bool) – generate default value if not set -
copy
()¶ Return copy of field.
-
get_default
(document)¶ Return default value.
-
get_fake
(document, faker, depth)¶ Return fake data for testing.
-
type
¶ alias of
bson.objectid.ObjectId
-
-
class
yadm.fields.simple.
SimpleField
(default=<class 'yadm.markers.AttributeNotSet'>, *, choices=None, **kwargs)¶ Base field for simple types.
Parameters: - default – default value
- choices (set) – set of possible values
-
from_mongo
(document, value)¶ Convert mongo value to python value.
Parameters: - document (BaseDocument) – document
- value – mongo value
Returns: python value
-
get_fake
(document, faker, depth)¶ Return fake data for testing.
-
prepare_value
(document, value)¶ The method is called when value is assigned for the attribute.
Parameters: - document (BaseDocument) – document
- value – raw value
Returns: prepared value
It must be accept value argument and return processed (e.g. casted) analog. Also it is called once for the default value.
-
class
yadm.fields.simple.
StaticField
(data)¶ Field for static data.
-
copy
()¶ Return copy of field.
-
from_mongo
(document, value)¶ Convert mongo value to python value.
Parameters: - document (BaseDocument) – document
- value – mongo value
Returns: python value
-
get_default
(document)¶ Return default value.
-
get_fake
(document, faker, depth)¶ Return fake data for testing.
-
get_if_attribute_not_set
(document)¶ Call if key not exist in document.
-
prepare_value
(document, value)¶ The method is called when value is assigned for the attribute.
Parameters: - document (BaseDocument) – document
- value – raw value
Returns: prepared value
It must be accept value argument and return processed (e.g. casted) analog. Also it is called once for the default value.
-
to_mongo
(document, value)¶ Convert python value to mongo value.
Parameters: - document (BaseDocument) – document
- value – python value
Returns: mongo value
-