bhf_smarthealth.validate.qualtrics_schema

bhf_smarthealth.validate.qualtrics_schema#

Attributes#

`logger`
`CustomDate`
`CustomDatetime`

Classes#

`BaseQuestionsRow`	!!! abstract "Usage Documentation"
`BridgeFileRow`	!!! abstract "Usage Documentation"
`BridgeFileTable`	!!! abstract "Usage Documentation"
`BaseQuestionsTable`	!!! abstract "Usage Documentation"
`QualtricsStreamSchema`	!!! abstract "Usage Documentation"

Functions#

`parse_custom_datetime`(→ datetime.datetime)
`parse_custom_date`(→ datetime.date)

Module Contents#

bhf_smarthealth.validate.qualtrics_schema.logger#

bhf_smarthealth.validate.qualtrics_schema.parse_custom_datetime(value: str) → datetime.datetime[source]#

bhf_smarthealth.validate.qualtrics_schema.parse_custom_date(value: str) → datetime.date[source]#

bhf_smarthealth.validate.qualtrics_schema.CustomDate#

bhf_smarthealth.validate.qualtrics_schema.CustomDatetime#

class bhf_smarthealth.validate.qualtrics_schema.BaseQuestionsRow(/, **data: Any)[source]#

Bases: pydantic.BaseModel

!!! abstract “Usage Documentation”: [Models](../concepts/models.md)

A base class for creating Pydantic models.

__class_vars__#: The names of the class variables defined on the model.

__private_attributes__#: Metadata about the private attributes of the model.

__signature__#: The synthesized __init__ [Signature][inspect.Signature] of the model.

__pydantic_complete__#: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__#: The core schema of the model.

__pydantic_custom_init__#: Whether the model has a custom __init__ function.

__pydantic_decorators__#: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_generic_metadata__#: Metadata for generic models; contains data used for a similar purpose to __args__, __origin__, __parameters__ in typing-module generics. May eventually be replaced by these.

__pydantic_parent_namespace__#: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__#: The name of the post-init method for the model, if defined.

__pydantic_root_model__#: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__#: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__#: The pydantic-core SchemaValidator used to validate instances of the model.

__pydantic_fields__#: A dictionary of field names and their corresponding [FieldInfo][pydantic.fields.FieldInfo] objects.

__pydantic_computed_fields__#: A dictionary of computed field names and their corresponding [ComputedFieldInfo][pydantic.fields.ComputedFieldInfo] objects.

__pydantic_extra__#: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to ‘allow’.

__pydantic_fields_set__#: The names of fields explicitly set during instantiation.

__pydantic_private__#: Values of private attributes set on the model instance.

model_config#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

duration_secs: int = None#

record_date: CustomDatetime = None#

sheffield_id: str = None#

sig_date: CustomDate = None#

sex: str = None#

gender: str = None#

gender_free_text: str | None = None#

recruited_from_NHS: str | None = None#

recruited_from_NHS_site: str | None = None#

recruited_from_NHS_site_free_text: str | None = None#

first_heard_choice: str | None = None#

first_heard_other_study_free_text: str | None = None#

first_heard_free_text: str | None = None#

comm_groups_choice: str | None = None#

com_groups_free_text: str | None = None#

has_wearable: str = None#

wearable_list: str | None | list[str] | None = None#

dom_hand: str | None = None#

wrist: str | None = None#

gps_consent: bool = None#

home_lsoa: str = None#

qr_source: str | None = None#

age: int = None#

class bhf_smarthealth.validate.qualtrics_schema.BridgeFileRow(/, **data: Any)[source]#

Bases: pydantic.BaseModel

!!! abstract “Usage Documentation”: [Models](../concepts/models.md)

A base class for creating Pydantic models.

__class_vars__#: The names of the class variables defined on the model.

__private_attributes__#: Metadata about the private attributes of the model.

__signature__#: The synthesized __init__ [Signature][inspect.Signature] of the model.

__pydantic_complete__#: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__#: The core schema of the model.

__pydantic_custom_init__#: Whether the model has a custom __init__ function.

__pydantic_decorators__#: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_generic_metadata__#: Metadata for generic models; contains data used for a similar purpose to __args__, __origin__, __parameters__ in typing-module generics. May eventually be replaced by these.

__pydantic_parent_namespace__#: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__#: The name of the post-init method for the model, if defined.

__pydantic_root_model__#: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__#: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__#: The pydantic-core SchemaValidator used to validate instances of the model.

__pydantic_fields__#: A dictionary of field names and their corresponding [FieldInfo][pydantic.fields.FieldInfo] objects.

__pydantic_computed_fields__#: A dictionary of computed field names and their corresponding [ComputedFieldInfo][pydantic.fields.ComputedFieldInfo] objects.

__pydantic_extra__#: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to ‘allow’.

__pydantic_fields_set__#: The names of fields explicitly set during instantiation.

__pydantic_private__#: Values of private attributes set on the model instance.

model_config#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

sheffield_id: str = None#

patient_id_smarthealth: str#

class bhf_smarthealth.validate.qualtrics_schema.BridgeFileTable(/, root=PydanticUndefined, **data)[source]#

Bases: pydantic.RootModel

!!! abstract “Usage Documentation”: [RootModel and Custom Root Types](../concepts/models.md#rootmodel-and-custom-root-types)

A Pydantic BaseModel for the root object of the model.

root#: The root object of the model.

__pydantic_root_model__#: Whether the model is a RootModel.

__pydantic_private__#: Private fields in the model.

__pydantic_extra__#: Extra fields in the model.

root: list[BridgeFileRow]#

class bhf_smarthealth.validate.qualtrics_schema.BaseQuestionsTable(/, root=PydanticUndefined, **data)[source]#

Bases: pydantic.RootModel

!!! abstract “Usage Documentation”: [RootModel and Custom Root Types](../concepts/models.md#rootmodel-and-custom-root-types)

A Pydantic BaseModel for the root object of the model.

root#: The root object of the model.

__pydantic_root_model__#: Whether the model is a RootModel.

__pydantic_private__#: Private fields in the model.

__pydantic_extra__#: Extra fields in the model.

root: list[BaseQuestionsRow]#

class bhf_smarthealth.validate.qualtrics_schema.QualtricsStreamSchema(/, **data: Any)[source]#

Bases: pydantic.BaseModel

!!! abstract “Usage Documentation”: [Models](../concepts/models.md)

A base class for creating Pydantic models.

__class_vars__#: The names of the class variables defined on the model.

__private_attributes__#: Metadata about the private attributes of the model.

__signature__#: The synthesized __init__ [Signature][inspect.Signature] of the model.

__pydantic_complete__#: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__#: The core schema of the model.

__pydantic_custom_init__#: Whether the model has a custom __init__ function.

__pydantic_decorators__#: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_generic_metadata__#: Metadata for generic models; contains data used for a similar purpose to __args__, __origin__, __parameters__ in typing-module generics. May eventually be replaced by these.

__pydantic_parent_namespace__#: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__#: The name of the post-init method for the model, if defined.

__pydantic_root_model__#: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__#: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__#: The pydantic-core SchemaValidator used to validate instances of the model.

__pydantic_fields__#: A dictionary of field names and their corresponding [FieldInfo][pydantic.fields.FieldInfo] objects.

__pydantic_computed_fields__#: A dictionary of computed field names and their corresponding [ComputedFieldInfo][pydantic.fields.ComputedFieldInfo] objects.

__pydantic_extra__#: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to ‘allow’.

__pydantic_fields_set__#: The names of fields explicitly set during instantiation.

__pydantic_private__#: Values of private attributes set on the model instance.

model_config#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

base_questions: BaseQuestionsTable#

bridge_file: BridgeFileTable#

check_participant_ids_match() → Self[source]#

bhf_smarthealth.validate.qualtrics_schema

On this page

bhf_smarthealth.validate.qualtrics_schema#

Attributes#

Classes#

Functions#

Module Contents#