glare.objects.meta package

Submodules

glare.objects.meta.fields module

class glare.objects.meta.fields.BlobField(**kwargs)

Bases: oslo_versionedobjects.fields.AutoTypedField

AUTO_TYPE = <glare.objects.meta.fields.BlobFieldType object at 0x4681150>

class glare.objects.meta.fields.BlobFieldType

Bases: oslo_versionedobjects.fields.FieldType

Blob field contains reference to blob location.

ACTIVE = ‘active’

BLOB_SCHEMA = {‘required’: [‘url’, ‘size’, ‘md5’, ‘sha1’, ‘sha256’, ‘external’, ‘status’, ‘id’, ‘content_type’], ‘type’: ‘object’, ‘properties’: {‘status’: {‘enum’: [‘saving’, ‘active’], ‘type’: ‘string’}, ‘sha256’: {‘type’: [‘string’, ‘null’]}, ‘sha1’: {‘type’: [‘string’, ‘null’]}, ‘external’: {‘type’: ‘boolean’}, ‘content_type’: {‘type’: [‘string’, ‘null’]}, ‘url’: {‘maxLength’: 2048, ‘type’: [‘string’, ‘null’], ‘format’: ‘uri’}, ‘md5’: {‘type’: [‘string’, ‘null’]}, ‘id’: {‘type’: ‘string’}, ‘size’: {‘type’: [‘number’, ‘null’]}}}

BLOB_STATUS = (‘saving’, ‘active’)

SAVING = ‘saving’

static coerce(obj, field, value)

Validate and store blob info inside oslo.vo

static to_primitive(obj, field, value)

class glare.objects.meta.fields.Dict(element_type, **kwargs)

Bases: oslo_versionedobjects.fields.AutoTypedField

class glare.objects.meta.fields.Link(**kwargs)

Bases: oslo_versionedobjects.fields.AutoTypedField

AUTO_TYPE = <glare.objects.meta.fields.LinkFieldType object at 0x4681390>

class glare.objects.meta.fields.LinkFieldType

Bases: oslo_versionedobjects.fields.FieldType

Link field specifies Artifact dependency on other artifact or some external resource. From technical perspective it is just soft link to Glare Artifact or https/http resource. So Artifact users can download the referenced file by that link.

static coerce(obj, field, value)

static get_type_name(link)

static is_external(link)

class glare.objects.meta.fields.List(element_type, **kwargs)

Bases: oslo_versionedobjects.fields.AutoTypedField

class glare.objects.meta.fields.Version

Bases: oslo_versionedobjects.fields.FieldType

static coerce(obj, field, value)

class glare.objects.meta.fields.VersionField(**kwargs)

Bases: oslo_versionedobjects.fields.AutoTypedField

AUTO_TYPE = <glare.objects.meta.fields.Version object at 0x4678ed0>

glare.objects.meta.file_utils module

Contains additional file utils that may be useful for upload hooks.

glare.objects.meta.file_utils.create_temporary_file(stream, suffix=”)

Create a temporary local file from a stream.

Parameters:

• stream – stream of bytes to be stored in a temporary file
• suffix – (optional) file name suffix

glare.objects.meta.file_utils.extract_zip_to_temporary_folder(tfile)

Create temporary folder and extract all file contents there.

Parameters:tfile – zip archive to be extracted

glare.objects.meta.file_utils.unpack_zip_archive_to_artifact_folder(context, af, zip_ref, folder_name)

Unpack zip archive to artifact folder.

Parameters:

• context – user context
• af – artifact object
• zip_ref – zip archive to be extracted
• folder_name – name of the artifact folder where to extract data

glare.objects.meta.file_utils.upload_content_file(context, af, data, blob_dict, key_name, content_type=’application/octet-stream’)

Upload a file to a blob dictionary.

Parameters:

• context – user context
• af – artifact object
• data – bytes that need to be stored in the blob dictionary
• blob_dict – name of the blob_dictionary field
• key_name – name of key in the dictionary
• content_type – (optional) specifies mime type of uploading data

glare.objects.meta.registry module

class glare.objects.meta.registry.ArtifactRegistry

Bases: oslo_versionedobjects.base.VersionedObjectRegistry

Artifact Registry is responsible for registration of artifacts and returning appropriate artifact types based on artifact type name.

classmethod get_artifact_type(type_name)

Return artifact type based on artifact type name.

Parameters:type_name – name of artifact type Returns:artifact class

classmethod register_all_artifacts()

Register all artifacts in Glare.

classmethod reset_registry()

Resets all registered artifact type classes.

glare.objects.meta.registry.get_subclasses(module, base_class)

glare.objects.meta.registry.import_modules_list(modules)

glare.objects.meta.registry.import_submodules(module)

Import all submodules of a module.

Parameters:module – Package name Returns:list of imported modules

glare.objects.meta.validators module

class glare.objects.meta.validators.AllowedDictKeys(allowed_keys)

Bases: glare.objects.meta.validators.Validator

static get_allowed_types()

to_jsonschema()

class glare.objects.meta.validators.AllowedValues(allowed_values)

Bases: glare.objects.meta.validators.Validator

static get_allowed_types()

to_jsonschema()

class glare.objects.meta.validators.DictElementValidator(validators)

Bases: glare.objects.meta.validators.ElementValidator

static get_allowed_types()

to_jsonschema()

class glare.objects.meta.validators.ElementValidator(validators)

Bases: glare.objects.meta.validators.Validator

class glare.objects.meta.validators.ForbiddenChars(forbidden_chars)

Bases: glare.objects.meta.validators.Validator

static get_allowed_types()

to_jsonschema()

class glare.objects.meta.validators.ListElementValidator(validators)

Bases: glare.objects.meta.validators.ElementValidator

static get_allowed_types()

to_jsonschema()

class glare.objects.meta.validators.MaxDictKeyLen(size)

Bases: glare.objects.meta.validators.SizeValidator

static get_allowed_types()

class glare.objects.meta.validators.MaxDictSize(size)

Bases: glare.objects.meta.validators.MaxSize

static get_allowed_types()

to_jsonschema()

class glare.objects.meta.validators.MaxListSize(size)

Bases: glare.objects.meta.validators.MaxSize

static get_allowed_types()

to_jsonschema()

class glare.objects.meta.validators.MaxNumberSize(size)

Bases: glare.objects.meta.validators.SizeValidator

static get_allowed_types()

to_jsonschema()

class glare.objects.meta.validators.MaxSize(size)

Bases: glare.objects.meta.validators.SizeValidator

class glare.objects.meta.validators.MaxStrLen(size)

Bases: glare.objects.meta.validators.SizeValidator

static get_allowed_types()

to_jsonschema()

class glare.objects.meta.validators.MinDictKeyLen(size)

Bases: glare.objects.meta.validators.SizeValidator

static get_allowed_types()

class glare.objects.meta.validators.MinDictSize(size)

Bases: glare.objects.meta.validators.MinSize

static get_allowed_types()

to_jsonschema()

class glare.objects.meta.validators.MinListSize(size)

Bases: glare.objects.meta.validators.MinSize

static get_allowed_types()

to_jsonschema()

class glare.objects.meta.validators.MinNumberSize(size)

Bases: glare.objects.meta.validators.SizeValidator

static get_allowed_types()

to_jsonschema()

class glare.objects.meta.validators.MinSize(size)

Bases: glare.objects.meta.validators.SizeValidator

class glare.objects.meta.validators.MinStrLen(size)

Bases: glare.objects.meta.validators.SizeValidator

static get_allowed_types()

to_jsonschema()

class glare.objects.meta.validators.Regex(pattern)

Bases: glare.objects.meta.validators.Validator

static get_allowed_types()

to_jsonschema()

class glare.objects.meta.validators.RequiredDictKeys(required_keys)

Bases: glare.objects.meta.validators.Validator

static get_allowed_types()

to_jsonschema()

class glare.objects.meta.validators.SizeValidator(size)

Bases: glare.objects.meta.validators.Validator

class glare.objects.meta.validators.UUID

Bases: glare.objects.meta.validators.Validator

static get_allowed_types()

to_jsonschema()

class glare.objects.meta.validators.Unique(convert_to_set=False)

Bases: glare.objects.meta.validators.Validator

static get_allowed_types()

to_jsonschema()

class glare.objects.meta.validators.Validator

Bases: object

Common interface for all validators.

check_type_allowed(field_type)

static get_allowed_types()

to_jsonschema()

class glare.objects.meta.validators.Version

Bases: glare.objects.meta.validators.Validator

static get_allowed_types()

to_jsonschema()

glare.objects.meta.wrappers module

This file contains classes that wrap nat

glare.objects.meta.wrappers.Attribute

alias of Field

glare.objects.meta.wrappers.BlobAttribute

alias of BlobField

glare.objects.meta.wrappers.BlobDictAttribute

alias of FolderField

class glare.objects.meta.wrappers.BlobField(max_blob_size=10485760, **kwargs)

Bases: glare.objects.meta.wrappers.Field

glare.objects.meta.wrappers.CompoundAttribute

alias of CompoundField

class glare.objects.meta.wrappers.CompoundField(field_class, element_type, element_validators=None, **kwargs)

Bases: glare.objects.meta.wrappers.Field

get_element_validators()

glare.objects.meta.wrappers.DictAttribute

alias of DictField

class glare.objects.meta.wrappers.DictField(element_type, max_size=255, **kwargs)

Bases: glare.objects.meta.wrappers.CompoundField

get_default_validators()

class glare.objects.meta.wrappers.Field(field_class, mutable=False, required_on_activate=True, system=False, validators=None, nullable=True, default=None, sortable=False, filter_ops=None, description=”)

Bases: object

static get_allowed_filter_ops(field)

get_default_validators()

get_field()

classmethod init(*args, **kwargs)

Fabric to build fields.

class glare.objects.meta.wrappers.FolderField(max_blob_size=10485760, max_folder_size=2673868800, **kwargs)

Bases: glare.objects.meta.wrappers.DictField

glare.objects.meta.wrappers.ListAttribute

alias of ListField

class glare.objects.meta.wrappers.ListField(element_type, max_size=255, **kwargs)

Bases: glare.objects.meta.wrappers.CompoundField

get_default_validators()

Module contents