citric.objects

Python classes associated with LimeSurvey objects (surveys, questions, etc.).

Classes

Participant	Participant data.
AnswerOption	A single answer option for a list or dropdown question.
Question	A LimeSurvey question that can export itself as an LSQ file.
QuestionL10n	Localization data for a question in one language.

Functions

to_yes_no(*, value)

Convert boolean to yes/no string.

Package Contents

class citric.objects.Participant

Participant data.

firstname: str

lastname: str

email: str

participant_id: uuid.UUID | None = None

language: str | None = 'en'

blacklisted: bool = False

attributes: dict[str, Any]

to_dict()

Convert to dictionary.

Returns:

Dictionary representation of participant.

Return type:

dict[str, Any]

citric.objects.to_yes_no(*, value)

Convert boolean to yes/no string.

class citric.objects.AnswerOption

A single answer option for a list or dropdown question.

code: str

l10ns: dict[str, str]

sort_order: int = 0

assessment_value: int = 0

scale_id: int = 0

class citric.objects.Question

A LimeSurvey question that can export itself as an LSQ file.

Added in version NEXT_VERSION.

title: str

type: str

l10ns: dict[str, QuestionL10n]

mandatory: bool = False

other: bool = False

encrypted: bool = False

relevance: str = '1'

scale_id: int = 0

preg: str | None = None

attributes: dict[str, str]

subquestions: list[Question] = []

answer_options: list[AnswerOption] = []

to_lsq(*, db_version=DEFAULT_DB_VERSION)

Generate an LSQ XML stream for use with client.import_question().

Parameters:

db_version (int) – The database version to set in the generated LSQ.

Returns:

A BytesIO object containing the LSQ-format XML.

Return type:

io.BytesIO

class citric.objects.QuestionL10n

Localization data for a question in one language.

question: str = ''

help: str = ''

script: str = ''