Skip to content

pane.converters

pane.converters

Converter types, which do the hard work of recursive validation.

NestedSequence = t.Union[T, t.Sequence['NestedSequence[T]']] module-attribute

DatetimeT = t.TypeVar('DatetimeT', bound=t.Union[datetime.datetime, datetime.date, datetime.time]) module-attribute

Converter

Bases: ABC, Generic[T_co]

Base class for a converter to a given type T_co.

Source code in pane/converters.py 
 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
class Converter(abc.ABC, t.Generic[T_co]):
    """
    Base class for a converter to a given type ``T_co``.
    """

    def convert(self, val: t.Any) -> T_co:
        """Convert ``val`` to ``T_co``. Raises a ``ConvertError`` on failure."""
        try:
            return self.try_convert(val)
        except ParseInterrupt:
            pass
        node = self.collect_errors(val)
        if node is None:
            raise RuntimeError("convert() raised but ``collect_errors`` returned ``None``."
                               " This is a bug of the ``Converter`` implementation.")
        raise ConvertError(node)

    def into_data(self, val: t.Any) -> DataType:
        """
        Convert ``val`` into a data interchange format.

        ``val`` *should* be of a type returned by this converter,
        but don't count on it.
        """
        return into_data(val, None)

    into_data._original = True  # type: ignore

    @abc.abstractmethod
    def expected(self, plural: bool = False) -> str:
        """
        Return a descriptive string indicating the value(s) expected.

        Parameters:
          plural: Whether to pluralize the descriptive string
        """
        ...

    @abc.abstractmethod
    def try_convert(self, val: t.Any) -> T_co:
        """
        Attempt to convert ``val`` to ``T``.
        Should raise ``ParseInterrupt`` (and only ``ParseInterrupt``)
        when a given parsing path reaches a dead end.
        """
        ...

    @abc.abstractmethod
    def collect_errors(self, val: t.Any) -> t.Optional[ErrorNode]:
        """
        Return an error tree caused by converting ``val`` to ``T``.
        ``collect_errors`` should return ``None`` iff ``convert`` doesn't raise.
        """
        ...

convert(val)

Convert val to T_co. Raises a ConvertError on failure.

Source code in pane/converters.py 
55
56
57
58
59
60
61
62
63
64
65
def convert(self, val: t.Any) -> T_co:
    """Convert ``val`` to ``T_co``. Raises a ``ConvertError`` on failure."""
    try:
        return self.try_convert(val)
    except ParseInterrupt:
        pass
    node = self.collect_errors(val)
    if node is None:
        raise RuntimeError("convert() raised but ``collect_errors`` returned ``None``."
                           " This is a bug of the ``Converter`` implementation.")
    raise ConvertError(node)

into_data(val)

Convert val into a data interchange format.

val should be of a type returned by this converter, but don't count on it.

Source code in pane/converters.py 
67
68
69
70
71
72
73
74
def into_data(self, val: t.Any) -> DataType:
    """
    Convert ``val`` into a data interchange format.

    ``val`` *should* be of a type returned by this converter,
    but don't count on it.
    """
    return into_data(val, None)

expected(plural=False) abstractmethod

Return a descriptive string indicating the value(s) expected.

Parameters:

Name Type Description Default
plural bool

Whether to pluralize the descriptive string

 False
Source code in pane/converters.py 
78
79
80
81
82
83
84
85
86
@abc.abstractmethod
def expected(self, plural: bool = False) -> str:
    """
    Return a descriptive string indicating the value(s) expected.

    Parameters:
      plural: Whether to pluralize the descriptive string
    """
    ...

try_convert(val) abstractmethod

Attempt to convert val to T. Should raise ParseInterrupt (and only ParseInterrupt) when a given parsing path reaches a dead end.

Source code in pane/converters.py 
88
89
90
91
92
93
94
95
@abc.abstractmethod
def try_convert(self, val: t.Any) -> T_co:
    """
    Attempt to convert ``val`` to ``T``.
    Should raise ``ParseInterrupt`` (and only ``ParseInterrupt``)
    when a given parsing path reaches a dead end.
    """
    ...

collect_errors(val) abstractmethod

Return an error tree caused by converting val to T. collect_errors should return None iff convert doesn't raise.

Source code in pane/converters.py 
 97
 98
 99
100
101
102
103
@abc.abstractmethod
def collect_errors(self, val: t.Any) -> t.Optional[ErrorNode]:
    """
    Return an error tree caused by converting ``val`` to ``T``.
    ``collect_errors`` should return ``None`` iff ``convert`` doesn't raise.
    """
    ...

AnyConverter dataclass

Bases: Converter[Any]

Converter for t.Any.

Source code in pane/converters.py 
106
107
108
109
110
111
112
113
114
115
116
117
118
119
@dataclasses.dataclass
class AnyConverter(Converter[t.Any]):
    """Converter for ``t.Any``."""
    def try_convert(self, val: t.Any) -> t.Any:
        """See [`Converter.try_convert`][pane.converters.Converter.try_convert]"""
        return val

    def expected(self, plural: bool = False) -> str:
        """See [`Converter.expected`][pane.converters.Converter.expected]"""
        return pluralize("any value", plural)

    def collect_errors(self, val: t.Any) -> None:
        """See [`Converter.collect_errors`][pane.converters.Converter.collect_errors]"""
        return None

convert(val)

Convert val to T_co. Raises a ConvertError on failure.

Source code in pane/converters.py 
55
56
57
58
59
60
61
62
63
64
65
def convert(self, val: t.Any) -> T_co:
    """Convert ``val`` to ``T_co``. Raises a ``ConvertError`` on failure."""
    try:
        return self.try_convert(val)
    except ParseInterrupt:
        pass
    node = self.collect_errors(val)
    if node is None:
        raise RuntimeError("convert() raised but ``collect_errors`` returned ``None``."
                           " This is a bug of the ``Converter`` implementation.")
    raise ConvertError(node)

into_data(val)

Convert val into a data interchange format.

val should be of a type returned by this converter, but don't count on it.

Source code in pane/converters.py 
67
68
69
70
71
72
73
74
def into_data(self, val: t.Any) -> DataType:
    """
    Convert ``val`` into a data interchange format.

    ``val`` *should* be of a type returned by this converter,
    but don't count on it.
    """
    return into_data(val, None)

try_convert(val)

See Converter.try_convert

Source code in pane/converters.py 
109
110
111
def try_convert(self, val: t.Any) -> t.Any:
    """See [`Converter.try_convert`][pane.converters.Converter.try_convert]"""
    return val

expected(plural=False)

See Converter.expected

Source code in pane/converters.py 
113
114
115
def expected(self, plural: bool = False) -> str:
    """See [`Converter.expected`][pane.converters.Converter.expected]"""
    return pluralize("any value", plural)

collect_errors(val)

See Converter.collect_errors

Source code in pane/converters.py 
117
118
119
def collect_errors(self, val: t.Any) -> None:
    """See [`Converter.collect_errors`][pane.converters.Converter.collect_errors]"""
    return None

ScalarConverter dataclass

Bases: Converter[T]

Converter for a simple scalar type, constructible from a list of allowed types.

Source code in pane/converters.py 
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
@dataclasses.dataclass
class ScalarConverter(Converter[T]):
    """
    Converter for a simple scalar type,
    constructible from a list of allowed types.
    """

    # TODO this needs to handle into_data better
    ty: t.Type[T]
    """Type to convert into."""
    allowed: t.Union[type, t.Tuple[type, ...]]
    """Type or list of allowed types."""
    expect: t.Optional[str] = None
    """Singular form of expected value."""
    expect_plural: t.Optional[str] = None
    """Plural form of expected value."""
    _into_data_f: t.Callable[[T], DataType] = lambda v: v  # type: ignore

    def __post_init__(self):
        self.expect = self.expect or self.ty.__name__
        self.expect_plural = self.expect_plural or self.expect

    def into_data(self, val: t.Any) -> DataType:
        return self._into_data_f(val)

    def expected(self, plural: bool = False) -> str:
        """See [`Converter.expected`][pane.converters.Converter.expected]"""
        return t.cast(str, self.expect_plural if plural else self.expect)

    def try_convert(self, val: t.Any) -> T:
        """See [`Converter.try_convert`][pane.converters.Converter.try_convert]"""
        if isinstance(val, self.allowed):
            try:
                return self.ty(val)  # type: ignore
            except Exception:
                raise ParseInterrupt()
        raise ParseInterrupt()

    def collect_errors(self, val: t.Any) -> t.Optional[WrongTypeError]:
        """See [`Converter.collect_errors`][pane.converters.Converter.collect_errors]"""
        if isinstance(val, self.allowed):
            try:
                self.ty(val)  # type: ignore
                return None
            except Exception as e:
                tb = e.__traceback__.tb_next  # type: ignore
                tb = traceback.TracebackException(type(e), e, tb)
                return WrongTypeError(self.expected(), val, tb)
        return WrongTypeError(f'{self.expected()}', val)

ty instance-attribute

Type to convert into.

allowed instance-attribute

Type or list of allowed types.

expect = None class-attribute instance-attribute

Singular form of expected value.

expect_plural = None class-attribute instance-attribute

Plural form of expected value.

convert(val)

Convert val to T_co. Raises a ConvertError on failure.

Source code in pane/converters.py 
55
56
57
58
59
60
61
62
63
64
65
def convert(self, val: t.Any) -> T_co:
    """Convert ``val`` to ``T_co``. Raises a ``ConvertError`` on failure."""
    try:
        return self.try_convert(val)
    except ParseInterrupt:
        pass
    node = self.collect_errors(val)
    if node is None:
        raise RuntimeError("convert() raised but ``collect_errors`` returned ``None``."
                           " This is a bug of the ``Converter`` implementation.")
    raise ConvertError(node)

into_data(val)

Source code in pane/converters.py 
144
145
def into_data(self, val: t.Any) -> DataType:
    return self._into_data_f(val)

expected(plural=False)

See Converter.expected

Source code in pane/converters.py 
147
148
149
def expected(self, plural: bool = False) -> str:
    """See [`Converter.expected`][pane.converters.Converter.expected]"""
    return t.cast(str, self.expect_plural if plural else self.expect)

try_convert(val)

See Converter.try_convert

Source code in pane/converters.py 
151
152
153
154
155
156
157
158
def try_convert(self, val: t.Any) -> T:
    """See [`Converter.try_convert`][pane.converters.Converter.try_convert]"""
    if isinstance(val, self.allowed):
        try:
            return self.ty(val)  # type: ignore
        except Exception:
            raise ParseInterrupt()
    raise ParseInterrupt()

collect_errors(val)

See Converter.collect_errors

Source code in pane/converters.py 
160
161
162
163
164
165
166
167
168
169
170
def collect_errors(self, val: t.Any) -> t.Optional[WrongTypeError]:
    """See [`Converter.collect_errors`][pane.converters.Converter.collect_errors]"""
    if isinstance(val, self.allowed):
        try:
            self.ty(val)  # type: ignore
            return None
        except Exception as e:
            tb = e.__traceback__.tb_next  # type: ignore
            tb = traceback.TracebackException(type(e), e, tb)
            return WrongTypeError(self.expected(), val, tb)
    return WrongTypeError(f'{self.expected()}', val)

NoneConverter dataclass

Bases: Converter[None]

Converter which accepts only None.

Source code in pane/converters.py 
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
@dataclasses.dataclass
class NoneConverter(Converter[None]):
    """
    Converter which accepts only ``None``.
    """

    def try_convert(self, val: t.Any) -> None:
        """See [`Converter.try_convert`][pane.converters.Converter.try_convert]"""
        if val is None:
            return val
        raise ParseInterrupt()

    def expected(self, plural: bool = False) -> str:
        """See [`Converter.expected`][pane.converters.Converter.expected]"""
        return pluralize("null value", plural)

    def collect_errors(self, val: t.Any) -> t.Optional[WrongTypeError]:
        """See [`Converter.collect_errors`][pane.converters.Converter.collect_errors]"""
        if val is None:
            return None
        return WrongTypeError(self.expected(), val)

convert(val)

Convert val to T_co. Raises a ConvertError on failure.

Source code in pane/converters.py 
55
56
57
58
59
60
61
62
63
64
65
def convert(self, val: t.Any) -> T_co:
    """Convert ``val`` to ``T_co``. Raises a ``ConvertError`` on failure."""
    try:
        return self.try_convert(val)
    except ParseInterrupt:
        pass
    node = self.collect_errors(val)
    if node is None:
        raise RuntimeError("convert() raised but ``collect_errors`` returned ``None``."
                           " This is a bug of the ``Converter`` implementation.")
    raise ConvertError(node)

into_data(val)

Convert val into a data interchange format.

val should be of a type returned by this converter, but don't count on it.

Source code in pane/converters.py 
67
68
69
70
71
72
73
74
def into_data(self, val: t.Any) -> DataType:
    """
    Convert ``val`` into a data interchange format.

    ``val`` *should* be of a type returned by this converter,
    but don't count on it.
    """
    return into_data(val, None)

try_convert(val)

See Converter.try_convert

Source code in pane/converters.py 
179
180
181
182
183
def try_convert(self, val: t.Any) -> None:
    """See [`Converter.try_convert`][pane.converters.Converter.try_convert]"""
    if val is None:
        return val
    raise ParseInterrupt()

expected(plural=False)

See Converter.expected

Source code in pane/converters.py 
185
186
187
def expected(self, plural: bool = False) -> str:
    """See [`Converter.expected`][pane.converters.Converter.expected]"""
    return pluralize("null value", plural)

collect_errors(val)

See Converter.collect_errors

Source code in pane/converters.py 
189
190
191
192
193
def collect_errors(self, val: t.Any) -> t.Optional[WrongTypeError]:
    """See [`Converter.collect_errors`][pane.converters.Converter.collect_errors]"""
    if val is None:
        return None
    return WrongTypeError(self.expected(), val)

LiteralConverter dataclass

Bases: Converter[T_co]

Converter which accepts any of a list of literal values.

Source code in pane/converters.py 
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
@dataclasses.dataclass
class LiteralConverter(Converter[T_co]):
    """
    Converter which accepts any of a list of literal values.
    """

    vals: t.Sequence[T_co]

    def try_convert(self, val: t.Any) -> T_co:
        """See [`Converter.try_convert`][pane.converters.Converter.try_convert]"""
        if val in self.vals:
            return val
        raise ParseInterrupt()

    def expected(self, plural: bool = False) -> str:
        """See [`Converter.expected`][pane.converters.Converter.expected]"""
        lits = list_phrase(tuple(map(repr, self.vals)))
        return f"({lits})" if plural else lits

    def collect_errors(self, val: t.Any) -> t.Optional[WrongTypeError]:
        """See [`Converter.collect_errors`][pane.converters.Converter.collect_errors]"""
        if val in self.vals:
            return None
        return WrongTypeError(self.expected(), val)

vals instance-attribute

convert(val)

Convert val to T_co. Raises a ConvertError on failure.

Source code in pane/converters.py 
55
56
57
58
59
60
61
62
63
64
65
def convert(self, val: t.Any) -> T_co:
    """Convert ``val`` to ``T_co``. Raises a ``ConvertError`` on failure."""
    try:
        return self.try_convert(val)
    except ParseInterrupt:
        pass
    node = self.collect_errors(val)
    if node is None:
        raise RuntimeError("convert() raised but ``collect_errors`` returned ``None``."
                           " This is a bug of the ``Converter`` implementation.")
    raise ConvertError(node)

into_data(val)

Convert val into a data interchange format.

val should be of a type returned by this converter, but don't count on it.

Source code in pane/converters.py 
67
68
69
70
71
72
73
74
def into_data(self, val: t.Any) -> DataType:
    """
    Convert ``val`` into a data interchange format.

    ``val`` *should* be of a type returned by this converter,
    but don't count on it.
    """
    return into_data(val, None)

try_convert(val)

See Converter.try_convert

Source code in pane/converters.py 
204
205
206
207
208
def try_convert(self, val: t.Any) -> T_co:
    """See [`Converter.try_convert`][pane.converters.Converter.try_convert]"""
    if val in self.vals:
        return val
    raise ParseInterrupt()

expected(plural=False)

See Converter.expected

Source code in pane/converters.py 
210
211
212
213
def expected(self, plural: bool = False) -> str:
    """See [`Converter.expected`][pane.converters.Converter.expected]"""
    lits = list_phrase(tuple(map(repr, self.vals)))
    return f"({lits})" if plural else lits

collect_errors(val)

See Converter.collect_errors

Source code in pane/converters.py 
215
216
217
218
219
def collect_errors(self, val: t.Any) -> t.Optional[WrongTypeError]:
    """See [`Converter.collect_errors`][pane.converters.Converter.collect_errors]"""
    if val in self.vals:
        return None
    return WrongTypeError(self.expected(), val)

UnionConverter dataclass

Bases: Converter[Any]

Converter for an untagged union of subtypes. Unions are always evaluated left-to-right.

Source code in pane/converters.py 
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
@dataclasses.dataclass(init=False)
class UnionConverter(Converter[t.Any]):
    """
    Converter for an untagged union of subtypes.
    Unions are always evaluated left-to-right.
    """
    types: t.Tuple[IntoConverter, ...]
    """List of potential types"""
    converters: t.Tuple[Converter[t.Any], ...]
    """List of type converters"""
    constructor: t.Optional[t.Callable[[t.Any, int], t.Any]]
    """
    Constructor to call with parsed value.
    Called with ``(val, index of type in union)``
    """

    def __init__(self, types: t.Sequence[IntoConverter], *,
                 handlers: ConverterHandlers = ConverterHandlers(),
                 constructor: t.Optional[t.Callable[[t.Any, int], t.Any]] = None):
        self.types = tuple(flatten_union_args(types))
        self.converters = tuple(make_converter(ty, handlers) for ty in types)
        self.constructor = constructor

    def expected(self, plural: bool = False) -> str:
        """See [`Converter.expected`][pane.converters.Converter.expected]"""
        return list_phrase(tuple(conv.expected(plural) for conv in self.converters))

    def into_data(self, val: t.Any) -> DataType:
        """See [`Converter.into_data`][pane.converters.Converter.into_data]"""
        # this is tricky, because we have no type information about which variant ``val`` is.
        # so we basically try_convert each until we find a match
        # this works because try_convert should be idempotent
        for conv in self.converters:
            try:
                conv.try_convert(val)
            except ParseInterrupt:
                pass
            else:
                return conv.into_data(val)
        # default to regular conversion
        return into_data(val)

    def construct(self, val: t.Any, i: int) -> t.Any:
        if self.constructor is None:
            return val
        return self.constructor(val, i)

    def try_convert(self, val: t.Any) -> t.Any:
        """See [`Converter.try_convert`][pane.converters.Converter.try_convert]"""
        for (i, conv) in enumerate(self.converters):
            try:
                val = conv.try_convert(val)
                try:
                    return self.construct(val, i)
                except Exception:
                    pass
            except ParseInterrupt:
                pass
        raise ParseInterrupt

    def collect_errors(self, val: t.Any) -> t.Optional[ErrorNode]:
        """See [`Converter.collect_errors`][pane.converters.Converter.collect_errors]"""
        failed_children: t.List[ErrorNode] = []
        for (i, conv) in enumerate(self.converters):
            # if one branch is successful, the whole type is successful
            try:
                conv_val = conv.try_convert(val)
            except ParseInterrupt:
                failed_children.append(t.cast(t.Union[ProductErrorNode, WrongTypeError], conv.collect_errors(val)))
                continue
            try:
                self.construct(conv_val, i)
                return None
            except Exception as e:
                tb = e.__traceback__.tb_next  # type: ignore
                tb = traceback.TracebackException(type(e), e, tb)
                failed_children.append(WrongTypeError(self.expected(), val, tb))
        return SumErrorNode(failed_children)

types = tuple(flatten_union_args(types)) instance-attribute

List of potential types

converters = tuple(make_converter(ty, handlers) for ty in types) instance-attribute

List of type converters

constructor = constructor instance-attribute

Constructor to call with parsed value. Called with (val, index of type in union)

convert(val)

Convert val to T_co. Raises a ConvertError on failure.

Source code in pane/converters.py 
55
56
57
58
59
60
61
62
63
64
65
def convert(self, val: t.Any) -> T_co:
    """Convert ``val`` to ``T_co``. Raises a ``ConvertError`` on failure."""
    try:
        return self.try_convert(val)
    except ParseInterrupt:
        pass
    node = self.collect_errors(val)
    if node is None:
        raise RuntimeError("convert() raised but ``collect_errors`` returned ``None``."
                           " This is a bug of the ``Converter`` implementation.")
    raise ConvertError(node)

expected(plural=False)

See Converter.expected

Source code in pane/converters.py 
245
246
247
def expected(self, plural: bool = False) -> str:
    """See [`Converter.expected`][pane.converters.Converter.expected]"""
    return list_phrase(tuple(conv.expected(plural) for conv in self.converters))

into_data(val)

See Converter.into_data

Source code in pane/converters.py 
249
250
251
252
253
254
255
256
257
258
259
260
261
262
def into_data(self, val: t.Any) -> DataType:
    """See [`Converter.into_data`][pane.converters.Converter.into_data]"""
    # this is tricky, because we have no type information about which variant ``val`` is.
    # so we basically try_convert each until we find a match
    # this works because try_convert should be idempotent
    for conv in self.converters:
        try:
            conv.try_convert(val)
        except ParseInterrupt:
            pass
        else:
            return conv.into_data(val)
    # default to regular conversion
    return into_data(val)

construct(val, i)

Source code in pane/converters.py 
264
265
266
267
def construct(self, val: t.Any, i: int) -> t.Any:
    if self.constructor is None:
        return val
    return self.constructor(val, i)

try_convert(val)

See Converter.try_convert

Source code in pane/converters.py 
269
270
271
272
273
274
275
276
277
278
279
280
def try_convert(self, val: t.Any) -> t.Any:
    """See [`Converter.try_convert`][pane.converters.Converter.try_convert]"""
    for (i, conv) in enumerate(self.converters):
        try:
            val = conv.try_convert(val)
            try:
                return self.construct(val, i)
            except Exception:
                pass
        except ParseInterrupt:
            pass
    raise ParseInterrupt

collect_errors(val)

See Converter.collect_errors

Source code in pane/converters.py 
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
def collect_errors(self, val: t.Any) -> t.Optional[ErrorNode]:
    """See [`Converter.collect_errors`][pane.converters.Converter.collect_errors]"""
    failed_children: t.List[ErrorNode] = []
    for (i, conv) in enumerate(self.converters):
        # if one branch is successful, the whole type is successful
        try:
            conv_val = conv.try_convert(val)
        except ParseInterrupt:
            failed_children.append(t.cast(t.Union[ProductErrorNode, WrongTypeError], conv.collect_errors(val)))
            continue
        try:
            self.construct(conv_val, i)
            return None
        except Exception as e:
            tb = e.__traceback__.tb_next  # type: ignore
            tb = traceback.TracebackException(type(e), e, tb)
            failed_children.append(WrongTypeError(self.expected(), val, tb))
    return SumErrorNode(failed_children)

TaggedUnionConverter dataclass

Bases: UnionConverter

Converter for a tagged union of subtypes.

Tagged unions may be parsed in three ways. The default is an 'internally tagged' union, where the tag is found by looking for a given key in the given object. This is the default. An 'externally tagged' union is stored as a dict with a key and a single value {tag: content}. This may be specified using external=True. Finally, a 'adjacently tagged' union may be specified using two keys external=(t, c). The union is stored as {t: tag, c: content}

Source code in pane/converters.py 
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
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
@dataclasses.dataclass(init=False)
class TaggedUnionConverter(UnionConverter):
    """
    Converter for a tagged union of subtypes.

    Tagged unions may be parsed in three ways. The default
    is an 'internally tagged' union, where the tag is found
    by looking for a given key in the given object. This is the
    default.
    An 'externally tagged' union is stored as a dict with a key
    and a single value ``{tag: content}``. This may be specified
    using ``external=True``.
    Finally, a 'adjacently tagged' union may be specified using
    two keys ``external=(t, c)``. The union is stored as
    ``{t: tag, c: content}``
    """
    tag: str
    tag_map: t.Dict[t.Any, int]
    """Map from tags to indices into self.types/self.converters"""
    external: t.Union[bool, t.Tuple[str, str]] = False
    """
    Tagged union representation.
    False: internal representation
    True: external representation
    (t, c): adjacent representation
    """

    def __init__(self, types: t.Sequence[t.Any], tag: str,
                 external: t.Union[bool, t.Tuple[str, str]] = False, *,
                 handlers: ConverterHandlers = ConverterHandlers()):
        super().__init__(types, handlers=handlers)
        self.tag = tag
        self.external = external if isinstance(external, t.Sequence) else bool(external)

        # look for tag in each of self.types
        self.tag_map = {}
        for (i, ty) in enumerate(self.types):
            try:
                # TODO error if used on non-literal
                val = getattr(ty, self.tag)
                if val in self.tag_map:
                    raise TypeError(f"Tag value '{val}' matches multiple types")
                self.tag_map[val] = i
            except AttributeError:
                raise AttributeError(f"Tag '{self.tag}' not found inside type '{ty}'")

    def tag_expected(self) -> str:
        """Return a string list of the expected/supported tags"""
        return list_phrase(tuple(map(repr, self.tag_map.keys())))

    def obj_expected(self, plural: bool = False) -> str:
        """Return a string list of the supported objects"""
        return list_phrase(tuple(conv.expected(plural) for conv in self.converters))

    def expected(self, plural: bool = False) -> str:
        """See [`Converter.expected`][pane.converters.Converter.expected]"""
        if self.external is False:
            # internally tagged
            return self.obj_expected(plural)
        obj = self.obj_expected(False)
        mapping = pluralize('mapping', plural, article='a')
        tag = list_phrase(tuple(map(repr, self.tag_map.keys())))
        if self.external is True:
            # externally tagged
            return f"{mapping} '{tag}' => {obj}"
        else:
            # adjacently tagged
            (t, c) = self.external 
            return f"{mapping} {repr(t)} => {tag}, {repr(c)} => {obj}"

    def into_data(self, val: t.Any) -> DataType:
        """See [`Converter.into_data`][pane.converters.Converter.into_data]"""
        tag = getattr(val, self.tag)
        inner_conv = self.converters[self.tag_map[tag]]
        if self.external is False:
            # internally tagged
            return inner_conv.into_data(val)
        if self.external is True:
            # externally tagged
            return {tag: inner_conv.into_data(val)}
        # adjacently tagged
        (t_r, c_r) = self.external
        return {t_r: tag, c_r: inner_conv.into_data(val)}

    def try_convert(self, val: t.Any) -> t.Any:
        """See [`Converter.try_convert`][pane.converters.Converter.try_convert]"""
        if not data_is_mapping(val):
            raise ParseInterrupt()
        val = t.cast(t.Dict[str, t.Any], val)
        tag: t.Any

        if self.external is False:
            try:
                # don't give 'tag' to variants
                val = val.copy()
                tag = val.pop(self.tag)
            except KeyError:
                raise ParseInterrupt()
        elif self.external is True:
            if len(val) != 1:
                raise ParseInterrupt()
            (tag, val) = next(iter(val.items()))
        else:
            (t_r, c_r) = self.external
            try:
                if len(val) != 2:
                    raise ParseInterrupt()
                tag, val = val[t_r], val[c_r]
            except KeyError:
                raise ParseInterrupt()
        try:
            i = self.tag_map[tag]
        except KeyError:
            raise ParseInterrupt()
        return self.converters[i].try_convert(val)

    def collect_errors(self, val: t.Any) -> t.Optional[ErrorNode]:
        """See [`Converter.collect_errors`][pane.converters.Converter.collect_errors]"""
        if not data_is_mapping(val):
            return WrongTypeError(self.expected(), val)
        val = t.cast(t.Dict[str, t.Any], val)
        tag: t.Any

        if self.external is False:
            try:
                # don't give 'tag' to variants
                val = val.copy()
                tag = val.pop(self.tag)
            except KeyError:
                return WrongTypeError(f"mapping with key '{self.tag}' => {self.tag_expected()}", val)
        elif self.external is True:
            if len(val) != 1:
                return WrongTypeError(self.expected(), val)
            (tag, val) = next(iter(val.items()))
        else:
            (t_r, c_r) = self.external
            try:
                if len(val) != 2:
                    raise KeyError()
                tag, val = val[t_r], val[c_r]
            except KeyError:
                return WrongTypeError(f"mapping with keys '{t_r}' and '{c_r}'", val)
        try:
            i = self.tag_map[tag]
        except KeyError:
            return WrongTypeError(f"tag '{self.tag}' one of {self.tag_expected()}", tag)
        return self.converters[i].collect_errors(val)

types = tuple(flatten_union_args(types)) instance-attribute

List of potential types

converters = tuple(make_converter(ty, handlers) for ty in types) instance-attribute

List of type converters

constructor = constructor instance-attribute

Constructor to call with parsed value. Called with (val, index of type in union)

tag = tag instance-attribute

external = external if isinstance(external, t.Sequence) else bool(external) class-attribute instance-attribute

Tagged union representation. False: internal representation True: external representation (t, c): adjacent representation

tag_map = {} instance-attribute

Map from tags to indices into self.types/self.converters

convert(val)

Convert val to T_co. Raises a ConvertError on failure.

Source code in pane/converters.py 
55
56
57
58
59
60
61
62
63
64
65
def convert(self, val: t.Any) -> T_co:
    """Convert ``val`` to ``T_co``. Raises a ``ConvertError`` on failure."""
    try:
        return self.try_convert(val)
    except ParseInterrupt:
        pass
    node = self.collect_errors(val)
    if node is None:
        raise RuntimeError("convert() raised but ``collect_errors`` returned ``None``."
                           " This is a bug of the ``Converter`` implementation.")
    raise ConvertError(node)

construct(val, i)

Source code in pane/converters.py 
264
265
266
267
def construct(self, val: t.Any, i: int) -> t.Any:
    if self.constructor is None:
        return val
    return self.constructor(val, i)

tag_expected()

Return a string list of the expected/supported tags

Source code in pane/converters.py 
348
349
350
def tag_expected(self) -> str:
    """Return a string list of the expected/supported tags"""
    return list_phrase(tuple(map(repr, self.tag_map.keys())))

obj_expected(plural=False)

Return a string list of the supported objects

Source code in pane/converters.py 
352
353
354
def obj_expected(self, plural: bool = False) -> str:
    """Return a string list of the supported objects"""
    return list_phrase(tuple(conv.expected(plural) for conv in self.converters))

expected(plural=False)

See Converter.expected

Source code in pane/converters.py 
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
def expected(self, plural: bool = False) -> str:
    """See [`Converter.expected`][pane.converters.Converter.expected]"""
    if self.external is False:
        # internally tagged
        return self.obj_expected(plural)
    obj = self.obj_expected(False)
    mapping = pluralize('mapping', plural, article='a')
    tag = list_phrase(tuple(map(repr, self.tag_map.keys())))
    if self.external is True:
        # externally tagged
        return f"{mapping} '{tag}' => {obj}"
    else:
        # adjacently tagged
        (t, c) = self.external 
        return f"{mapping} {repr(t)} => {tag}, {repr(c)} => {obj}"

into_data(val)

See Converter.into_data

Source code in pane/converters.py 
372
373
374
375
376
377
378
379
380
381
382
383
384
def into_data(self, val: t.Any) -> DataType:
    """See [`Converter.into_data`][pane.converters.Converter.into_data]"""
    tag = getattr(val, self.tag)
    inner_conv = self.converters[self.tag_map[tag]]
    if self.external is False:
        # internally tagged
        return inner_conv.into_data(val)
    if self.external is True:
        # externally tagged
        return {tag: inner_conv.into_data(val)}
    # adjacently tagged
    (t_r, c_r) = self.external
    return {t_r: tag, c_r: inner_conv.into_data(val)}

try_convert(val)

See Converter.try_convert

Source code in pane/converters.py 
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
def try_convert(self, val: t.Any) -> t.Any:
    """See [`Converter.try_convert`][pane.converters.Converter.try_convert]"""
    if not data_is_mapping(val):
        raise ParseInterrupt()
    val = t.cast(t.Dict[str, t.Any], val)
    tag: t.Any

    if self.external is False:
        try:
            # don't give 'tag' to variants
            val = val.copy()
            tag = val.pop(self.tag)
        except KeyError:
            raise ParseInterrupt()
    elif self.external is True:
        if len(val) != 1:
            raise ParseInterrupt()
        (tag, val) = next(iter(val.items()))
    else:
        (t_r, c_r) = self.external
        try:
            if len(val) != 2:
                raise ParseInterrupt()
            tag, val = val[t_r], val[c_r]
        except KeyError:
            raise ParseInterrupt()
    try:
        i = self.tag_map[tag]
    except KeyError:
        raise ParseInterrupt()
    return self.converters[i].try_convert(val)

collect_errors(val)

See Converter.collect_errors

Source code in pane/converters.py 
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
def collect_errors(self, val: t.Any) -> t.Optional[ErrorNode]:
    """See [`Converter.collect_errors`][pane.converters.Converter.collect_errors]"""
    if not data_is_mapping(val):
        return WrongTypeError(self.expected(), val)
    val = t.cast(t.Dict[str, t.Any], val)
    tag: t.Any

    if self.external is False:
        try:
            # don't give 'tag' to variants
            val = val.copy()
            tag = val.pop(self.tag)
        except KeyError:
            return WrongTypeError(f"mapping with key '{self.tag}' => {self.tag_expected()}", val)
    elif self.external is True:
        if len(val) != 1:
            return WrongTypeError(self.expected(), val)
        (tag, val) = next(iter(val.items()))
    else:
        (t_r, c_r) = self.external
        try:
            if len(val) != 2:
                raise KeyError()
            tag, val = val[t_r], val[c_r]
        except KeyError:
            return WrongTypeError(f"mapping with keys '{t_r}' and '{c_r}'", val)
    try:
        i = self.tag_map[tag]
    except KeyError:
        return WrongTypeError(f"tag '{self.tag}' one of {self.tag_expected()}", tag)
    return self.converters[i].collect_errors(val)

StructConverter dataclass

Bases: Converter[T]

Converter for a simple, hetereogeneous struct-like type, constructible from a dict.

Source code in pane/converters.py 
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
@dataclasses.dataclass
class StructConverter(Converter[T]):
    """
    Converter for a simple, hetereogeneous struct-like type, constructible from a dict.
    """

    ty: t.Type[T]
    """Type to convert into. Must be constructible from a dict/mapping."""
    fields: t.Mapping[str, IntoConverter]
    """List of fields and their types"""
    name: t.Optional[str] = None
    """Optional name of struct"""

    _: KW_ONLY = dataclasses.field(init=False, repr=False, compare=False)

    handlers: ConverterHandlers = ConverterHandlers()

    opt_fields: t.Set[str] = dataclasses.field(default_factory=set[str])
    """Set of fields which are optional"""
    field_converters: t.Dict[str, Converter[t.Any]] = dataclasses.field(init=False)
    """Dict of sub-converters for each field"""

    def __post_init__(self):
        self.field_converters = {k: make_converter(v, self.handlers) for (k, v) in self.fields.items()}

    def expected(self, plural: bool = False) -> str:
        """See [`Converter.expected`][pane.converters.Converter.expected]"""
        name = f" {self.name}" if self.name is not None else ""
        return f"{pluralize('struct', plural)}{name}"

    def into_data(self, val: t.Any) -> DataType:
        """See [`Converter.into_data`][pane.converters.Converter.into_data]"""
        assert data_is_mapping(val)
        d: t.Dict[DataType, DataType] = {}
        for (k, v) in t.cast(t.Mapping[str, t.Any], val).items():
            if (ty := self.fields.get(k)) is not None and ty not in (t.Any, type(t.Any)):
                if (conv := self.field_converters.get(k)) is not None:
                    d[k] = conv.into_data(v)
                    continue
            d[k] = make_converter(t.cast(t.Type[t.Any], type(v)), self.handlers).into_data(v)
        return d

    def try_convert(self, val: t.Any) -> T:
        """See [`Converter.try_convert`][pane.converters.Converter.try_convert]"""
        if not data_is_mapping(val):
            raise ParseInterrupt()
        val = t.cast(t.Dict[str, t.Any], val)
        d: t.Dict[str, t.Any] = {}
        for (k, v) in val.items():
            if k not in self.fields:
                raise ParseInterrupt()  # unknown field
            d[k] = self.field_converters[k].try_convert(v)
        missing = set(self.fields.keys()) - set(val.keys()) - self.opt_fields
        if len(missing):
            raise ParseInterrupt()
        return self.ty(d)  # type: ignore

    def collect_errors(self, val: t.Any) -> t.Union[WrongTypeError, ProductErrorNode, None]:
        """See [`Converter.collect_errors`][pane.converters.Converter.collect_errors]"""
        if not data_is_mapping(val):
            return WrongTypeError(self.expected(), val)
        val = t.cast(t.Dict[str, t.Any], val)

        children: t.Dict[t.Union[str, int], t.Any] = {}
        extra: t.Set[str] = set()
        for (k, v) in val.items():
            if k not in self.fields:
                extra.add(k)
                continue
            if (node := self.field_converters[k].collect_errors(v)) is not None:
                children[k] = node
        missing = set(self.fields.keys()) - set(val.keys()) - self.opt_fields
        if len(children) or len(missing) or len(extra):
            return ProductErrorNode(self.expected(), children, val, missing, extra)
        return None

ty instance-attribute

Type to convert into. Must be constructible from a dict/mapping.

fields instance-attribute

List of fields and their types

name = None class-attribute instance-attribute

Optional name of struct

handlers = ConverterHandlers() class-attribute instance-attribute

opt_fields = dataclasses.field(default_factory=set[str]) class-attribute instance-attribute

Set of fields which are optional

field_converters = dataclasses.field(init=False) class-attribute instance-attribute

Dict of sub-converters for each field

convert(val)

Convert val to T_co. Raises a ConvertError on failure.

Source code in pane/converters.py 
55
56
57
58
59
60
61
62
63
64
65
def convert(self, val: t.Any) -> T_co:
    """Convert ``val`` to ``T_co``. Raises a ``ConvertError`` on failure."""
    try:
        return self.try_convert(val)
    except ParseInterrupt:
        pass
    node = self.collect_errors(val)
    if node is None:
        raise RuntimeError("convert() raised but ``collect_errors`` returned ``None``."
                           " This is a bug of the ``Converter`` implementation.")
    raise ConvertError(node)

expected(plural=False)

See Converter.expected

Source code in pane/converters.py 
476
477
478
479
def expected(self, plural: bool = False) -> str:
    """See [`Converter.expected`][pane.converters.Converter.expected]"""
    name = f" {self.name}" if self.name is not None else ""
    return f"{pluralize('struct', plural)}{name}"

into_data(val)

See Converter.into_data

Source code in pane/converters.py 
481
482
483
484
485
486
487
488
489
490
491
def into_data(self, val: t.Any) -> DataType:
    """See [`Converter.into_data`][pane.converters.Converter.into_data]"""
    assert data_is_mapping(val)
    d: t.Dict[DataType, DataType] = {}
    for (k, v) in t.cast(t.Mapping[str, t.Any], val).items():
        if (ty := self.fields.get(k)) is not None and ty not in (t.Any, type(t.Any)):
            if (conv := self.field_converters.get(k)) is not None:
                d[k] = conv.into_data(v)
                continue
        d[k] = make_converter(t.cast(t.Type[t.Any], type(v)), self.handlers).into_data(v)
    return d

try_convert(val)

See Converter.try_convert

Source code in pane/converters.py 
493
494
495
496
497
498
499
500
501
502
503
504
505
506
def try_convert(self, val: t.Any) -> T:
    """See [`Converter.try_convert`][pane.converters.Converter.try_convert]"""
    if not data_is_mapping(val):
        raise ParseInterrupt()
    val = t.cast(t.Dict[str, t.Any], val)
    d: t.Dict[str, t.Any] = {}
    for (k, v) in val.items():
        if k not in self.fields:
            raise ParseInterrupt()  # unknown field
        d[k] = self.field_converters[k].try_convert(v)
    missing = set(self.fields.keys()) - set(val.keys()) - self.opt_fields
    if len(missing):
        raise ParseInterrupt()
    return self.ty(d)  # type: ignore

collect_errors(val)

See Converter.collect_errors

Source code in pane/converters.py 
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
def collect_errors(self, val: t.Any) -> t.Union[WrongTypeError, ProductErrorNode, None]:
    """See [`Converter.collect_errors`][pane.converters.Converter.collect_errors]"""
    if not data_is_mapping(val):
        return WrongTypeError(self.expected(), val)
    val = t.cast(t.Dict[str, t.Any], val)

    children: t.Dict[t.Union[str, int], t.Any] = {}
    extra: t.Set[str] = set()
    for (k, v) in val.items():
        if k not in self.fields:
            extra.add(k)
            continue
        if (node := self.field_converters[k].collect_errors(v)) is not None:
            children[k] = node
    missing = set(self.fields.keys()) - set(val.keys()) - self.opt_fields
    if len(children) or len(missing) or len(extra):
        return ProductErrorNode(self.expected(), children, val, missing, extra)
    return None

TupleConverter dataclass

Bases: Generic[T], Converter[T]

Converter for a simple, heterogeneous tuple-like type

Source code in pane/converters.py 
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
@dataclasses.dataclass(init=False)
class TupleConverter(t.Generic[T], Converter[T]):
    """Converter for a simple, heterogeneous tuple-like type"""
    ty: t.Type[T]
    """Type to convert into. Must be constructible from an iterable"""
    converters: t.Tuple[Converter[t.Any], ...]
    """List of sub-converters for each field"""

    def __init__(self, ty: t.Type[T], types: t.Sequence[IntoConverter], *,
                 handlers: ConverterHandlers = ConverterHandlers()):
        self.ty = ty
        self.converters = tuple(make_converter(ty, handlers) for ty in types)

    def into_data(self, val: t.Any) -> DataType:
        """See [`Converter.into_data`][pane.converters.Converter.into_data]"""
        return tuple(
            conv.into_data(v)
            for (v, conv) in zip(t.cast(t.Sequence[t.Any], val), self.converters)
        )

    def expected(self, plural: bool = False) -> str:
        """See [`Converter.expected`][pane.converters.Converter.expected]"""
        return f"{pluralize('tuple', plural)} of length {len(self.converters)}"

    def try_convert(self, val: t.Any) -> T:
        """See [`Converter.try_convert`][pane.converters.Converter.try_convert]"""
        if not data_is_sequence(val):
            raise ParseInterrupt
        if len(val) != len(self.converters):
            raise ParseInterrupt

        return self.ty(conv.try_convert(v) for (conv, v) in zip(self.converters, val))  # type: ignore

    def collect_errors(self, val: t.Any) -> t.Union[None, ProductErrorNode, WrongTypeError]:
        """See [`Converter.collect_errors`][pane.converters.Converter.collect_errors]"""
        if not data_is_sequence(val) or len(val) != len(self.converters):
            return WrongTypeError(self.expected(), val)
        children: _ProductErrorChildren = {}
        for (i, (conv, v)) in enumerate(zip(self.converters, val)):
            node = conv.collect_errors(v)
            if node is not None:
                children[i] = node
        if len(children) == 0:
            return None
        return ProductErrorNode(self.expected(), children, val)

ty = ty instance-attribute

Type to convert into. Must be constructible from an iterable

converters = tuple(make_converter(ty, handlers) for ty in types) instance-attribute

List of sub-converters for each field

convert(val)

Convert val to T_co. Raises a ConvertError on failure.

Source code in pane/converters.py 
55
56
57
58
59
60
61
62
63
64
65
def convert(self, val: t.Any) -> T_co:
    """Convert ``val`` to ``T_co``. Raises a ``ConvertError`` on failure."""
    try:
        return self.try_convert(val)
    except ParseInterrupt:
        pass
    node = self.collect_errors(val)
    if node is None:
        raise RuntimeError("convert() raised but ``collect_errors`` returned ``None``."
                           " This is a bug of the ``Converter`` implementation.")
    raise ConvertError(node)

into_data(val)

See Converter.into_data

Source code in pane/converters.py 
541
542
543
544
545
546
def into_data(self, val: t.Any) -> DataType:
    """See [`Converter.into_data`][pane.converters.Converter.into_data]"""
    return tuple(
        conv.into_data(v)
        for (v, conv) in zip(t.cast(t.Sequence[t.Any], val), self.converters)
    )

expected(plural=False)

See Converter.expected

Source code in pane/converters.py 
548
549
550
def expected(self, plural: bool = False) -> str:
    """See [`Converter.expected`][pane.converters.Converter.expected]"""
    return f"{pluralize('tuple', plural)} of length {len(self.converters)}"

try_convert(val)

See Converter.try_convert

Source code in pane/converters.py 
552
553
554
555
556
557
558
559
def try_convert(self, val: t.Any) -> T:
    """See [`Converter.try_convert`][pane.converters.Converter.try_convert]"""
    if not data_is_sequence(val):
        raise ParseInterrupt
    if len(val) != len(self.converters):
        raise ParseInterrupt

    return self.ty(conv.try_convert(v) for (conv, v) in zip(self.converters, val))  # type: ignore

collect_errors(val)

See Converter.collect_errors

Source code in pane/converters.py 
561
562
563
564
565
566
567
568
569
570
571
572
def collect_errors(self, val: t.Any) -> t.Union[None, ProductErrorNode, WrongTypeError]:
    """See [`Converter.collect_errors`][pane.converters.Converter.collect_errors]"""
    if not data_is_sequence(val) or len(val) != len(self.converters):
        return WrongTypeError(self.expected(), val)
    children: _ProductErrorChildren = {}
    for (i, (conv, v)) in enumerate(zip(self.converters, val)):
        node = conv.collect_errors(v)
        if node is not None:
            children[i] = node
    if len(children) == 0:
        return None
    return ProductErrorNode(self.expected(), children, val)

DictConverter dataclass

Bases: Generic[FromDataK, FromDataV], Converter[Mapping[FromDataK, FromDataV]]

Converter for a homogenous dict-like type.

Source code in pane/converters.py 
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
@dataclasses.dataclass(init=False)
class DictConverter(t.Generic[FromDataK, FromDataV], Converter[t.Mapping[FromDataK, FromDataV]]):
    """Converter for a homogenous dict-like type."""
    ty: t.Type[t.Mapping[FromDataK, FromDataV]]
    """Type to convert into. Must be constructible from a dict (unless `constructor` is specified)"""
    k_conv: Converter[FromDataK]
    """Sub-converter for keys"""
    v_conv: Converter[FromDataV]
    """Sub-converter for values"""
    constructor: t.Callable[[t.Dict[t.Any, t.Any]], t.Mapping[FromDataK, FromDataV]]
    handlers: ConverterHandlers

    def __init__(self, ty: t.Type[t.Dict[t.Any, t.Any]],
                 k: t.Type[FromDataK] = type(t.Any), v: t.Type[FromDataV] = type(t.Any),  # type: ignore
                 constructor: t.Optional[t.Callable[[t.Dict[t.Any, t.Any]], t.Mapping[FromDataK, FromDataV]]] = None,
                 *, handlers: ConverterHandlers = ConverterHandlers()):
        self.ty = ty
        self.k_conv = make_converter(k, handlers)
        self.v_conv = make_converter(v, handlers)
        self.constructor = self.ty if constructor is None else constructor
        self.handlers = handlers

    def into_data(self, val: t.Any) -> DataType:
        """See [`Converter.into_data`][pane.converters.Converter.into_data]"""
        if isinstance(self.k_conv, AnyConverter):
            def _k_into_data(k: t.Any) -> DataType:
                return make_converter(t.cast(t.Type[t.Any], type(k)), self.handlers).into_data(k)
        else:
            def _k_into_data(k: t.Any) -> DataType:
                return self.k_conv.into_data(k)

        if isinstance(self.v_conv, AnyConverter):
            def _v_into_data(v: t.Any) -> DataType:
                return make_converter(t.cast(t.Type[t.Any], type(v)), self.handlers).into_data(v)
        else:
            def _v_into_data(v: t.Any) -> DataType:
                return self.v_conv.into_data(v)

        return {
            _k_into_data(k): _v_into_data(v)
            for (k, v) in t.cast(t.Mapping[FromDataK, FromDataV], val).items()
        }

    def expected(self, plural: bool = False) -> str:
        """See [`Converter.expected`][pane.converters.Converter.expected]"""
        return f"{pluralize('mapping', plural)} of {self.k_conv.expected(True)} => {self.v_conv.expected(True)}"

    def try_convert(self, val: t.Any) -> t.Mapping[FromDataK, FromDataV]:
        """See [`Converter.try_convert`][pane.converters.Converter.try_convert]"""
        if not data_is_mapping(val):
            raise ParseInterrupt()

        d = {self.k_conv.try_convert(k): self.v_conv.try_convert(v) for (k, v) in val.items()}
        # TODO catch errors here
        return self.constructor(d)

    def collect_errors(self, val: t.Any) -> t.Union[None, WrongTypeError, ProductErrorNode]:
        """See [`Converter.collect_errors`][pane.converters.Converter.collect_errors]"""
        if not data_is_mapping(val):
            return WrongTypeError(self.expected(), val)

        nodes: _ProductErrorChildren = {}
        for (k, v) in val.items():
            if (node := self.k_conv.collect_errors(k)) is not None:
                nodes[str(k)] = node  # TODO split bad fields from bad values
            if (node := self.v_conv.collect_errors(v)) is not None:
                nodes[str(k)] = node
        if len(nodes):
            return ProductErrorNode(self.expected(), nodes, val)

ty = ty instance-attribute

Type to convert into. Must be constructible from a dict (unless constructor is specified)

k_conv = make_converter(k, handlers) instance-attribute

Sub-converter for keys

v_conv = make_converter(v, handlers) instance-attribute

Sub-converter for values

constructor = self.ty if constructor is None else constructor instance-attribute

handlers = handlers instance-attribute

convert(val)

Convert val to T_co. Raises a ConvertError on failure.

Source code in pane/converters.py 
55
56
57
58
59
60
61
62
63
64
65
def convert(self, val: t.Any) -> T_co:
    """Convert ``val`` to ``T_co``. Raises a ``ConvertError`` on failure."""
    try:
        return self.try_convert(val)
    except ParseInterrupt:
        pass
    node = self.collect_errors(val)
    if node is None:
        raise RuntimeError("convert() raised but ``collect_errors`` returned ``None``."
                           " This is a bug of the ``Converter`` implementation.")
    raise ConvertError(node)

into_data(val)

See Converter.into_data

Source code in pane/converters.py 
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
def into_data(self, val: t.Any) -> DataType:
    """See [`Converter.into_data`][pane.converters.Converter.into_data]"""
    if isinstance(self.k_conv, AnyConverter):
        def _k_into_data(k: t.Any) -> DataType:
            return make_converter(t.cast(t.Type[t.Any], type(k)), self.handlers).into_data(k)
    else:
        def _k_into_data(k: t.Any) -> DataType:
            return self.k_conv.into_data(k)

    if isinstance(self.v_conv, AnyConverter):
        def _v_into_data(v: t.Any) -> DataType:
            return make_converter(t.cast(t.Type[t.Any], type(v)), self.handlers).into_data(v)
    else:
        def _v_into_data(v: t.Any) -> DataType:
            return self.v_conv.into_data(v)

    return {
        _k_into_data(k): _v_into_data(v)
        for (k, v) in t.cast(t.Mapping[FromDataK, FromDataV], val).items()
    }

expected(plural=False)

See Converter.expected

Source code in pane/converters.py 
618
619
620
def expected(self, plural: bool = False) -> str:
    """See [`Converter.expected`][pane.converters.Converter.expected]"""
    return f"{pluralize('mapping', plural)} of {self.k_conv.expected(True)} => {self.v_conv.expected(True)}"

try_convert(val)

See Converter.try_convert

Source code in pane/converters.py 
622
623
624
625
626
627
628
629
def try_convert(self, val: t.Any) -> t.Mapping[FromDataK, FromDataV]:
    """See [`Converter.try_convert`][pane.converters.Converter.try_convert]"""
    if not data_is_mapping(val):
        raise ParseInterrupt()

    d = {self.k_conv.try_convert(k): self.v_conv.try_convert(v) for (k, v) in val.items()}
    # TODO catch errors here
    return self.constructor(d)

collect_errors(val)

See Converter.collect_errors

Source code in pane/converters.py 
631
632
633
634
635
636
637
638
639
640
641
642
643
def collect_errors(self, val: t.Any) -> t.Union[None, WrongTypeError, ProductErrorNode]:
    """See [`Converter.collect_errors`][pane.converters.Converter.collect_errors]"""
    if not data_is_mapping(val):
        return WrongTypeError(self.expected(), val)

    nodes: _ProductErrorChildren = {}
    for (k, v) in val.items():
        if (node := self.k_conv.collect_errors(k)) is not None:
            nodes[str(k)] = node  # TODO split bad fields from bad values
        if (node := self.v_conv.collect_errors(v)) is not None:
            nodes[str(k)] = node
    if len(nodes):
        return ProductErrorNode(self.expected(), nodes, val)

SequenceConverter dataclass

Bases: Generic[FromDataT], Converter[Sequence[FromDataT]]

Converter for a homogenous sequence-like type

Source code in pane/converters.py 
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
@dataclasses.dataclass(init=False)
class SequenceConverter(t.Generic[FromDataT], Converter[t.Sequence[FromDataT]]):
    """Converter for a homogenous sequence-like type"""
    ty: type
    """Type to convert into. Must be constructible from an iterator."""
    v_conv: Converter[FromDataT]
    """Sub-converter for values"""
    constructor: t.Callable[[t.Iterable[t.Any]], t.Sequence[t.Any]]
    handlers: ConverterHandlers

    def __init__(self, ty: t.Type[t.Sequence[t.Any]], v: t.Type[FromDataT] = t.cast(t.Type[t.Any], type(t.Any)), *,
                 handlers: ConverterHandlers = ConverterHandlers(),
                 constructor: t.Optional[t.Callable[[t.Iterable[t.Any]], t.Sequence[t.Any]]] = None):
        self.ty = ty
        self.v_conv = make_converter(v, handlers)
        self.handlers = handlers
        self.constructor = self.ty if constructor is None else constructor

    def into_data(self, val: t.Any) -> DataType:
        """See [`Converter.into_data`][pane.converters.Converter.into_data]"""
        # construct tuple from a tuple, or a list otherwise
        constructor = t.cast(t.Callable[[t.Iterable[t.Any]], t.Sequence[t.Any]], tuple if self.constructor is tuple else list)
        if self.ty in (t.Any, type(t.Any)):
            # also need to infer member types
            return constructor(
                make_converter(type(v), self.handlers).into_data(v)
                for v in t.cast(t.Sequence[FromDataT], val)
            )
        return constructor(
            self.v_conv.into_data(v)
            for v in t.cast(t.Sequence[FromDataT], val)
        )

    def expected(self, plural: bool = False) -> str:
        """See [`Converter.expected`][pane.converters.Converter.expected]"""
        return f"{pluralize('sequence', plural)} of {self.v_conv.expected(True)}"

    def try_convert(self, val: t.Any) -> t.Sequence[FromDataT]:
        """See [`Converter.try_convert`][pane.converters.Converter.try_convert]"""
        if not data_is_sequence(val):
            raise ParseInterrupt
        try:
            return self.constructor(self.v_conv.try_convert(v) for v in val)  # type: ignore
        except Exception:
            raise ParseInterrupt()

    def collect_errors(self, val: t.Any) -> t.Union[None, WrongTypeError, ProductErrorNode]:
        """See [`Converter.collect_errors`][pane.converters.Converter.collect_errors]"""
        if not data_is_sequence(val):
            return WrongTypeError(self.expected(), val)

        nodes: t.Dict[t.Union[int, str], ErrorNode] = {}
        vals: t.List[FromDataT] = []
        for (i, v) in enumerate(val):
            try:
                vals.append(self.v_conv.convert(v))
            except ConvertError as e:
                nodes[i] = e.tree

        if len(nodes):
            return ProductErrorNode(self.expected(), nodes, val)
        # try to construct val
        try:
            self.constructor(iter(vals))
            return None
        except Exception as e:
            tb = e.__traceback__.tb_next  # type: ignore
            tb = traceback.TracebackException(type(e), e, tb)
            return WrongTypeError(self.expected(), val, tb)

ty = ty instance-attribute

Type to convert into. Must be constructible from an iterator.

v_conv = make_converter(v, handlers) instance-attribute

Sub-converter for values

handlers = handlers instance-attribute

constructor = self.ty if constructor is None else constructor instance-attribute

convert(val)

Convert val to T_co. Raises a ConvertError on failure.

Source code in pane/converters.py 
55
56
57
58
59
60
61
62
63
64
65
def convert(self, val: t.Any) -> T_co:
    """Convert ``val`` to ``T_co``. Raises a ``ConvertError`` on failure."""
    try:
        return self.try_convert(val)
    except ParseInterrupt:
        pass
    node = self.collect_errors(val)
    if node is None:
        raise RuntimeError("convert() raised but ``collect_errors`` returned ``None``."
                           " This is a bug of the ``Converter`` implementation.")
    raise ConvertError(node)

into_data(val)

See Converter.into_data

Source code in pane/converters.py 
664
665
666
667
668
669
670
671
672
673
674
675
676
677
def into_data(self, val: t.Any) -> DataType:
    """See [`Converter.into_data`][pane.converters.Converter.into_data]"""
    # construct tuple from a tuple, or a list otherwise
    constructor = t.cast(t.Callable[[t.Iterable[t.Any]], t.Sequence[t.Any]], tuple if self.constructor is tuple else list)
    if self.ty in (t.Any, type(t.Any)):
        # also need to infer member types
        return constructor(
            make_converter(type(v), self.handlers).into_data(v)
            for v in t.cast(t.Sequence[FromDataT], val)
        )
    return constructor(
        self.v_conv.into_data(v)
        for v in t.cast(t.Sequence[FromDataT], val)
    )

expected(plural=False)

See Converter.expected

Source code in pane/converters.py 
679
680
681
def expected(self, plural: bool = False) -> str:
    """See [`Converter.expected`][pane.converters.Converter.expected]"""
    return f"{pluralize('sequence', plural)} of {self.v_conv.expected(True)}"

try_convert(val)

See Converter.try_convert

Source code in pane/converters.py 
683
684
685
686
687
688
689
690
def try_convert(self, val: t.Any) -> t.Sequence[FromDataT]:
    """See [`Converter.try_convert`][pane.converters.Converter.try_convert]"""
    if not data_is_sequence(val):
        raise ParseInterrupt
    try:
        return self.constructor(self.v_conv.try_convert(v) for v in val)  # type: ignore
    except Exception:
        raise ParseInterrupt()

collect_errors(val)

See Converter.collect_errors

Source code in pane/converters.py 
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
def collect_errors(self, val: t.Any) -> t.Union[None, WrongTypeError, ProductErrorNode]:
    """See [`Converter.collect_errors`][pane.converters.Converter.collect_errors]"""
    if not data_is_sequence(val):
        return WrongTypeError(self.expected(), val)

    nodes: t.Dict[t.Union[int, str], ErrorNode] = {}
    vals: t.List[FromDataT] = []
    for (i, v) in enumerate(val):
        try:
            vals.append(self.v_conv.convert(v))
        except ConvertError as e:
            nodes[i] = e.tree

    if len(nodes):
        return ProductErrorNode(self.expected(), nodes, val)
    # try to construct val
    try:
        self.constructor(iter(vals))
        return None
    except Exception as e:
        tb = e.__traceback__.tb_next  # type: ignore
        tb = traceback.TracebackException(type(e), e, tb)
        return WrongTypeError(self.expected(), val, tb)

NestedSequenceConverter dataclass

Bases: Generic[T, U], Converter[T]

Converter which delegates to a sub-converter, and then attempts to construct a different type

Source code in pane/converters.py 
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
@dataclasses.dataclass
class NestedSequenceConverter(t.Generic[T, U], Converter[T]):
    """
    Converter which delegates to a sub-converter, and then attempts
    to construct a different type
    """
    val_type: t.Type[U]
    """Inner type to convert to"""
    constructor: t.Callable[[NestedSequence[U]], T]
    """Constructor to call."""

    handlers: ConverterHandlers = ConverterHandlers()

    ragged: bool = False
    """Whether to accept ragged arrays."""
    into_data_f: t.Optional[t.Callable[[t.Any], DataType]] = None

    val_conv: Converter[U] = dataclasses.field(init=False)
    """[`Converter`][pane.converters.Converter] for value type"""

    def __post_init__(self):
        self.val_conv = make_converter(self.val_type, self.handlers)

    def expected(self, plural: bool = False) -> str:
        """See [`Converter.expected`][pane.converters.Converter.expected]"""
        word = 'nested sequence' if self.ragged else 'n-d array'
        return f"{pluralize(word, plural, article='a')} of {self.val_conv.expected(True)}"

    def into_data(self, val: t.Any) -> DataType:
        if self.into_data_f is not None:
            return self.into_data_f(val)
        return self._into_data(val)

    def _into_data(self, val: t.Any) -> DataType:
        if data_is_iterable(val):
            return list(map(self._into_data, val))
        if self.val_type in (t.Any, t.cast(t.Type[t.Any], type(t.Any))):
            return make_converter(t.cast(t.Type[t.Any], type(val)), self.handlers).into_data(val)
        return self.val_conv.into_data(val)

    @staticmethod
    def _check_shape(val: NestedSequence[t.Any], dim: int = 0) -> t.Tuple[int, ...]:
        if not data_is_sequence(val):
            # single value
            return ()
        shapes = [NestedSequenceConverter._check_shape(v, dim+1) for v in val]
        if len(shapes) == 0:
            return (0,)
        shape = shapes[0]
        if not all(s == shape for s in shapes):
            raise ValueError(f"shape mismatch at dim {dim}. Sub-shapes: {shapes}")
        new_shape = (len(shapes), *shape)
        return new_shape

    def try_convert(self, val: t.Any) -> T:
        """See [`Converter.try_convert`][pane.converters.Converter.try_convert]"""
        result = self._try_convert(val)
        if not self.ragged:
            try:
                self._check_shape(result)
            except ValueError:
                raise ParseInterrupt()
        return self.constructor(result)

    def _try_convert(self, val: t.Any) -> NestedSequence[U]:
        if not data_is_sequence(val):
            # single value
            return self.val_conv.try_convert(val)
        vals = list(map(self._try_convert, val))
        return t.cast(NestedSequence[U], vals)

    def collect_errors(self, val: t.Any) -> t.Optional[ErrorNode]:
        """See [`Converter.collect_errors`][pane.converters.Converter.collect_errors]"""
        if (node := self._collect_errors(val)) is not None:
            return node
        val = self._try_convert(val)
        if not self.ragged:
            try:
                self._check_shape(val)
            except ValueError as e:
                return WrongTypeError(self.expected(), val, info=e.args[0])
        try:
            self.constructor(val)
        except Exception as e:
            tb = e.__traceback__.tb_next  # type: ignore
            tb = traceback.TracebackException(type(e), e, tb)
            return WrongTypeError(self.expected(), val, tb)

    def _collect_errors(self, val: t.Any) -> t.Optional[ErrorNode]:
        if not data_is_sequence(val):
            return self.val_conv.collect_errors(val)
        nodes: _ProductErrorChildren = {}
        for (i, v) in enumerate(val):
            if (node := self._collect_errors(v)) is not None:
                nodes[i] = node
        if len(nodes):
            return ProductErrorNode(self.expected(), nodes, val)

val_type instance-attribute

Inner type to convert to

constructor instance-attribute

Constructor to call.

handlers = ConverterHandlers() class-attribute instance-attribute

ragged = False class-attribute instance-attribute

Whether to accept ragged arrays.

into_data_f = None class-attribute instance-attribute

val_conv = dataclasses.field(init=False) class-attribute instance-attribute

Converter for value type

convert(val)

Convert val to T_co. Raises a ConvertError on failure.

Source code in pane/converters.py 
55
56
57
58
59
60
61
62
63
64
65
def convert(self, val: t.Any) -> T_co:
    """Convert ``val`` to ``T_co``. Raises a ``ConvertError`` on failure."""
    try:
        return self.try_convert(val)
    except ParseInterrupt:
        pass
    node = self.collect_errors(val)
    if node is None:
        raise RuntimeError("convert() raised but ``collect_errors`` returned ``None``."
                           " This is a bug of the ``Converter`` implementation.")
    raise ConvertError(node)

expected(plural=False)

See Converter.expected

Source code in pane/converters.py 
740
741
742
743
def expected(self, plural: bool = False) -> str:
    """See [`Converter.expected`][pane.converters.Converter.expected]"""
    word = 'nested sequence' if self.ragged else 'n-d array'
    return f"{pluralize(word, plural, article='a')} of {self.val_conv.expected(True)}"

into_data(val)

Source code in pane/converters.py 
745
746
747
748
def into_data(self, val: t.Any) -> DataType:
    if self.into_data_f is not None:
        return self.into_data_f(val)
    return self._into_data(val)

try_convert(val)

See Converter.try_convert

Source code in pane/converters.py 
771
772
773
774
775
776
777
778
779
def try_convert(self, val: t.Any) -> T:
    """See [`Converter.try_convert`][pane.converters.Converter.try_convert]"""
    result = self._try_convert(val)
    if not self.ragged:
        try:
            self._check_shape(result)
        except ValueError:
            raise ParseInterrupt()
    return self.constructor(result)

collect_errors(val)

See Converter.collect_errors

Source code in pane/converters.py 
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
def collect_errors(self, val: t.Any) -> t.Optional[ErrorNode]:
    """See [`Converter.collect_errors`][pane.converters.Converter.collect_errors]"""
    if (node := self._collect_errors(val)) is not None:
        return node
    val = self._try_convert(val)
    if not self.ragged:
        try:
            self._check_shape(val)
        except ValueError as e:
            return WrongTypeError(self.expected(), val, info=e.args[0])
    try:
        self.constructor(val)
    except Exception as e:
        tb = e.__traceback__.tb_next  # type: ignore
        tb = traceback.TracebackException(type(e), e, tb)
        return WrongTypeError(self.expected(), val, tb)

ConditionalConverter dataclass

Bases: Generic[FromDataT], Converter[FromDataT]

Converter which applies an arbitrary pre-condition to the converted value.

Source code in pane/converters.py 
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
@dataclasses.dataclass
class ConditionalConverter(t.Generic[FromDataT], Converter[FromDataT]):
    """
    Converter which applies an arbitrary pre-condition to the converted value.
    """
    inner_type: t.Union[Converter[FromDataT], IntoConverter]
    """Inner type to apply condition to"""
    condition: t.Callable[[FromDataT], bool]
    """Function to evaluate condition"""
    condition_name: str
    """Human-readable name of condition"""
    make_expected: t.Callable[[str, bool], str]
    """Function which takes ``(expected, plural)`` and makes a compound ``expected``."""
    handlers: ConverterHandlers = ConverterHandlers()

    inner: Converter[FromDataT] = dataclasses.field(init=False)
    """Inner sub-converter"""

    def __post_init__(self):
        if isinstance(self.inner_type, Converter):
            self.inner = self.inner_type
        else:
            self.inner = make_converter(t.cast(t.Type[FromDataT], self.inner_type), self.handlers)

    def into_data(self, val: t.Any) -> DataType:
        """See [`Converter.into_data`][pane.converters.Converter.into_data]"""
        return self.inner.into_data(val)

    def expected(self, plural: bool = False) -> str:
        """See [`Converter.expected`][pane.converters.Converter.expected]"""
        return self.make_expected(self.inner.expected(plural), plural)

    def try_convert(self, val: t.Any) -> FromDataT:
        """See [`Converter.try_convert`][pane.converters.Converter.try_convert]"""
        val = self.inner.try_convert(val)
        try:
            if self.condition(val):
                return val
        except Exception:
            pass
        raise ParseInterrupt()

    def collect_errors(self, val: t.Any) -> t.Optional[ErrorNode]:
        """See [`Converter.collect_errors`][pane.converters.Converter.collect_errors]"""
        try:
            conv_val = self.inner.try_convert(val)
        except ParseInterrupt:
            # TODO with_expected() here
            return self.inner.collect_errors(val)
        try:
            # condition failed
            if not self.condition(conv_val):
                return ConditionFailedError(self.expected(), val, self.condition_name)
        except Exception as e:
            tb = e.__traceback__.tb_next  # type: ignore
            tb = traceback.TracebackException(type(e), e, tb)
            return ConditionFailedError(self.expected(), val, self.condition_name, tb)
        return None

inner_type instance-attribute

Inner type to apply condition to

condition instance-attribute

Function to evaluate condition

condition_name instance-attribute

Human-readable name of condition

make_expected instance-attribute

Function which takes (expected, plural) and makes a compound expected.

handlers = ConverterHandlers() class-attribute instance-attribute

inner = dataclasses.field(init=False) class-attribute instance-attribute

Inner sub-converter

convert(val)

Convert val to T_co. Raises a ConvertError on failure.

Source code in pane/converters.py 
55
56
57
58
59
60
61
62
63
64
65
def convert(self, val: t.Any) -> T_co:
    """Convert ``val`` to ``T_co``. Raises a ``ConvertError`` on failure."""
    try:
        return self.try_convert(val)
    except ParseInterrupt:
        pass
    node = self.collect_errors(val)
    if node is None:
        raise RuntimeError("convert() raised but ``collect_errors`` returned ``None``."
                           " This is a bug of the ``Converter`` implementation.")
    raise ConvertError(node)

into_data(val)

See Converter.into_data

Source code in pane/converters.py 
840
841
842
def into_data(self, val: t.Any) -> DataType:
    """See [`Converter.into_data`][pane.converters.Converter.into_data]"""
    return self.inner.into_data(val)

expected(plural=False)

See Converter.expected

Source code in pane/converters.py 
844
845
846
def expected(self, plural: bool = False) -> str:
    """See [`Converter.expected`][pane.converters.Converter.expected]"""
    return self.make_expected(self.inner.expected(plural), plural)

try_convert(val)

See Converter.try_convert

Source code in pane/converters.py 
848
849
850
851
852
853
854
855
856
def try_convert(self, val: t.Any) -> FromDataT:
    """See [`Converter.try_convert`][pane.converters.Converter.try_convert]"""
    val = self.inner.try_convert(val)
    try:
        if self.condition(val):
            return val
    except Exception:
        pass
    raise ParseInterrupt()

collect_errors(val)

See Converter.collect_errors

Source code in pane/converters.py 
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
def collect_errors(self, val: t.Any) -> t.Optional[ErrorNode]:
    """See [`Converter.collect_errors`][pane.converters.Converter.collect_errors]"""
    try:
        conv_val = self.inner.try_convert(val)
    except ParseInterrupt:
        # TODO with_expected() here
        return self.inner.collect_errors(val)
    try:
        # condition failed
        if not self.condition(conv_val):
            return ConditionFailedError(self.expected(), val, self.condition_name)
    except Exception as e:
        tb = e.__traceback__.tb_next  # type: ignore
        tb = traceback.TracebackException(type(e), e, tb)
        return ConditionFailedError(self.expected(), val, self.condition_name, tb)
    return None

EnumConverter

Bases: Converter[Enum]

Source code in pane/converters.py 
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
class EnumConverter(Converter[enum.Enum]):
    def __init__(self, ty: t.Type[enum.Enum], handlers: ConverterHandlers = ConverterHandlers()):
        from pane.convert import _DataType  # type: ignore
        if issubclass(ty, enum.Flag):
            raise TypeError("Flag enums are not currently supported")
        self.ty: t.Type[enum.Enum] = ty

        members = ty.__members__.values()
        try:
            self.val_map = {member.value: member for member in members}
        except TypeError:
            raise TypeError("All enum members must be hashable")

        self.member_vals = tuple(self.val_map.keys())
        if not all(isinstance(val, _DataType) for val in self.member_vals):
            raise TypeError("All enum members must be data-interchange types")

        self.inner_ty = type_union(map(type, self.member_vals))
        self.inner_conv: Converter[t.Any] = make_converter(self.inner_ty, handlers)

    def into_data(self, val: t.Any) -> DataType:
        """See [`Converter.into_data`][pane.converters.Converter.into_data]"""
        if isinstance(val, self.ty):
            return val.value  # guaranteed to be data-interchange type
        return into_data(val)

    def expected(self, plural: bool = False) -> str:
        """See [`Converter.expected`][pane.converters.Converter.expected]"""
        vs = list_phrase(tuple(map(str, self.member_vals)))
        return f"{pluralize('member', plural)} of enum '{self.ty.__name__}' ({vs})"

    def try_convert(self, val: t.Any) -> enum.Enum:
        """See [`Converter.try_convert`][pane.converters.Converter.try_convert]"""
        val = self.inner_conv.try_convert(val)
        try:
            return self.val_map[val]
        except KeyError:
            raise ParseInterrupt()

    def collect_errors(self, val: t.Any) -> t.Optional[ErrorNode]:
        """See [`Converter.collect_errors`][pane.converters.Converter.collect_errors]"""
        try:
            val = self.inner_conv.try_convert(val)
        except ParseInterrupt:
            return self.inner_conv.collect_errors(val)
        try:
            self.val_map[val]
            return None
        except KeyError:
            return WrongTypeError(self.expected(), val)

ty = ty instance-attribute

val_map = {member.value: memberfor member in members} instance-attribute

member_vals = tuple(self.val_map.keys()) instance-attribute

inner_ty = type_union(map(type, self.member_vals)) instance-attribute

inner_conv = make_converter(self.inner_ty, handlers) instance-attribute

convert(val)

Convert val to T_co. Raises a ConvertError on failure.

Source code in pane/converters.py 
55
56
57
58
59
60
61
62
63
64
65
def convert(self, val: t.Any) -> T_co:
    """Convert ``val`` to ``T_co``. Raises a ``ConvertError`` on failure."""
    try:
        return self.try_convert(val)
    except ParseInterrupt:
        pass
    node = self.collect_errors(val)
    if node is None:
        raise RuntimeError("convert() raised but ``collect_errors`` returned ``None``."
                           " This is a bug of the ``Converter`` implementation.")
    raise ConvertError(node)

into_data(val)

See Converter.into_data

Source code in pane/converters.py 
896
897
898
899
900
def into_data(self, val: t.Any) -> DataType:
    """See [`Converter.into_data`][pane.converters.Converter.into_data]"""
    if isinstance(val, self.ty):
        return val.value  # guaranteed to be data-interchange type
    return into_data(val)

expected(plural=False)

See Converter.expected

Source code in pane/converters.py 
902
903
904
905
def expected(self, plural: bool = False) -> str:
    """See [`Converter.expected`][pane.converters.Converter.expected]"""
    vs = list_phrase(tuple(map(str, self.member_vals)))
    return f"{pluralize('member', plural)} of enum '{self.ty.__name__}' ({vs})"

try_convert(val)

See Converter.try_convert

Source code in pane/converters.py 
907
908
909
910
911
912
913
def try_convert(self, val: t.Any) -> enum.Enum:
    """See [`Converter.try_convert`][pane.converters.Converter.try_convert]"""
    val = self.inner_conv.try_convert(val)
    try:
        return self.val_map[val]
    except KeyError:
        raise ParseInterrupt()

collect_errors(val)

See Converter.collect_errors

Source code in pane/converters.py 
915
916
917
918
919
920
921
922
923
924
925
def collect_errors(self, val: t.Any) -> t.Optional[ErrorNode]:
    """See [`Converter.collect_errors`][pane.converters.Converter.collect_errors]"""
    try:
        val = self.inner_conv.try_convert(val)
    except ParseInterrupt:
        return self.inner_conv.collect_errors(val)
    try:
        self.val_map[val]
        return None
    except KeyError:
        return WrongTypeError(self.expected(), val)

DelegateConverter dataclass

Bases: Generic[T, U], Converter[T]

Converter which delegates to a sub-converter, and then attempts to construct a different type

Source code in pane/converters.py 
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
@dataclasses.dataclass
class DelegateConverter(t.Generic[T, U], Converter[T]):
    """
    Converter which delegates to a sub-converter, and then attempts
    to construct a different type
    """
    from_type: t.Type[U]
    """Inner type to convert to"""
    constructor: t.Callable[[U], T]
    """Constructor for outer type"""
    expect: t.Optional[str] = None
    """Expected value. Defaults to inner expected value."""
    expect_plural: t.Optional[str] = None
    """Plural expected value. Defaults to inner expected value."""
    handlers: ConverterHandlers = ConverterHandlers()

    inner: Converter[U] = dataclasses.field(init=False)
    """Inner sub-converter"""

    def __post_init__(self):
        self.inner = make_converter(self.from_type, self.handlers)

    def into_data(self, val: t.Any) -> DataType:
        """See [`Converter.into_data`][pane.converters.Converter.into_data]"""
        # TODO: this is a hack, because we can't easily convert T back to U
        try:
            return self.inner.into_data(val)
        except Exception:
            pass
        return into_data(val)

    def expected(self, plural: bool = False) -> str:
        """See [`Converter.expected`][pane.converters.Converter.expected]"""
        if not plural and self.expect:
            return self.expect
        if plural and self.expect_plural:
            return self.expect_plural
        return self.inner.expected(plural)

    def try_convert(self, val: t.Any) -> T:
        """See [`Converter.try_convert`][pane.converters.Converter.try_convert]"""
        val = self.inner.try_convert(val)
        try:
            return self.constructor(val)
        except Exception:
            raise ParseInterrupt from None

    def collect_errors(self, val: t.Any) -> t.Optional[ErrorNode]:
        """See [`Converter.collect_errors`][pane.converters.Converter.collect_errors]"""
        try:
            conv_val = self.inner.try_convert(val)
        except ParseInterrupt:
            # TODO with_expected() here
            return self.inner.collect_errors(val)
        try:
            self.constructor(conv_val)
        except Exception as e:
            tb = e.__traceback__.tb_next  # type: ignore
            tb = traceback.TracebackException(type(e), e, tb)
            return WrongTypeError(self.expected(), val, tb)

from_type instance-attribute

Inner type to convert to

constructor instance-attribute

Constructor for outer type

expect = None class-attribute instance-attribute

Expected value. Defaults to inner expected value.

expect_plural = None class-attribute instance-attribute

Plural expected value. Defaults to inner expected value.

handlers = ConverterHandlers() class-attribute instance-attribute

inner = dataclasses.field(init=False) class-attribute instance-attribute

Inner sub-converter

convert(val)

Convert val to T_co. Raises a ConvertError on failure.

Source code in pane/converters.py 
55
56
57
58
59
60
61
62
63
64
65
def convert(self, val: t.Any) -> T_co:
    """Convert ``val`` to ``T_co``. Raises a ``ConvertError`` on failure."""
    try:
        return self.try_convert(val)
    except ParseInterrupt:
        pass
    node = self.collect_errors(val)
    if node is None:
        raise RuntimeError("convert() raised but ``collect_errors`` returned ``None``."
                           " This is a bug of the ``Converter`` implementation.")
    raise ConvertError(node)

into_data(val)

See Converter.into_data

Source code in pane/converters.py 
950
951
952
953
954
955
956
957
def into_data(self, val: t.Any) -> DataType:
    """See [`Converter.into_data`][pane.converters.Converter.into_data]"""
    # TODO: this is a hack, because we can't easily convert T back to U
    try:
        return self.inner.into_data(val)
    except Exception:
        pass
    return into_data(val)

expected(plural=False)

See Converter.expected

Source code in pane/converters.py 
959
960
961
962
963
964
965
def expected(self, plural: bool = False) -> str:
    """See [`Converter.expected`][pane.converters.Converter.expected]"""
    if not plural and self.expect:
        return self.expect
    if plural and self.expect_plural:
        return self.expect_plural
    return self.inner.expected(plural)

try_convert(val)

See Converter.try_convert

Source code in pane/converters.py 
967
968
969
970
971
972
973
def try_convert(self, val: t.Any) -> T:
    """See [`Converter.try_convert`][pane.converters.Converter.try_convert]"""
    val = self.inner.try_convert(val)
    try:
        return self.constructor(val)
    except Exception:
        raise ParseInterrupt from None

collect_errors(val)

See Converter.collect_errors

Source code in pane/converters.py 
975
976
977
978
979
980
981
982
983
984
985
986
987
def collect_errors(self, val: t.Any) -> t.Optional[ErrorNode]:
    """See [`Converter.collect_errors`][pane.converters.Converter.collect_errors]"""
    try:
        conv_val = self.inner.try_convert(val)
    except ParseInterrupt:
        # TODO with_expected() here
        return self.inner.collect_errors(val)
    try:
        self.constructor(conv_val)
    except Exception as e:
        tb = e.__traceback__.tb_next  # type: ignore
        tb = traceback.TracebackException(type(e), e, tb)
        return WrongTypeError(self.expected(), val, tb)

PatternConverter dataclass

Bases: Generic[AnyStr], Converter[Pattern[AnyStr]]

Source code in pane/converters.py 
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
@dataclasses.dataclass(init=False)
class PatternConverter(t.Generic[t.AnyStr], Converter[re.Pattern[t.AnyStr]]):
    ty: t.Type[t.AnyStr]
    ty_conv: Converter[t.AnyStr]

    def __init__(self, ty: t.Type[t.AnyStr] = str, *args: t.Any,
                 handlers: ConverterHandlers = ConverterHandlers()):
        if len(args) > 0:
            raise TypeError("PatternConverter takes only one type argument")
        self.ty = ty
        if not issubclass(ty, (str, bytes)):
            raise TypeError(f"Pattern only accepts a 'str' or 'bytes' type argument, instead got '{ty!r}'")
        self.ty_conv = make_converter(self.ty, handlers)

    def into_data(self, val: t.Any) -> t.AnyStr:
        assert isinstance(val, re.Pattern)
        return t.cast(re.Pattern[t.AnyStr], val).pattern

    def expected(self, plural: bool = False) -> str:
        ty = 'bytes' if self.ty is bytes else 'string'
        return pluralize(f'{ty} regex pattern', plural, article='a')

    def try_convert(self, val: t.Any) -> re.Pattern[t.AnyStr]:
        if isinstance(val, re.Pattern):
            val = t.cast(re.Pattern[t.Any], val).pattern
        s = self.ty_conv.try_convert(val)
        try:
            return re.compile(s)
        except Exception:
            raise ParseInterrupt from None

    def collect_errors(self, val: t.Any) -> t.Optional[ErrorNode]:
        if isinstance(val, re.Pattern):
            val = t.cast(re.Pattern[t.Any], val).pattern
        try:
            s = self.ty_conv.try_convert(val)
        except ParseInterrupt:
            return WrongTypeError(self.expected(), val)
        try:
            re.compile(s)
        except re.error as e:
            tb = e.__traceback__.tb_next  # type: ignore
            tb = traceback.TracebackException(type(e), e, tb)
            return WrongTypeError(self.expected(), val, tb)
        return None

ty = ty instance-attribute

ty_conv = make_converter(self.ty, handlers) instance-attribute

convert(val)

Convert val to T_co. Raises a ConvertError on failure.

Source code in pane/converters.py 
55
56
57
58
59
60
61
62
63
64
65
def convert(self, val: t.Any) -> T_co:
    """Convert ``val`` to ``T_co``. Raises a ``ConvertError`` on failure."""
    try:
        return self.try_convert(val)
    except ParseInterrupt:
        pass
    node = self.collect_errors(val)
    if node is None:
        raise RuntimeError("convert() raised but ``collect_errors`` returned ``None``."
                           " This is a bug of the ``Converter`` implementation.")
    raise ConvertError(node)

into_data(val)

Source code in pane/converters.py 
1004
1005
1006
def into_data(self, val: t.Any) -> t.AnyStr:
    assert isinstance(val, re.Pattern)
    return t.cast(re.Pattern[t.AnyStr], val).pattern

expected(plural=False)

Source code in pane/converters.py 
1008
1009
1010
def expected(self, plural: bool = False) -> str:
    ty = 'bytes' if self.ty is bytes else 'string'
    return pluralize(f'{ty} regex pattern', plural, article='a')

try_convert(val)

Source code in pane/converters.py 
1012
1013
1014
1015
1016
1017
1018
1019
def try_convert(self, val: t.Any) -> re.Pattern[t.AnyStr]:
    if isinstance(val, re.Pattern):
        val = t.cast(re.Pattern[t.Any], val).pattern
    s = self.ty_conv.try_convert(val)
    try:
        return re.compile(s)
    except Exception:
        raise ParseInterrupt from None

collect_errors(val)

Source code in pane/converters.py 
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
def collect_errors(self, val: t.Any) -> t.Optional[ErrorNode]:
    if isinstance(val, re.Pattern):
        val = t.cast(re.Pattern[t.Any], val).pattern
    try:
        s = self.ty_conv.try_convert(val)
    except ParseInterrupt:
        return WrongTypeError(self.expected(), val)
    try:
        re.compile(s)
    except re.error as e:
        tb = e.__traceback__.tb_next  # type: ignore
        tb = traceback.TracebackException(type(e), e, tb)
        return WrongTypeError(self.expected(), val, tb)
    return None

DatetimeConverter

Bases: Converter[DatetimeT], Generic[DatetimeT]

Converter for a simple scalar type, constructible from a list of allowed types.

Source code in pane/converters.py 
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
class DatetimeConverter(Converter[DatetimeT], t.Generic[DatetimeT]):
    """
    Converter for a simple scalar type,
    constructible from a list of allowed types.
    """
    _date_types: t.Tuple[type, ...] = (datetime.date, datetime.time, datetime.datetime)
    _expected: t.Mapping[type, str] = {
        datetime.date: "date",
        datetime.datetime: "datetime",
        datetime.time: "time",
    }

    def __init__(self, ty: t.Type[DatetimeT]):
        self.ty = ty
        self.super_ty: t.Type[DatetimeT]
        if ty in self._date_types:
            self.super_ty = t.cast(t.Type[DatetimeT], ty)
            return
        for date_ty in self._date_types:
            if issubclass(ty, date_ty):
                self.super_ty = t.cast(t.Type[DatetimeT], date_ty)
                return
        raise TypeError(f"Only types {list_phrase([repr(str(ty)) for ty in self._date_types])} are supported")

    def __eq__(self, other: t.Any) -> bool:
        return type(self) is type(other) and self.ty is other.ty

    def expected(self, plural: bool = False) -> str:
        """See [`Converter.expected`][pane.converters.Converter.expected]"""
        return pluralize(self._expected[self.super_ty], plural, article='a')

    def into_data(self, val: t.Any) -> str:
        if isinstance(val, (datetime.time, datetime.date, datetime.datetime)):
            return val.isoformat()
        return str(val)

    #                input type:
    # output type:     date    datetime  time    str
    #          date     id     .date()   error  parse
    #      datetime   combine     id     error  parse
    #          time    error   .timetz()  id    parse

    def from_datetime(self, dt: datetime.datetime) -> DatetimeT:
        d: t.Mapping[type, t.Callable[[datetime.datetime], DatetimeT]] = {
            # datetime to datetime
            datetime.datetime: lambda dt: t.cast(DatetimeT, dt),
            # datetime to time
            datetime.time: lambda dt: t.cast(DatetimeT, dt.time()),
            # datetime to date
            datetime.date: lambda dt: t.cast(DatetimeT, dt.date()),
        }
        return d[self.super_ty](dt)

    def from_date(self, dt: datetime.date) -> DatetimeT:
        def err(val: t.Any):
            raise TypeError()

        d: t.Mapping[type, t.Callable[[datetime.date], DatetimeT]] = {
            # date to datetime
            datetime.datetime: lambda date: t.cast(DatetimeT, datetime.datetime.combine(date, datetime.time())),
            # date to date
            datetime.date: lambda date: t.cast(DatetimeT, date),
            datetime.time: err,
        }
        return d[self.super_ty](dt)

    def try_convert(self, val: t.Any) -> DatetimeT:
        """See [`Converter.try_convert`][pane.converters.Converter.try_convert]"""
        if isinstance(val, str):
            # parse string
            try:
                return t.cast(DatetimeT, self.ty.fromisoformat(val))
            except ValueError:
                raise ParseInterrupt() from None
        if isinstance(val, datetime.datetime):
            # from datetime, to datetime, date, or time
            return self.from_datetime(val)
        elif isinstance(val, datetime.time):
            # from time, to time only
            if self.super_ty == datetime.time:
                return t.cast(DatetimeT, val)
        elif isinstance(val, datetime.date):
            # from date, to date or datetime
            if self.super_ty != datetime.time:
                return self.from_date(val)
        raise ParseInterrupt()

    def collect_errors(self, val: t.Any) -> t.Optional[WrongTypeError]:
        """See [`Converter.collect_errors`][pane.converters.Converter.collect_errors]"""
        if isinstance(val, str):
            # parse string
            try:
                self.ty.fromisoformat(val)
                return None
            except ValueError as e:
                tb = e.__traceback__.tb_next  # type: ignore
                tb = traceback.TracebackException(type(e), e, tb)
                return WrongTypeError(self.expected(), val, tb)
        if isinstance(val, datetime.datetime):
            return None
        elif isinstance(val, datetime.time):
            if self.super_ty == datetime.time:
                return None
        elif isinstance(val, datetime.date):
            if self.super_ty != datetime.time:
                return None
        return WrongTypeError(self.expected(), val)

ty = ty instance-attribute

super_ty instance-attribute

convert(val)

Convert val to T_co. Raises a ConvertError on failure.

Source code in pane/converters.py 
55
56
57
58
59
60
61
62
63
64
65
def convert(self, val: t.Any) -> T_co:
    """Convert ``val`` to ``T_co``. Raises a ``ConvertError`` on failure."""
    try:
        return self.try_convert(val)
    except ParseInterrupt:
        pass
    node = self.collect_errors(val)
    if node is None:
        raise RuntimeError("convert() raised but ``collect_errors`` returned ``None``."
                           " This is a bug of the ``Converter`` implementation.")
    raise ConvertError(node)

expected(plural=False)

See Converter.expected

Source code in pane/converters.py 
1064
1065
1066
def expected(self, plural: bool = False) -> str:
    """See [`Converter.expected`][pane.converters.Converter.expected]"""
    return pluralize(self._expected[self.super_ty], plural, article='a')

into_data(val)

Source code in pane/converters.py 
1068
1069
1070
1071
def into_data(self, val: t.Any) -> str:
    if isinstance(val, (datetime.time, datetime.date, datetime.datetime)):
        return val.isoformat()
    return str(val)

from_datetime(dt)

Source code in pane/converters.py 
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
def from_datetime(self, dt: datetime.datetime) -> DatetimeT:
    d: t.Mapping[type, t.Callable[[datetime.datetime], DatetimeT]] = {
        # datetime to datetime
        datetime.datetime: lambda dt: t.cast(DatetimeT, dt),
        # datetime to time
        datetime.time: lambda dt: t.cast(DatetimeT, dt.time()),
        # datetime to date
        datetime.date: lambda dt: t.cast(DatetimeT, dt.date()),
    }
    return d[self.super_ty](dt)

from_date(dt)

Source code in pane/converters.py 
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
def from_date(self, dt: datetime.date) -> DatetimeT:
    def err(val: t.Any):
        raise TypeError()

    d: t.Mapping[type, t.Callable[[datetime.date], DatetimeT]] = {
        # date to datetime
        datetime.datetime: lambda date: t.cast(DatetimeT, datetime.datetime.combine(date, datetime.time())),
        # date to date
        datetime.date: lambda date: t.cast(DatetimeT, date),
        datetime.time: err,
    }
    return d[self.super_ty](dt)

try_convert(val)

See Converter.try_convert

Source code in pane/converters.py 
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
def try_convert(self, val: t.Any) -> DatetimeT:
    """See [`Converter.try_convert`][pane.converters.Converter.try_convert]"""
    if isinstance(val, str):
        # parse string
        try:
            return t.cast(DatetimeT, self.ty.fromisoformat(val))
        except ValueError:
            raise ParseInterrupt() from None
    if isinstance(val, datetime.datetime):
        # from datetime, to datetime, date, or time
        return self.from_datetime(val)
    elif isinstance(val, datetime.time):
        # from time, to time only
        if self.super_ty == datetime.time:
            return t.cast(DatetimeT, val)
    elif isinstance(val, datetime.date):
        # from date, to date or datetime
        if self.super_ty != datetime.time:
            return self.from_date(val)
    raise ParseInterrupt()

collect_errors(val)

See Converter.collect_errors

Source code in pane/converters.py 
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
def collect_errors(self, val: t.Any) -> t.Optional[WrongTypeError]:
    """See [`Converter.collect_errors`][pane.converters.Converter.collect_errors]"""
    if isinstance(val, str):
        # parse string
        try:
            self.ty.fromisoformat(val)
            return None
        except ValueError as e:
            tb = e.__traceback__.tb_next  # type: ignore
            tb = traceback.TracebackException(type(e), e, tb)
            return WrongTypeError(self.expected(), val, tb)
    if isinstance(val, datetime.datetime):
        return None
    elif isinstance(val, datetime.time):
        if self.super_ty == datetime.time:
            return None
    elif isinstance(val, datetime.date):
        if self.super_ty != datetime.time:
            return None
    return WrongTypeError(self.expected(), val)

data_is_sequence(val)

Return whether val is a sequence-like data type.

Source code in pane/converters.py 
35
36
37
def data_is_sequence(val: t.Any) -> TypeGuard[t.Sequence[t.Any]]:
    """Return whether `val` is a sequence-like data type."""
    return isinstance(val, t.Sequence) and not isinstance(val, (str, bytes, bytearray))

data_is_iterable(val)

Return whether val is an iterable (not str or bytes) data type.

Source code in pane/converters.py 
40
41
42
def data_is_iterable(val: t.Any) -> TypeGuard[t.Sequence[t.Any]]:
    """Return whether `val` is an iterable (not str or bytes) data type."""
    return isinstance(val, t.Iterable) and not isinstance(val, (str, bytes, bytearray))

data_is_mapping(val)

Return whether val is a mapping-like data type.

Source code in pane/converters.py 
45
46
47
def data_is_mapping(val: t.Any) -> TypeGuard[t.Mapping[t.Any, t.Any]]:
    """Return whether `val` is a mapping-like data type."""
    return isinstance(val, (dict, t.Mapping))