wotpy.wot.dictionaries.schema¶
Wrapper classes for data schema dictionaries defined in the Scripting API.
Classes
ArraySchemaDict(*args, **kwargs) |
Properties to describe an array type. |
BooleanSchemaDict(*args, **kwargs) |
Properties to describe a boolean type. |
DataSchemaDict(*args, **kwargs) |
Represents the common properties of a value type definition. |
IntegerSchema(*args, **kwargs) |
Properties to describe an integer type. |
NumberSchemaDict(*args, **kwargs) |
Properties to describe a numeric type. |
ObjectSchemaDict(*args, **kwargs) |
Properties to describe an object type. |
StringSchemaDict(*args, **kwargs) |
Properties to describe a string type. |
-
class
wotpy.wot.dictionaries.schema.ArraySchemaDict(*args, **kwargs)¶ Bases:
wotpy.wot.dictionaries.schema.DataSchemaDictProperties to describe an array type.
-
class
Meta¶ Bases:
object-
defaults= {'readOnly': False, 'writeOnly': False}¶
-
fields= {'const', 'description', 'enum', 'items', 'maxItems', 'minItems', 'readOnly', 'title', 'type', 'unit', 'writeOnly'}¶
-
-
items¶ Used to define the characteristics of an array.
-
type¶ The type property represents the value type enumerated in DataType.
-
class
-
class
wotpy.wot.dictionaries.schema.BooleanSchemaDict(*args, **kwargs)¶ Bases:
wotpy.wot.dictionaries.schema.DataSchemaDictProperties to describe a boolean type.
-
type¶ The type property represents the value type enumerated in DataType.
-
-
class
wotpy.wot.dictionaries.schema.DataSchemaDict(*args, **kwargs)¶ Bases:
wotpy.wot.dictionaries.base.WotBaseDictRepresents the common properties of a value type definition.
-
class
Meta¶ Bases:
object-
defaults= {'readOnly': False, 'writeOnly': False}¶
-
fields= {'const', 'description', 'enum', 'readOnly', 'title', 'type', 'unit', 'writeOnly'}¶
-
-
classmethod
build(*args, **kwargs)¶ Builds an instance of the appropriate subclass for the given ValueType.
-
class
-
class
wotpy.wot.dictionaries.schema.IntegerSchema(*args, **kwargs)¶ Bases:
wotpy.wot.dictionaries.schema.NumberSchemaDictProperties to describe an integer type.
-
type¶ The type property represents the value type enumerated in DataType.
-
-
class
wotpy.wot.dictionaries.schema.NumberSchemaDict(*args, **kwargs)¶ Bases:
wotpy.wot.dictionaries.schema.DataSchemaDictProperties to describe a numeric type.
-
class
Meta¶ Bases:
object-
defaults= {'readOnly': False, 'writeOnly': False}¶
-
fields= {'const', 'description', 'enum', 'maximum', 'minimum', 'readOnly', 'title', 'type', 'unit', 'writeOnly'}¶
-
-
type¶ The type property represents the value type (a member of DataType).
-
class
-
class
wotpy.wot.dictionaries.schema.ObjectSchemaDict(*args, **kwargs)¶ Bases:
wotpy.wot.dictionaries.schema.DataSchemaDictProperties to describe an object type.
-
class
Meta¶ Bases:
object-
defaults= {'readOnly': False, 'writeOnly': False}¶
-
fields= {'const', 'description', 'enum', 'properties', 'readOnly', 'required', 'title', 'type', 'unit', 'writeOnly'}¶
-
-
properties¶ Data schema nested definitions.
-
type¶ The type property represents the value type enumerated in DataType.
-
class
-
class
wotpy.wot.dictionaries.schema.StringSchemaDict(*args, **kwargs)¶ Bases:
wotpy.wot.dictionaries.schema.DataSchemaDictProperties to describe a string type.
-
type¶ The type property represents the value type enumerated in DataType.
-