hyperstream.models package

Submodules

hyperstream.models.factor module

class hyperstream.models.factor.FactorDefinitionModel(*args, **kwargs)[source]

Bases: mongoengine.document.EmbeddedDocument

alignment_node

A unicode string field.

factor_type

A unicode string field.

output_plate

An embedded document field - with a declared document_type. Only valid values are subclasses of EmbeddedDocument.

sinks

A list field that wraps a standard field, allowing multiple instances of the field to be used as a list in the database.

If using with ReferenceFields see: one-to-many-with-listfields

Note

Required means it cannot be empty - as the default for ListFields is []

sources

A list field that wraps a standard field, allowing multiple instances of the field to be used as a list in the database.

If using with ReferenceFields see: one-to-many-with-listfields

Note

Required means it cannot be empty - as the default for ListFields is []

splitting_node

A unicode string field.

tool

An embedded document field - with a declared document_type. Only valid values are subclasses of EmbeddedDocument.

class hyperstream.models.factor.OutputPlateDefinitionModel(*args, **kwargs)[source]

Bases: mongoengine.document.EmbeddedDocument

description

A unicode string field.

meta_data_id

A unicode string field.

plate_id

A unicode string field.

use_provided_values

Boolean field type.

New in version 0.1.2.

hyperstream.models.meta_data module

class hyperstream.models.meta_data.MetaDataModel(*args, **values)[source]

Bases: mongoengine.document.Document

exception DoesNotExist

Bases: mongoengine.errors.DoesNotExist

exception MetaDataModel.MultipleObjectsReturned

Bases: mongoengine.errors.MultipleObjectsReturned

MetaDataModel.data

A unicode string field.

MetaDataModel.id

A field wrapper around MongoDB’s ObjectIds.

MetaDataModel.identifier
MetaDataModel.objects

The default QuerySet Manager.

Custom QuerySet Manager functions can extend this class and users can add extra queryset functionality. Any custom manager methods must accept a Document class as its first argument, and a QuerySet as its second argument.

The method function should return a QuerySet , probably the same one that was passed in, but modified in some way.

MetaDataModel.parent

A unicode string field.

MetaDataModel.tag

A unicode string field.

MetaDataModel.to_dict()[source]

hyperstream.models.node module

class hyperstream.models.node.NodeDefinitionModel(*args, **kwargs)[source]

Bases: mongoengine.document.EmbeddedDocument

channel_id

A unicode string field.

plate_ids

A list field that wraps a standard field, allowing multiple instances of the field to be used as a list in the database.

If using with ReferenceFields see: one-to-many-with-listfields

Note

Required means it cannot be empty - as the default for ListFields is []

stream_name

A unicode string field.

hyperstream.models.plate module

class hyperstream.models.plate.PlateDefinitionModel(*args, **values)[source]

Bases: mongoengine.document.Document

exception DoesNotExist

Bases: mongoengine.errors.DoesNotExist

exception PlateDefinitionModel.MultipleObjectsReturned

Bases: mongoengine.errors.MultipleObjectsReturned

PlateDefinitionModel.complement

Boolean field type.

New in version 0.1.2.

PlateDefinitionModel.description

A unicode string field.

PlateDefinitionModel.id

A field wrapper around MongoDB’s ObjectIds.

PlateDefinitionModel.meta_data_id

A unicode string field.

PlateDefinitionModel.objects

The default QuerySet Manager.

Custom QuerySet Manager functions can extend this class and users can add extra queryset functionality. Any custom manager methods must accept a Document class as its first argument, and a QuerySet as its second argument.

The method function should return a QuerySet , probably the same one that was passed in, but modified in some way.

PlateDefinitionModel.parent_plate

A unicode string field.

PlateDefinitionModel.plate_id

A unicode string field.

PlateDefinitionModel.values

A list field that wraps a standard field, allowing multiple instances of the field to be used as a list in the database.

If using with ReferenceFields see: one-to-many-with-listfields

Note

Required means it cannot be empty - as the default for ListFields is []

class hyperstream.models.plate.PlateModel(*args, **kwargs)[source]

Bases: mongoengine.document.EmbeddedDocument

complement

Boolean field type.

New in version 0.1.2.

meta_data_id

A unicode string field.

values

A list field that wraps a standard field, allowing multiple instances of the field to be used as a list in the database.

If using with ReferenceFields see: one-to-many-with-listfields

Note

Required means it cannot be empty - as the default for ListFields is []

hyperstream.models.stream module

class hyperstream.models.stream.StreamDefinitionModel(*args, **values)[source]

Bases: mongoengine.document.Document

exception DoesNotExist

Bases: mongoengine.errors.DoesNotExist

exception StreamDefinitionModel.MultipleObjectsReturned

Bases: mongoengine.errors.MultipleObjectsReturned

StreamDefinitionModel.calculated_intervals

A ListField designed specially to hold a list of embedded documents to provide additional query helpers.

Note

The only valid list values are subclasses of EmbeddedDocument.

New in version 0.9.

StreamDefinitionModel.channel_id

A unicode string field.

StreamDefinitionModel.get_calculated_intervals()[source]
StreamDefinitionModel.id

A field wrapper around MongoDB’s ObjectIds.

StreamDefinitionModel.last_accessed

Datetime field.

Uses the python-dateutil library if available alternatively use time.strptime to parse the dates. Note: python-dateutil’s parser is fully featured and when installed you can utilise it to convert varying types of date formats into valid python datetime objects.

Note: Microseconds are rounded to the nearest millisecond.
Pre UTC microsecond support is effectively broken. Use ComplexDateTimeField if you need accurate microsecond support.
StreamDefinitionModel.last_updated

Datetime field.

Uses the python-dateutil library if available alternatively use time.strptime to parse the dates. Note: python-dateutil’s parser is fully featured and when installed you can utilise it to convert varying types of date formats into valid python datetime objects.

Note: Microseconds are rounded to the nearest millisecond.
Pre UTC microsecond support is effectively broken. Use ComplexDateTimeField if you need accurate microsecond support.
StreamDefinitionModel.objects

The default QuerySet Manager.

Custom QuerySet Manager functions can extend this class and users can add extra queryset functionality. Any custom manager methods must accept a Document class as its first argument, and a QuerySet as its second argument.

The method function should return a QuerySet , probably the same one that was passed in, but modified in some way.

StreamDefinitionModel.sandbox

A unicode string field.

StreamDefinitionModel.set_calculated_intervals(intervals)[source]
StreamDefinitionModel.stream_id

An embedded document field - with a declared document_type. Only valid values are subclasses of EmbeddedDocument.

StreamDefinitionModel.stream_type

A unicode string field.

class hyperstream.models.stream.StreamIdField(*args, **kwargs)[source]

Bases: mongoengine.document.EmbeddedDocument

meta_data

A list field that wraps a standard field, allowing multiple instances of the field to be used as a list in the database.

If using with ReferenceFields see: one-to-many-with-listfields

Note

Required means it cannot be empty - as the default for ListFields is []

name

A unicode string field.

class hyperstream.models.stream.StreamInstanceModel(*args, **values)[source]

Bases: mongoengine.document.Document

exception DoesNotExist

Bases: mongoengine.errors.DoesNotExist

exception StreamInstanceModel.MultipleObjectsReturned

Bases: mongoengine.errors.MultipleObjectsReturned

StreamInstanceModel.datetime

Datetime field.

Uses the python-dateutil library if available alternatively use time.strptime to parse the dates. Note: python-dateutil’s parser is fully featured and when installed you can utilise it to convert varying types of date formats into valid python datetime objects.

Note: Microseconds are rounded to the nearest millisecond.
Pre UTC microsecond support is effectively broken. Use ComplexDateTimeField if you need accurate microsecond support.
StreamInstanceModel.id

A field wrapper around MongoDB’s ObjectIds.

StreamInstanceModel.objects

The default QuerySet Manager.

Custom QuerySet Manager functions can extend this class and users can add extra queryset functionality. Any custom manager methods must accept a Document class as its first argument, and a QuerySet as its second argument.

The method function should return a QuerySet , probably the same one that was passed in, but modified in some way.

StreamInstanceModel.stream_id

An embedded document field - with a declared document_type. Only valid values are subclasses of EmbeddedDocument.

StreamInstanceModel.stream_type

A unicode string field.

StreamInstanceModel.value

A truly dynamic field type capable of handling different and varying types of data.

Used by DynamicDocument to handle dynamic data

hyperstream.models.time_interval module

class hyperstream.models.time_interval.TimeIntervalModel(*args, **kwargs)[source]

Bases: mongoengine.document.EmbeddedDocument

end

Datetime field.

Uses the python-dateutil library if available alternatively use time.strptime to parse the dates. Note: python-dateutil’s parser is fully featured and when installed you can utilise it to convert varying types of date formats into valid python datetime objects.

Note: Microseconds are rounded to the nearest millisecond.
Pre UTC microsecond support is effectively broken. Use ComplexDateTimeField if you need accurate microsecond support.
start

Datetime field.

Uses the python-dateutil library if available alternatively use time.strptime to parse the dates. Note: python-dateutil’s parser is fully featured and when installed you can utilise it to convert varying types of date formats into valid python datetime objects.

Note: Microseconds are rounded to the nearest millisecond.
Pre UTC microsecond support is effectively broken. Use ComplexDateTimeField if you need accurate microsecond support.

hyperstream.models.tool module

class hyperstream.models.tool.ToolModel(*args, **kwargs)[source]

Bases: mongoengine.document.EmbeddedDocument

name

A unicode string field.

parameters

A ListField designed specially to hold a list of embedded documents to provide additional query helpers.

Note

The only valid list values are subclasses of EmbeddedDocument.

New in version 0.9.

version

A unicode string field.

class hyperstream.models.tool.ToolParameterModel(*args, **kwargs)[source]

Bases: mongoengine.document.EmbeddedDocument

is_function

Boolean field type.

New in version 0.1.2.

is_set

Boolean field type.

New in version 0.1.2.

key

A unicode string field.

value

A truly dynamic field type capable of handling different and varying types of data.

Used by DynamicDocument to handle dynamic data

hyperstream.models.workflow module

class hyperstream.models.workflow.WorkflowDefinitionModel(*args, **values)[source]

Bases: mongoengine.document.Document

exception DoesNotExist

Bases: mongoengine.errors.DoesNotExist

exception WorkflowDefinitionModel.MultipleObjectsReturned

Bases: mongoengine.errors.MultipleObjectsReturned

WorkflowDefinitionModel.description

A unicode string field.

WorkflowDefinitionModel.factors

A ListField designed specially to hold a list of embedded documents to provide additional query helpers.

Note

The only valid list values are subclasses of EmbeddedDocument.

New in version 0.9.

WorkflowDefinitionModel.id

A field wrapper around MongoDB’s ObjectIds.

WorkflowDefinitionModel.monitor

Boolean field type.

New in version 0.1.2.

WorkflowDefinitionModel.name

A unicode string field.

WorkflowDefinitionModel.nodes

A ListField designed specially to hold a list of embedded documents to provide additional query helpers.

Note

The only valid list values are subclasses of EmbeddedDocument.

New in version 0.9.

WorkflowDefinitionModel.objects

The default QuerySet Manager.

Custom QuerySet Manager functions can extend this class and users can add extra queryset functionality. Any custom manager methods must accept a Document class as its first argument, and a QuerySet as its second argument.

The method function should return a QuerySet , probably the same one that was passed in, but modified in some way.

WorkflowDefinitionModel.online

Boolean field type.

New in version 0.1.2.

WorkflowDefinitionModel.owner

A unicode string field.

WorkflowDefinitionModel.workflow_id

A unicode string field.

class hyperstream.models.workflow.WorkflowStatusModel(*args, **values)[source]

Bases: mongoengine.document.Document

exception DoesNotExist

Bases: mongoengine.errors.DoesNotExist

exception WorkflowStatusModel.MultipleObjectsReturned

Bases: mongoengine.errors.MultipleObjectsReturned

WorkflowStatusModel.id

A field wrapper around MongoDB’s ObjectIds.

WorkflowStatusModel.last_accessed

Datetime field.

Uses the python-dateutil library if available alternatively use time.strptime to parse the dates. Note: python-dateutil’s parser is fully featured and when installed you can utilise it to convert varying types of date formats into valid python datetime objects.

Note: Microseconds are rounded to the nearest millisecond.
Pre UTC microsecond support is effectively broken. Use ComplexDateTimeField if you need accurate microsecond support.
WorkflowStatusModel.last_updated

Datetime field.

Uses the python-dateutil library if available alternatively use time.strptime to parse the dates. Note: python-dateutil’s parser is fully featured and when installed you can utilise it to convert varying types of date formats into valid python datetime objects.

Note: Microseconds are rounded to the nearest millisecond.
Pre UTC microsecond support is effectively broken. Use ComplexDateTimeField if you need accurate microsecond support.
WorkflowStatusModel.objects

The default QuerySet Manager.

Custom QuerySet Manager functions can extend this class and users can add extra queryset functionality. Any custom manager methods must accept a Document class as its first argument, and a QuerySet as its second argument.

The method function should return a QuerySet , probably the same one that was passed in, but modified in some way.

WorkflowStatusModel.requested_intervals

A ListField designed specially to hold a list of embedded documents to provide additional query helpers.

Note

The only valid list values are subclasses of EmbeddedDocument.

New in version 0.9.

WorkflowStatusModel.workflow_id

A unicode string field.

Module contents