Skip to content

typing

xsdata.formats.dataclass.typing

evaluate(tp, globalns, localns=None)

Analyze/Validate the typing annotation.

Source code in xsdata/formats/dataclass/typing.py
46
47
48
49
50
51
52
53
54
55
56
57
58
59
def evaluate(tp: Any, globalns: Any, localns: Any = None) -> Any:
    """Analyze/Validate the typing annotation."""
    result = _eval_type(tp, globalns, localns)

    # Ugly hack for the Type["str"]
    # Let's switch to ForwardRef("str")
    if get_origin(result) is type:
        args = get_args(result)
        if len(args) != 1:
            raise TypeError

        return args[0]

    return result

analyze_token_args(origin, args)

Analyze token arguments.

Ensure it only has one argument, filter out ellipsis.

Args origin: The annotation origin args: The annotation arguments

Returns:

Type Description
Tuple[Any]

A tuple that contains only one arg

Raises:

Type Description
TypeError

If the origin is not list or tuple, and it has more than one argument

Source code in xsdata/formats/dataclass/typing.py
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
def analyze_token_args(origin: Any, args: Tuple[Any, ...]) -> Tuple[Any]:
    """Analyze token arguments.

    Ensure it only has one argument, filter out ellipsis.

    Args
        origin: The annotation origin
        args: The annotation arguments

    Returns:
        A tuple that contains only one arg

    Raises:
        TypeError: If the origin is not list or tuple,
            and it has more than one argument

    """
    if origin in ITERABLE_TYPES:
        args = filter_ellipsis(args)
        if len(args) == 1:
            return args

    raise TypeError

evaluate_text(annotation, tokens=False)

Run exactly the same validations with attribute.

Source code in xsdata/formats/dataclass/typing.py
101
102
103
def evaluate_text(annotation: Any, tokens: bool = False) -> Result:
    """Run exactly the same validations with attribute."""
    return evaluate_attribute(annotation, tokens)

evaluate_attribute(annotation, tokens=False)

Validate annotations for a xml attribute.

Source code in xsdata/formats/dataclass/typing.py
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
def evaluate_attribute(annotation: Any, tokens: bool = False) -> Result:
    """Validate annotations for a xml attribute."""
    origin = get_origin(annotation)
    args = get_args(annotation)
    tokens_factory = None

    if tokens:
        args = analyze_token_args(origin, args)
        tokens_factory = origin
        origin = get_origin(args[0])

        if origin in UNION_TYPES:
            args = get_args(args[0])
        elif origin:
            raise TypeError

    if origin in UNION_TYPES:
        types = filter_none_type(args)
    elif origin is None:
        types = args or (annotation,)
    else:
        raise TypeError

    if any(get_origin(tp) for tp in types):
        raise TypeError

    return Result(types=types, tokens_factory=tokens_factory)

evaluate_attributes(annotation, **_)

Validate annotations for xml wildcard attributes.

Source code in xsdata/formats/dataclass/typing.py
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
def evaluate_attributes(annotation: Any, **_: Any) -> Result:
    """Validate annotations for xml wildcard attributes."""
    if annotation is dict:
        args = ()
    else:
        origin = get_origin(annotation)
        args = get_args(annotation)

        if origin is not dict and annotation is not dict:
            raise TypeError

    if args and not all(arg is str for arg in args):
        raise TypeError

    return Result(types=(str,), factory=dict)

evaluate_element(annotation, tokens=False)

Validate annotations for a xml element.

Source code in xsdata/formats/dataclass/typing.py
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
def evaluate_element(annotation: Any, tokens: bool = False) -> Result:
    """Validate annotations for a xml element."""
    types = (annotation,)
    origin = get_origin(annotation)
    args = get_args(annotation)
    tokens_factory = factory = None

    if tokens:
        args = analyze_token_args(origin, args)

        tokens_factory = origin
        origin = get_origin(args[0])
        types = args
        args = get_args(args[0])

    if origin in ITERABLE_TYPES:
        args = tuple(arg for arg in args if arg is not Ellipsis)
        if len(args) != 1:
            raise TypeError

        if tokens_factory:
            factory = tokens_factory
            tokens_factory = origin
        else:
            factory = origin

        types = args
        origin = get_origin(args[0])
        args = get_args(args[0])

    if origin in UNION_TYPES:
        types = filter_none_type(args)
    elif origin:
        raise TypeError

    return Result(types=types, factory=factory, tokens_factory=tokens_factory)

evaluate_elements(annotation, **_)

Validate annotations for a xml compound field.

Source code in xsdata/formats/dataclass/typing.py
190
191
192
193
194
195
196
197
198
199
200
201
def evaluate_elements(annotation: Any, **_: Any) -> Result:
    """Validate annotations for a xml compound field."""
    (
        types,
        factory,
        __,
    ) = evaluate_element(annotation, tokens=False)

    for tp in types:
        evaluate_element(tp, tokens=False)

    return Result(types=(object,), factory=factory)

evaluate_wildcard(annotation, **_)

Validate annotations for a xml wildcard.

Source code in xsdata/formats/dataclass/typing.py
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
def evaluate_wildcard(annotation: Any, **_: Any) -> Result:
    """Validate annotations for a xml wildcard."""
    origin = get_origin(annotation)
    factory = None

    if origin in UNION_TYPES:
        types = filter_none_type(get_args(annotation))
    elif origin in ITERABLE_TYPES:
        factory = origin
        types = filter_ellipsis(get_args(annotation))
    elif origin is None:
        types = (annotation,)
    else:
        raise TypeError

    if len(types) != 1 or object not in types:
        raise TypeError

    return Result(types=types, factory=factory)