跳转至

dsdl.types.generic

Bool

Bases: BaseField

A DSDL Field to validate and return a boolean value.

Examples:

>>> bool_field = Bool()
>>> value = True
>>> bool_field.validate(value)
True
Source code in /Users/bin/anaconda3/envs/dsdl/lib/python3.10/site-packages/dsdl/fields/generic.py 
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
class Bool(BaseField):
    """A DSDL Field to validate and return a boolean value.

    Examples:
        >>> bool_field = Bool()
        >>> value = True
        >>> bool_field.validate(value)
        True
    """
    data_schema = {
        "$id": "/generic/boolean",
        "title": "BoolField",
        "description": "Bool field in dsdl.",
        "oneOf": [
            {"type": "boolean"},
            {"type": "number", "enum": [0, 1]}
        ]
    }
    geometry_class = bool

Dict

Bases: BaseField

A DSDL Field to validate and return a dict value.

Examples:

>>> dic_field = Dict()
>>> value = {"1": "a"}
>>> dic_field.validate(value)
{"1": "a"}
Source code in /Users/bin/anaconda3/envs/dsdl/lib/python3.10/site-packages/dsdl/fields/generic.py 
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
class Dict(BaseField):
    """A DSDL Field to validate and return a dict value.

    Examples:
        >>> dic_field = Dict()
        >>> value = {"1": "a"}
        >>> dic_field.validate(value)
        {"1": "a"}
    """
    data_schema = {
        "$id": "/generic/dict",
        "title": "DictField",
        "description": "Dict field in dsdl.",
        "type": "object",
    }

Int

Bases: BaseField

A DSDL Field to validate and return an int value.

Examples:

>>> int_field = Int()
>>> value = 1.0
>>> int_field.validate(value)
1
Source code in /Users/bin/anaconda3/envs/dsdl/lib/python3.10/site-packages/dsdl/fields/generic.py 
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
class Int(BaseField):
    """A DSDL Field to validate and return an int value.

    Examples:
        >>> int_field = Int()
        >>> value = 1.0
        >>> int_field.validate(value)
        1
    """
    data_schema = {
        "$id": "/generic/int",
        "title": "IntField",
        "description": "Int field in dsdl.",
        "type": "integer",
    }

Num

Bases: BaseField

A DSDL Field to validate and return a float value.

Examples:

>>> float_field = Num()
>>> value = 1
>>> float_field.validate(value)
1.0
Source code in /Users/bin/anaconda3/envs/dsdl/lib/python3.10/site-packages/dsdl/fields/generic.py 
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
class Num(BaseField):
    """A DSDL Field to validate and return a float value.

    Examples:
        >>> float_field = Num()
        >>> value = 1
        >>> float_field.validate(value)
        1.0
    """
    data_schema = {
        "$id": "/generic/num",
        "title": "NumField",
        "description": "Num field in dsdl.",
        "type": "number",
    }

Str

Bases: BaseField

A DSDL Field to validate and return a str value.

Examples:

>>> str_field = Str()
>>> value = "test"
>>> str_field.validate(value)
"test"
Source code in /Users/bin/anaconda3/envs/dsdl/lib/python3.10/site-packages/dsdl/fields/generic.py 
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
class Str(BaseField):
    """A DSDL Field to validate and return a str value.

    Examples:
        >>> str_field = Str()
        >>> value = "test"
        >>> str_field.validate(value)
        "test"
    """
    data_schema = {
        "$id": "/generic/str",
        "title": "StrField",
        "description": "Str field in dsdl.",
        "type": "string",
    }