iblrig.pydantic_definitions.RigSettings

class iblrig.pydantic_definitions.RigSettings

classmethod str_must_not_contain_space(v)

classmethod validate_remote_data_path(v)

ALYX_LAB: str | None

ALYX_URL: Url | None

ALYX_USER: str | None

iblrig_local_data_path: Path | None

iblrig_local_subjects_path: Annotated[Path, PathType(path_type=dir)] | None

iblrig_remote_data_path: Path | bool | None

iblrig_remote_subjects_path: Path | None

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'title': 'iblrig_settings.yaml', 'validate_assignment': True}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'ALYX_LAB': FieldInfo(annotation=Union[str, NoneType], required=True, description="Your lab's name as registered on the Alyx database"), 'ALYX_URL': FieldInfo(annotation=Union[Url, NoneType], required=True, title='Alyx URL', description='The URL to your Alyx database'), 'ALYX_USER': FieldInfo(annotation=Union[str, NoneType], required=True, description='Your Alyx username'), 'iblrig_local_data_path': FieldInfo(annotation=Union[Path, NoneType], required=True, title='IBLRIG local data path', description='The local folder IBLRIG should use for storing data'), 'iblrig_local_subjects_path': FieldInfo(annotation=Union[Annotated[Path, PathType], NoneType], required=False, default=None, title='IBLRIG full local data path', description='An optional full local data folder (including /Subjects)'), 'iblrig_remote_data_path': FieldInfo(annotation=Union[Path, bool, NoneType], required=True, title='IBLRIG remote data path', description='The remote folder IBLRIG should use for storing data'), 'iblrig_remote_subjects_path': FieldInfo(annotation=Union[Path, NoneType], required=False, default=None, title='IBLRIG full remote data path', description='An optional full remote data folder (including /Subjects)')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.