surveydata.surveyctoexportstorage module

Read-only support for SurveyCTO survey data exports.

class surveydata.surveyctoexportstorage.SurveyCTOExportStorage(export_file: str, attachments_available: bool, data_timezone: Optional[timezone] = None)

Bases: StorageSystem

Implementation of storage interface for read-only access to SurveyCTO survey data exports.

__init__(export_file: str, attachments_available: bool, data_timezone: Optional[timezone] = None)

Initialize SurveyCTO export data.

Parameters:

  • export_file (str) – Path to the export file

  • attachments_available (bool) – True if attachments available from SurveyCTO Desktop (in media subfolder)

  • data_timezone (datetime.timezone) – Timezone for timestamps in the data (defaults to current timezone if not specified)

attachments_supported() → bool

Query whether storage system supports attachments.

Returns:

True if attachments supported, otherwise False

Return type:

bool

get_attachment(attachment_location: str = '', submission_id: str = '', attachment_name: str = '') → BinaryIO

Get submission attachment from storage.

Parameters:

  • attachment_location (str) – Attachment location string (as exported by SurveyCTO Desktop)

  • submission_id (str) – Unique submission ID (in lieu of attachment_location)

  • attachment_name (str) – Attachment filename (in lieu of attachment_location)

Returns:

Attachment as file-like object

Return type:

BinaryIO

Must pass either attachment_location or both submission_id and attachment_name.

get_data_timezone() → timezone

Get the timezone for timestamps in the data.

Returns:

Timezone for timestamps in the data (defaults to datetime.timezone.utc if unknown)

Return type:

datetime.timezone

get_metadata(metadata_id: str) → str

Get metadata string from storage.

Parameters:

metadata_id (str) – Unique metadata ID (should begin and end with __ and not conflict with any submission ID)

Returns:

Metadata string from storage, or empty string if no such metadata exists

Return type:

str

get_metadata_binary(metadata_id: str) → bytes

Get metadata bytes from storage.

Parameters:

metadata_id (str) – Unique metadata ID (should not conflict with any submission ID)

Returns:

Metadata bytes from storage, or empty bytes array if no such metadata exists

Return type:

bytes

get_submission(submission_id: str) → dict

Get submission data from storage.

Parameters:

submission_id (str) – Unique submission ID

Returns:

Submission data (or empty dictionary if submission not found)

Return type:

dict

get_submissions() → list

Get all submission data from storage.

Returns:

List of dictionaries, one for each submission

Return type:

list

list_attachments(submission_id: str = '') → list

List all attachments currently in storage.

Parameters:

submission_id (str) – Optional submission ID, to list only attachments for specific submission

Returns:

List of attachments, each as dict with name, submission_id, and location_string

Return type:

list

list_submissions() → list

List all submissions currently in storage.

Returns:

List of submission IDs

Return type:

list

query_attachment(attachment_location: str = '', submission_id: str = '', attachment_name: str = '') → bool

Query whether specific submission attachment exists in storage.

Parameters:

  • attachment_location (str) – Attachment location string (as exported by SurveyCTO Desktop)

  • submission_id (str) – Unique submission ID (in lieu of attachment_location)

  • attachment_name (str) – Attachment filename (in lieu of attachment_location)

Returns:

True if submission exists in storage; otherwise False

Return type:

bool

Must pass either attachment_location or both submission_id and attachment_name.

query_submission(submission_id: str) → bool

Query whether specific submission exists in storage.

Parameters:

submission_id (str) – Unique submission ID

Returns:

True if submission exists in storage; otherwise False

Return type:

bool

set_data_timezone(tz: timezone)

Set the timezone for timestamps in the data.

Parameters:

tz (datetime.timezone) – Timezone for timestamps in the data

store_attachment(submission_id: str, attachment_name: str, attachment_data: BinaryIO) → str

Store submission attachment in storage.

Parameters:

  • submission_id (str) – Unique submission ID

  • attachment_name (str) – Attachment filename

  • attachment_data (BinaryIO) – File-type object containing the attachment data

Returns:

Location string for stored attachment

Return type:

str

store_metadata(metadata_id: str, metadata: str)

Store metadata string in storage.

Parameters:

  • metadata_id (str) – Unique metadata ID (should begin and end with __ and not conflict with any submission ID)

  • metadata (str) – Metadata string to store

store_metadata_binary(metadata_id: str, metadata: bytes)

Store metadata bytes in storage.

Parameters:

  • metadata_id (str) – Unique metadata ID (should begin and end with __ and not conflict with any submission ID)

  • metadata (bytes) – Metadata bytes to store

store_submission(submission_id: str, submission_data: dict)

Store submission data in storage.

Parameters:

  • submission_id (str) – Unique submission ID

  • submission_data (dict) – Submission data to store