4.1.1.1. datanator.api package

4.1.1.1.1. Subpackages

4.1.1.1.2. Submodules

4.1.1.1.3. datanator.api.serializer module

class datanator.api.serializer.CellCompartmentSerializer(*args, **kwargs)[source]

Bases: flask_marshmallow.sqla.ModelSchema

class Meta[source]

Bases: object

exclude = ['search_vector', '_metadata', 'reaction'][source]
model[source]

alias of datanator.core.models.CellCompartment

sqla_session = <sqlalchemy.orm.scoping.scoped_session object>[source]
opts = <flask_marshmallow.sqla.SchemaOpts object>[source]
class datanator.api.serializer.EntityInteractionOrPropertySerializer(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)[source]

Bases: flask_marshmallow.schema.Schema

class Meta[source]

Bases: object

fields = ['id', 'name', 'cross_references'][source]
opts = <marshmallow.schema.SchemaOpts object>[source]
class datanator.api.serializer.EnvironmentSerializer(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)[source]

Bases: flask_marshmallow.schema.Schema

class Meta[source]

Bases: object

fields = ['temperature', 'ph', 'media', 'growth_status', 'growth_system'][source]
opts = <marshmallow.schema.SchemaOpts object>[source]
class datanator.api.serializer.GeneticsSerializer(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)[source]

Bases: flask_marshmallow.schema.Schema

class Meta[source]

Bases: object

fields = ['taxon', 'variation'][source]
opts = <marshmallow.schema.SchemaOpts object>[source]
class datanator.api.serializer.InteractionSerializer(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)[source]

Bases: datanator.api.serializer.EntityInteractionOrPropertySerializer

class Meta(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)[source]

Bases: datanator.api.serializer.EntityInteractionOrPropertySerializer

fields = ['id', 'name', 'cross_references', 'position', 'score', 'confidence'][source]
opts = <marshmallow.schema.SchemaOpts object>[source]
opts = <marshmallow.schema.SchemaOpts object>[source]
class datanator.api.serializer.MetaboliteSerializer(*args, **kwargs)[source]

Bases: flask_marshmallow.sqla.ModelSchema

class Meta[source]

Bases: object

exclude = ['simple_search_vector', 'complex_search_vector', 'parameter', 'reaction', '_is_name_ambiguous', 'concentration'][source]
model[source]

alias of datanator.core.models.Metabolite

sqla_session = <sqlalchemy.orm.scoping.scoped_session object>[source]
opts = <flask_marshmallow.sqla.SchemaOpts object>[source]
class datanator.api.serializer.MetadataSerializer(*args, **kwargs)[source]

Bases: flask_marshmallow.sqla.ModelSchema

class Meta[source]

Bases: object

fields = ['cell_compartment', 'taxon'][source]
model[source]

alias of datanator.core.models.Metadata

sqla_session = <sqlalchemy.orm.scoping.scoped_session object>[source]
opts = <flask_marshmallow.sqla.SchemaOpts object>[source]
class datanator.api.serializer.ObservableSerializer(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)[source]

Bases: flask_marshmallow.schema.Schema

class Meta[source]

Bases: object

fields = ['property', 'interaction', 'specie'][source]
opts = <marshmallow.schema.SchemaOpts object>[source]
class datanator.api.serializer.ObservedComplexSpecieSerializer(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)[source]

Bases: datanator.api.serializer.ObservedResultSerializer

class Meta(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)[source]

Bases: datanator.api.serializer.ObservedResultSerializer

fields = ['metadata', 'specie'][source]
opts = <marshmallow.schema.SchemaOpts object>[source]
opts = <marshmallow.schema.SchemaOpts object>[source]
class datanator.api.serializer.ObservedInteractionSerializer(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)[source]

Bases: datanator.api.serializer.ObservedResultSerializer

class Meta(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)[source]

Bases: datanator.api.serializer.ObservedResultSerializer

fields = ['metadata', 'interaction'][source]
opts = <marshmallow.schema.SchemaOpts object>[source]
opts = <marshmallow.schema.SchemaOpts object>[source]
class datanator.api.serializer.ObservedProteinSpecieSerializer(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)[source]

Bases: datanator.api.serializer.ObservedResultSerializer

class Meta(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)[source]

Bases: datanator.api.serializer.ObservedResultSerializer

fields = ['metadata', 'specie'][source]
opts = <marshmallow.schema.SchemaOpts object>[source]
opts = <marshmallow.schema.SchemaOpts object>[source]
class datanator.api.serializer.ObservedResultMetadataSerializer(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)[source]

Bases: flask_marshmallow.schema.Schema

class Meta[source]

Bases: object

fields = ['genetics', 'environment'][source]
opts = <marshmallow.schema.SchemaOpts object>[source]
class datanator.api.serializer.ObservedResultSerializer(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)[source]

Bases: flask_marshmallow.schema.Schema

class Meta[source]

Bases: object

fields = ['metadata'][source]
opts = <marshmallow.schema.SchemaOpts object>[source]
class datanator.api.serializer.ObservedSpecieSerializer(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)[source]

Bases: datanator.api.serializer.ObservedResultSerializer

class Meta(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)[source]

Bases: datanator.api.serializer.ObservedResultSerializer

fields = ['metadata', 'specie'][source]
opts = <marshmallow.schema.SchemaOpts object>[source]
opts = <marshmallow.schema.SchemaOpts object>[source]
class datanator.api.serializer.ObservedValueSerializer(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)[source]

Bases: datanator.api.serializer.ObservedResultSerializer

class Meta(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)[source]

Bases: datanator.api.serializer.ObservedResultSerializer

fields = ['metadata', 'observable', 'value', 'error', 'units'][source]
opts = <marshmallow.schema.SchemaOpts object>[source]
opts = <marshmallow.schema.SchemaOpts object>[source]
class datanator.api.serializer.PolymerSpecieSerializer(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)[source]

Bases: datanator.api.serializer.SpecieSerializer

class Meta[source]

Bases: object

fields = ['id', 'name', 'cross_references', 'structure', 'sequence'][source]
opts = <marshmallow.schema.SchemaOpts object>[source]
class datanator.api.serializer.ProteinComplexSerializer(*args, **kwargs)[source]

Bases: flask_marshmallow.sqla.ModelSchema

class Meta[source]

Bases: object

exclude = ['simple_search_vector'][source]
model[source]

alias of datanator.core.models.ProteinComplex

sqla_session = <sqlalchemy.orm.scoping.scoped_session object>[source]
opts = <flask_marshmallow.sqla.SchemaOpts object>[source]
class datanator.api.serializer.ProteinComplexSpecieSerializer(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)[source]

Bases: datanator.api.serializer.ProteinSpecieSerializer

class Meta[source]

Bases: object

fields = ['id', 'name', 'cross_references', 'structure', 'sequence', 'uniprot_id', 'entrez_id', 'gene_name', 'length', 'mass', 'go_id', 'go_dsc', 'funcat_id', 'funcat_dsc', 'su_cmt', 'complex_cmt', 'disease_cmt', 'class_name', 'family_name', 'molecular_weight'][source]
opts = <marshmallow.schema.SchemaOpts object>[source]
class datanator.api.serializer.ProteinSpecieSerializer(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)[source]

Bases: datanator.api.serializer.PolymerSpecieSerializer

class Meta[source]

Bases: object

fields = ['id', 'name', 'cross_references', 'structure', 'sequence', 'uniprot_id', 'entrez_id', 'gene_name', 'length', 'mass'][source]
opts = <marshmallow.schema.SchemaOpts object>[source]
class datanator.api.serializer.ProteinSubunitSerializer(*args, **kwargs)[source]

Bases: flask_marshmallow.sqla.ModelSchema

class Meta[source]

Bases: object

exclude = ['simple_search_vector', 'complex_search_vector'][source]
model[source]

alias of datanator.core.models.ProteinSubunit

sqla_session = <sqlalchemy.orm.scoping.scoped_session object>[source]
opts = <flask_marshmallow.sqla.SchemaOpts object>[source]
class datanator.api.serializer.ReactionParticipantSerializer(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)[source]

Bases: flask_marshmallow.schema.Schema

class Meta[source]

Bases: object

fields = ['specie', 'coefficient', 'order'][source]
opts = <marshmallow.schema.SchemaOpts object>[source]
class datanator.api.serializer.ReactionSerializer(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)[source]

Bases: datanator.api.serializer.InteractionSerializer

class Meta(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)[source]

Bases: datanator.api.serializer.InteractionSerializer

fields = ['id', 'name', 'cross_references', 'position', 'score', 'confidence', 'kinetic_law_id', 'reversible', 'participants'][source]
opts = <marshmallow.schema.SchemaOpts object>[source]
opts = <marshmallow.schema.SchemaOpts object>[source]
class datanator.api.serializer.ResourceSerializer(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)[source]

Bases: flask_marshmallow.schema.Schema

class Meta[source]

Bases: object

fields = ['namespace', 'id'][source]
opts = <marshmallow.schema.SchemaOpts object>[source]
class datanator.api.serializer.SpecieSerializer(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)[source]

Bases: datanator.api.serializer.EntityInteractionOrPropertySerializer

class Meta[source]

Bases: object

exclude = ['id'][source]
fields = ['id', 'name', 'cross_references', 'structure'][source]
opts = <marshmallow.schema.SchemaOpts object>[source]
class datanator.api.serializer.StructureSerializer(*args, **kwargs)[source]

Bases: flask_marshmallow.sqla.ModelSchema

class Meta[source]

Bases: object

exclude = ['metabolite', 'name', 'type'][source]
model[source]

alias of datanator.core.models.Structure

sqla_session = <sqlalchemy.orm.scoping.scoped_session object>[source]
opts = <flask_marshmallow.sqla.SchemaOpts object>[source]
class datanator.api.serializer.TaxonSerializer(*args, **kwargs)[source]

Bases: flask_marshmallow.sqla.ModelSchema

class Meta[source]

Bases: object

exclude = ['search_vector', '_metadata', '_experimentmetadata'][source]
model[source]

alias of datanator.core.models.Taxon

sqla_session = <sqlalchemy.orm.scoping.scoped_session object>[source]
opts = <flask_marshmallow.sqla.SchemaOpts object>[source]

4.1.1.1.4. datanator.api.urls module

datanator.api.urls.get_version_endpoint(endpoint)[source]

4.1.1.1.5. datanator.api.views module

Author:Saahith Pochiraju <saahith116@gmail.com>
Date:2018-08-13
Copyright:2018, Karr Lab
License:MIT
class datanator.api.views.Metabolite(api=None, *args, **kwargs)[source]

Bases: flask_restplus.resource.Resource

endpoint = 'metabolite'[source]
get(id)[source]
mediatypes()[source]
methods = {'GET'}[source]
class datanator.api.views.MetaboliteConcentration(api=None, *args, **kwargs)[source]

Bases: flask_restplus.resource.Resource

endpoint = 'metabolite_concentration'[source]
get(id)[source]
mediatypes()[source]
methods = {'GET'}[source]
class datanator.api.views.MetaboliteSearch(api=None, *args, **kwargs)[source]

Bases: flask_restplus.resource.Resource

endpoint = 'metabolite_search'[source]
get(value)[source]
mediatypes()[source]
methods = {'GET'}[source]
class datanator.api.views.ProteinAbundance(api=None, *args, **kwargs)[source]

Bases: flask_restplus.resource.Resource

endpoint = 'protein_abundance'[source]
get(id)[source]
mediatypes()[source]
methods = {'GET'}[source]
class datanator.api.views.ProteinComplex(api=None, *args, **kwargs)[source]

Bases: flask_restplus.resource.Resource

endpoint = 'protein_complex'[source]
get(id)[source]
mediatypes()[source]
methods = {'GET'}[source]
class datanator.api.views.ProteinComplexSearch(api=None, *args, **kwargs)[source]

Bases: flask_restplus.resource.Resource

endpoint = 'protein_complex_search'[source]
get(value)[source]
mediatypes()[source]
methods = {'GET'}[source]
class datanator.api.views.ProteinInteraction(api=None, *args, **kwargs)[source]

Bases: flask_restplus.resource.Resource

endpoint = 'protein_interaction'[source]
get(id)[source]
mediatypes()[source]
methods = {'GET'}[source]
class datanator.api.views.ProteinSubunit(api=None, *args, **kwargs)[source]

Bases: flask_restplus.resource.Resource

endpoint = 'protein_subunit'[source]
get(id)[source]
mediatypes()[source]
methods = {'GET'}[source]
class datanator.api.views.ProteinSubunitSearch(api=None, *args, **kwargs)[source]

Bases: flask_restplus.resource.Resource

endpoint = 'protein_subunit_search'[source]
get(value)[source]
mediatypes()[source]
methods = {'GET'}[source]
class datanator.api.views.Reaction(api=None, *args, **kwargs)[source]

Bases: flask_restplus.resource.Resource

endpoint = 'reaction'[source]
get(id)[source]
mediatypes()[source]
methods = {'GET'}[source]
class datanator.api.views.ReactionParameter(api=None, *args, **kwargs)[source]

Bases: flask_restplus.resource.Resource

endpoint = 'reaction_parameter'[source]
get(id)[source]
mediatypes()[source]
methods = {'GET'}[source]
class datanator.api.views.Search(api=None, *args, **kwargs)[source]

Bases: flask_restplus.resource.Resource

endpoint = 'search'[source]
get(value)[source]
mediatypes()[source]
methods = {'GET'}[source]
datanator.api.views.output_json(data, code, headers=None)[source]

4.1.1.1.6. Module contents