genetic_forensic_portal.app.client.models package

Contains the models for the client side of the application.

These models are used to represent data that is retrieved from the genetic forensic portal API, and holds them in standardized Python objects that can be used by the rest of the application.

Models: - analysis_permissions: Contains the models for the permissions that can be assigned to users and groups for a given analysis and action. - analysis_status: Contains the model for the lifecycle status of an analysis. - get_analyses_response: Contains the model for the response from the genetic forensic portal API when retrieving all analyses for a sample. - list_analyses_response: Contains the model for the response from the genetic forensic portal API when listing analyses.

Submodules

genetic_forensic_portal.app.client.models.analysis_permissions module

Contains the models for the permissions that can be assigned to users and groups for a given analysis and action.

class genetic_forensic_portal.app.client.models.analysis_permissions.Action(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: StrEnum

The actions that can be performed on an analysis.

CREATE = 'CREATE'
DOWNLOAD = 'DOWNLOAD'
LIST_ALL = 'LIST_ALL'
VIEW = 'VIEW'
class genetic_forensic_portal.app.client.models.analysis_permissions.AnalysisPermissions(analysis_owner, owner_type, role_permissions=None, user_permissions=None)

Bases: object

The permissions that can be assigned to users and groups for a given analysis.

Parameters:
class genetic_forensic_portal.app.client.models.analysis_permissions.Effect(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: StrEnum

The effect of a permission. Can be ALLOW or DENY.

ALLOW = 'ALLOW'
DENY = 'DENY'
class genetic_forensic_portal.app.client.models.analysis_permissions.EntityType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: StrEnum

The type of entity that owns the analysis. Can be GROUP or USER.

GROUP = 'GROUP'
USER = 'USER'
class genetic_forensic_portal.app.client.models.analysis_permissions.Permission(entity, effect, actions)

Bases: object

A permission that can be assigned to a user or group for a given action.

Parameters:

genetic_forensic_portal.app.client.models.analysis_status module

class genetic_forensic_portal.app.client.models.analysis_status.AnalysisStatus(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: StrEnum

The model for the lifecycle status of an analysis.

Also includes some additional logic to allow statuses to be ordered.

The imposed order is: - ANALYSIS_SUCCEEDED - ANALYSIS_IN_PROGRESS - ANALYSIS_FAILED - ANALYSIS_NOT_FOUND - ANALYSIS_ERROR

ANALYSIS_ERROR = 'ERROR'
ANALYSIS_FAILED = 'Analysis failed'
ANALYSIS_IN_PROGRESS = 'Analysis in progress'
ANALYSIS_NOT_FOUND = 'NOT FOUND'
ANALYSIS_SUCCEEDED = 'Analysis succeeded'

genetic_forensic_portal.app.client.models.get_analyses_response module

class genetic_forensic_portal.app.client.models.get_analyses_response.GetAnalysesResponse(scat=None, voronoi=None, familial=None)

Bases: object

The model for the response from the genetic forensic portal API when retrieving all analyses for a sample.

Attributes: - scat: The SCAT analysis for the sample. - voronoi: The Voronoi analysis for the sample. - familial: The familial analysis for the sample.

Parameters:

genetic_forensic_portal.app.client.models.list_analyses_response module

class genetic_forensic_portal.app.client.models.list_analyses_response.ListAnalysesResponse(analyses, start_token=0, next_token=None)

Bases: object

The model for the response from the genetic forensic portal API when listing analyses.

Attributes: - analyses: The list of analyses that were retrieved. - start_token: The token that was used to get this page of results. - next_token: The token to use to get the next page of results.

Parameters: