presets package¶
-
class
presets.
PresetManager
(paths, strict=False)[source]¶ Bases:
object
PresetManager deals with presets loading, validating, storing
you can use it like this:
pm = PresetManager(["/path/to/presets/folder", "/another/path"])
-
MAX_DEPTH
= 5¶
-
Submodules¶
-
class
presets.presetManager.
Preset
(body)[source]¶ Bases:
presets.presetManager.Schema
A preset is a set of rules and properties denoting a class of object
- Example:
- A preset could be used to describe which properties an object that describe a book must have. (title, authors, etc)
-
fields
= {'allow_upload': {'default': True, 'required': False, 'type': <type 'bool'>}, 'description': {'default': '', 'required': False, 'type': <type 'basestring'>}, 'id': {'required': True, 'type': <type 'basestring'>, 'check': 'check_id'}, 'properties': {'required': True, 'type': <type 'list'>}}¶
-
class
presets.presetManager.
PresetManager
(paths, strict=False)[source]¶ Bases:
object
PresetManager deals with presets loading, validating, storing
you can use it like this:
pm = PresetManager(["/path/to/presets/folder", "/another/path"])
-
MAX_DEPTH
= 5¶
-
-
class
presets.presetManager.
Property
(body)[source]¶ Bases:
presets.presetManager.Schema
A propety describe the format of a peculiarity of a preset
-
fields
= {'values': {'required': 'required_values', 'type': <type 'list'>, 'check': 'check_values'}, 'required': {'default': False, 'required': False, 'type': <type 'bool'>}, 'type': {'default': 'string', 'required': False, 'type': <type 'basestring'>, 'check': 'check_type'}, 'id': {'required': True, 'type': <type 'basestring'>, 'check': 'check_id'}, 'description': {'default': '', 'required': False, 'type': <type 'basestring'>}}¶
-
types
= ['string', 'enum']¶ fields is used as in Preset class
-
-
class
presets.presetManager.
Schema
[source]¶ Bases:
object
Schema is the parent of all the classes that needs to verify a specific object structure.
- all child class in order to use schema validation must:
- describe the desired object schema using self.fields
- save input object in self.body
self.fields must be a dict, where keys match the relative self.body keys and values describe how relative self.body valuse must be.
Example:
self.fields = { 'description': { 'type': basestring, 'required': False, 'default': "" }, 'allow_upload': { 'type': bool, 'required': False, 'default': True } }
-
fields
= {}¶