Skip to content

omnipy.components.raw.models

CLASS DESCRIPTION
BytesModel
JoinColumnsByCommaToLinesModel
JoinColumnsToLinesModel
JoinItemsModel
JoinItemsModelBase
JoinLinesModel
JoinSubitemsToItemsModel
JoinSubitemsToItemsModelBase
ListOfNestedListsOfStrModel
MatchItemsModel
NestedJoinItemsModel
NestedListsOfStrModel
NestedSplitToItemsModel
SplitItemsToSubitemsModel
SplitItemsToSubitemsModelBase
SplitLinesToColumnsByCommaModel
SplitLinesToColumnsModel
SplitToItemsByTabModel
SplitToItemsModel
SplitToItemsModelBase
SplitToLinesModel
StrModel
StrictBytesModel
StrictStrModel
ATTRIBUTE DESCRIPTION
ListOfNestedPlainListsOfStr

TYPE: TypeAlias

NestedListsOfStr

TYPE: TypeAlias

NestedPlainListsOfStr

TYPE: TypeAlias

ListOfNestedPlainListsOfStr module-attribute 

ListOfNestedPlainListsOfStr: TypeAlias = list['NestedPlainListsOfStr']

NestedListsOfStr module-attribute 

NestedListsOfStr: TypeAlias = str | ListOfNestedListsOfStrModel

NestedPlainListsOfStr module-attribute 

NestedPlainListsOfStr: TypeAlias = str | ListOfNestedPlainListsOfStr

BytesModel

Bases: _BytesModel

ATTRIBUTE DESCRIPTION
adjust

Source code in src/omnipy/components/raw/models.py 
39
40
41
42
43
class BytesModel(_BytesModel):
    adjust = bind_adjust_model_func(
        _BytesModel.clone_model_cls,
        _EncodingParamsMixin.Params,
    )

adjust class-attribute instance-attribute 

adjust = bind_adjust_model_func(_BytesModel.clone_model_cls, _EncodingParamsMixin.Params)

JoinColumnsByCommaToLinesModel

Bases: _JoinByCommaParamsMixin, JoinSubitemsToItemsModelBase

ATTRIBUTE DESCRIPTION
adjust

Source code in src/omnipy/components/raw/models.py 
320
321
322
323
324
class JoinColumnsByCommaToLinesModel(_JoinByCommaParamsMixin, JoinSubitemsToItemsModelBase):
    adjust = bind_adjust_model_func(
        JoinSubitemsToItemsModelBase.clone_model_cls,
        _JoinByCommaParamsMixin.Params,
    )

adjust class-attribute instance-attribute 

adjust = bind_adjust_model_func(
    JoinSubitemsToItemsModelBase.clone_model_cls, _JoinByCommaParamsMixin.Params
)

JoinColumnsToLinesModel

Bases: _JoinByTabParamsMixin, JoinSubitemsToItemsModelBase

ATTRIBUTE DESCRIPTION
adjust

Source code in src/omnipy/components/raw/models.py 
313
314
315
316
317
class JoinColumnsToLinesModel(_JoinByTabParamsMixin, JoinSubitemsToItemsModelBase):
    adjust = bind_adjust_model_func(
        JoinSubitemsToItemsModelBase.clone_model_cls,
        _JoinByTabParamsMixin.Params,
    )

adjust class-attribute instance-attribute 

adjust = bind_adjust_model_func(
    JoinSubitemsToItemsModelBase.clone_model_cls, _JoinByTabParamsMixin.Params
)

JoinItemsModel

Bases: _JoinByCommaParamsMixin, JoinItemsModelBase

ATTRIBUTE DESCRIPTION
adjust

Source code in src/omnipy/components/raw/models.py 
276
277
278
279
280
class JoinItemsModel(_JoinByCommaParamsMixin, JoinItemsModelBase):
    adjust = bind_adjust_model_func(
        JoinItemsModelBase.clone_model_cls,
        _JoinByCommaParamsMixin.Params,
    )

adjust class-attribute instance-attribute 

adjust = bind_adjust_model_func(JoinItemsModelBase.clone_model_cls, _JoinByCommaParamsMixin.Params)

JoinItemsModelBase

Bases: Model[str | list[str]]

Source code in src/omnipy/components/raw/models.py 
267
268
269
270
271
272
273
class JoinItemsModelBase(Model[str | list[str]]):
    @classmethod
    def _parse_data(cls: type[_HasJoinParams], data: str | list[str]) -> str:
        if isinstance(data, str):
            return data

        return _join_items(cls, data)

JoinLinesModel

Bases: _JoinByNewlineParamsMixin, JoinItemsModelBase

ATTRIBUTE DESCRIPTION
adjust

Source code in src/omnipy/components/raw/models.py 
283
284
285
286
287
class JoinLinesModel(_JoinByNewlineParamsMixin, JoinItemsModelBase):
    adjust = bind_adjust_model_func(
        JoinItemsModelBase.clone_model_cls,
        _JoinByNewlineParamsMixin.Params,
    )

adjust class-attribute instance-attribute 

adjust = bind_adjust_model_func(
    JoinItemsModelBase.clone_model_cls, _JoinByNewlineParamsMixin.Params
)

JoinSubitemsToItemsModel

Bases: _JoinByCommaParamsMixin, JoinSubitemsToItemsModelBase

ATTRIBUTE DESCRIPTION
adjust

Source code in src/omnipy/components/raw/models.py 
306
307
308
309
310
class JoinSubitemsToItemsModel(_JoinByCommaParamsMixin, JoinSubitemsToItemsModelBase):
    adjust = bind_adjust_model_func(
        JoinSubitemsToItemsModelBase.clone_model_cls,
        _JoinByCommaParamsMixin.Params,
    )

adjust class-attribute instance-attribute 

adjust = bind_adjust_model_func(
    JoinSubitemsToItemsModelBase.clone_model_cls, _JoinByCommaParamsMixin.Params
)

JoinSubitemsToItemsModelBase

Bases: Model[list[str] | list[list[str]]]

Source code in src/omnipy/components/raw/models.py 
297
298
299
300
301
302
303
class JoinSubitemsToItemsModelBase(Model[list[str] | list[list[str]]]):
    @classmethod
    def _parse_data(cls: type[_HasJoinParams], data: list[str] | list[list[str]]) -> list[str]:
        if isinstance(data, list) and (len(data) == 0 or not isinstance(data[0], list)):
            return cast(list[str], data)

        return [_join_items(cls, cast(list[str], cols)) for cols in data]

ListOfNestedListsOfStrModel

Bases: Model[list[_NestedListsOfStrT]], Generic[_NestedListsOfStrT]

Source code in src/omnipy/components/raw/models.py 
339
340
341
342
343
class ListOfNestedListsOfStrModel(
        Model[list[_NestedListsOfStrT]],
        Generic[_NestedListsOfStrT],
):
    ...

MatchItemsModel

Bases: _MatchItemsModel

ATTRIBUTE DESCRIPTION
adjust

Source code in src/omnipy/components/raw/models.py 
547
548
549
550
551
class MatchItemsModel(_MatchItemsModel):
    adjust = bind_adjust_model_func(
        _MatchItemsModel.clone_model_cls,
        _MatchItemsModel.Params,
    )

adjust class-attribute instance-attribute 

adjust = bind_adjust_model_func(_MatchItemsModel.clone_model_cls, _MatchItemsModel.Params)

NestedJoinItemsModel

Bases: _NestedJoinItemsModel

ATTRIBUTE DESCRIPTION
adjust

Source code in src/omnipy/components/raw/models.py 
498
499
500
501
502
class NestedJoinItemsModel(_NestedJoinItemsModel):
    adjust = bind_adjust_model_func(
        cast(Callable[..., type[_NestedJoinItemsModel]], _NestedJoinItemsModel.clone_model_cls),
        _NestedItemsParamsMixin.Params,
    )

adjust class-attribute instance-attribute 

adjust = bind_adjust_model_func(
    cast(Callable[..., type[_NestedJoinItemsModel]], _NestedJoinItemsModel.clone_model_cls),
    _NestedItemsParamsMixin.Params,
)

NestedListsOfStrModel

Bases: Model[NestedListsOfStr]

Source code in src/omnipy/components/raw/models.py 
349
350
class NestedListsOfStrModel(Model[NestedListsOfStr]):
    ...

NestedSplitToItemsModel

Bases: _NestedSplitToItemsModel

ATTRIBUTE DESCRIPTION
adjust

Source code in src/omnipy/components/raw/models.py 
443
444
445
446
447
448
class NestedSplitToItemsModel(_NestedSplitToItemsModel):
    adjust = bind_adjust_model_func(
        cast(Callable[..., type[_NestedSplitToItemsModel]],
             _NestedSplitToItemsModel.clone_model_cls),
        _NestedSplitToItemsModel.Params,
    )

adjust class-attribute instance-attribute 

adjust = bind_adjust_model_func(
    cast(Callable[..., type[_NestedSplitToItemsModel]], _NestedSplitToItemsModel.clone_model_cls),
    _NestedSplitToItemsModel.Params,
)

SplitItemsToSubitemsModel

Bases: _SplitByCommaParamsMixin, SplitItemsToSubitemsModelBase

ATTRIBUTE DESCRIPTION
adjust

Source code in src/omnipy/components/raw/models.py 
201
202
203
204
205
class SplitItemsToSubitemsModel(_SplitByCommaParamsMixin, SplitItemsToSubitemsModelBase):
    adjust = bind_adjust_model_func(
        SplitItemsToSubitemsModelBase.clone_model_cls,
        _SplitByCommaParamsMixin.Params,
    )

adjust class-attribute instance-attribute 

adjust = bind_adjust_model_func(
    SplitItemsToSubitemsModelBase.clone_model_cls, _SplitByCommaParamsMixin.Params
)

SplitItemsToSubitemsModelBase

Bases: Model[list[list[str]] | list[str] | list[StrModel]]

Source code in src/omnipy/components/raw/models.py 
191
192
193
194
195
196
197
198
class SplitItemsToSubitemsModelBase(Model[list[list[str]] | list[str] | list[StrModel]]):
    @classmethod
    def _parse_data(cls: type[_HasSplitParams],
                    data: list[list[str]] | list[str] | list[StrModel]) -> list[list[str]]:
        if isinstance(data, list) and (len(data) == 0 or isinstance(data[0], list)):
            return cast(list[list[str]], data)

        return [_split_line(cls, cast(str, line)) for line in data]

SplitLinesToColumnsByCommaModel

Bases: _SplitByCommaParamsMixin, SplitItemsToSubitemsModelBase

ATTRIBUTE DESCRIPTION
adjust

Source code in src/omnipy/components/raw/models.py 
215
216
217
218
219
class SplitLinesToColumnsByCommaModel(_SplitByCommaParamsMixin, SplitItemsToSubitemsModelBase):
    adjust = bind_adjust_model_func(
        SplitItemsToSubitemsModelBase.clone_model_cls,
        _SplitByCommaParamsMixin.Params,
    )

adjust class-attribute instance-attribute 

adjust = bind_adjust_model_func(
    SplitItemsToSubitemsModelBase.clone_model_cls, _SplitByCommaParamsMixin.Params
)

SplitLinesToColumnsModel

Bases: _SplitByTabParamsMixin, SplitItemsToSubitemsModelBase

ATTRIBUTE DESCRIPTION
adjust

Source code in src/omnipy/components/raw/models.py 
208
209
210
211
212
class SplitLinesToColumnsModel(_SplitByTabParamsMixin, SplitItemsToSubitemsModelBase):
    adjust = bind_adjust_model_func(
        SplitItemsToSubitemsModelBase.clone_model_cls,
        _SplitByTabParamsMixin.Params,
    )

adjust class-attribute instance-attribute 

adjust = bind_adjust_model_func(
    SplitItemsToSubitemsModelBase.clone_model_cls, _SplitByTabParamsMixin.Params
)

SplitToItemsByTabModel

Bases: _SplitByTabParamsMixin, SplitToItemsModelBase

ATTRIBUTE DESCRIPTION
adjust

Source code in src/omnipy/components/raw/models.py 
167
168
169
170
171
class SplitToItemsByTabModel(_SplitByTabParamsMixin, SplitToItemsModelBase):
    adjust = bind_adjust_model_func(
        SplitToItemsModelBase.clone_model_cls,
        _SplitByTabParamsMixin.Params,
    )

adjust class-attribute instance-attribute 

adjust = bind_adjust_model_func(
    SplitToItemsModelBase.clone_model_cls, _SplitByTabParamsMixin.Params
)

SplitToItemsModel

Bases: _SplitByCommaParamsMixin, SplitToItemsModelBase

ATTRIBUTE DESCRIPTION
adjust

Source code in src/omnipy/components/raw/models.py 
160
161
162
163
164
class SplitToItemsModel(_SplitByCommaParamsMixin, SplitToItemsModelBase):
    adjust = bind_adjust_model_func(
        SplitToItemsModelBase.clone_model_cls,
        _SplitByCommaParamsMixin.Params,
    )

adjust class-attribute instance-attribute 

adjust = bind_adjust_model_func(
    SplitToItemsModelBase.clone_model_cls, _SplitByCommaParamsMixin.Params
)

SplitToItemsModelBase

Bases: Model[list[str] | str]

Source code in src/omnipy/components/raw/models.py 
151
152
153
154
155
156
157
class SplitToItemsModelBase(Model[list[str] | str]):
    @classmethod
    def _parse_data(cls: type[_HasSplitParams], data: list[str] | str) -> list[str]:
        if isinstance(data, list):
            return data

        return _split_line(cls, data)

SplitToLinesModel

Bases: _SplitByNewlineParamsMixin, SplitToItemsModelBase

ATTRIBUTE DESCRIPTION
adjust

Source code in src/omnipy/components/raw/models.py 
174
175
176
177
178
class SplitToLinesModel(_SplitByNewlineParamsMixin, SplitToItemsModelBase):
    adjust = bind_adjust_model_func(
        SplitToItemsModelBase.clone_model_cls,
        _SplitByNewlineParamsMixin.Params,
    )

adjust class-attribute instance-attribute 

adjust = bind_adjust_model_func(
    SplitToItemsModelBase.clone_model_cls, _SplitByNewlineParamsMixin.Params
)

StrModel

Bases: _StrModel

ATTRIBUTE DESCRIPTION
adjust

Source code in src/omnipy/components/raw/models.py 
73
74
75
76
77
class StrModel(_StrModel):
    adjust = bind_adjust_model_func(
        _StrModel.clone_model_cls,
        _EncodingParamsMixin.Params,
    )

adjust class-attribute instance-attribute 

adjust = bind_adjust_model_func(_StrModel.clone_model_cls, _EncodingParamsMixin.Params)

StrictBytesModel

Bases: Model[pyd.StrictBytes]

Source code in src/omnipy/components/raw/models.py 
52
53
class StrictBytesModel(Model[pyd.StrictBytes]):
    ...

StrictStrModel

Bases: Model[pyd.StrictStr]

Source code in src/omnipy/components/raw/models.py 
86
87
class StrictStrModel(Model[pyd.StrictStr]):
    ...