Skip to content

Latest commit

 

History

History
69 lines (57 loc) · 3.86 KB

forbidden_property.md

File metadata and controls

69 lines (57 loc) · 3.86 KB
Raw

ForbiddenProperty

unit_test_api.components.schema.forbidden_property

type: schemas.Schema

validate method

Input Type Return Type Notes
ForbiddenPropertyDictInput, ForbiddenPropertyDict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader ForbiddenPropertyDict, str, float, int, bool, None, tuple, bytes, io.FileIO

ForbiddenPropertyDictInput

type: typing.Mapping[str, schemas.INPUT_TYPES_ALL]
Key Type Description Notes
foo dict, schemas.immutabledict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader [optional]
any_string_name dict, schemas.immutabledict, list, tuple, decimal.Decimal, float, int, str, datetime.date, datetime.datetime, uuid.UUID, bool, None, bytes, io.FileIO, io.BufferedReader, schemas.FileIO any string name can be used but the value must be the correct type [optional]

ForbiddenPropertyDict

base class: schemas.immutabledict[str, schemas.OUTPUT_BASE_TYPES]

__new__ method

Keyword Argument Type Description Notes
foo dict, schemas.immutabledict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, schemas.Unset [optional]
kwargs schemas.immutabledict, tuple, float, int, str, bool, None, bytes, schemas.FileIO any string name can be used but the value must be the correct type [optional] typed value is accessed with the get_additional_property_ method

properties

Property Type Description Notes
foo schemas.immutabledict, str, float, int, bool, None, tuple, bytes, io.FileIO, schemas.Unset [optional]

methods

Method Input Type Return Type Notes
from_dict_ ForbiddenPropertyDictInput, ForbiddenPropertyDict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader ForbiddenPropertyDict, str, float, int, bool, None, tuple, bytes, io.FileIO a constructor
get_additional_property_ str schemas.immutabledict, tuple, float, int, str, bool, None, bytes, schemas.FileIO, schemas.Unset provides type safety for additional properties

Foo

type: schemas.Schema

validate method

Input Type Return Type Notes
dict, schemas.immutabledict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader schemas.immutabledict, str, float, int, bool, None, tuple, bytes, io.FileIO

Composed Schemas (allOf/anyOf/oneOf/not)

not

Schema Class Input Type Return Type
_Not dict, schemas.immutabledict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader schemas.immutabledict, str, float, int, bool, None, tuple, bytes, io.FileIO

_Not

type: schemas.Schema

validate method

Input Type Return Type Notes
dict, schemas.immutabledict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader schemas.immutabledict, str, float, int, bool, None, tuple, bytes, io.FileIO

[Back to top] [Back to Component Schemas] [Back to README]