backend.formats module

class backend.formats.Judge(*, name: SectionNames, suggestions: str)

Bases: BaseModel

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

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

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'name': FieldInfo(annotation=SectionNames, required=True, title='Section Name'), 'suggestions': FieldInfo(annotation=str, required=True, title='Suggestions for improvement', description="Leave empty if it's comments instead of suggestions.")}

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

This replaces Model.__fields__ from Pydantic V1.

name: SectionNames

suggestions: str

class backend.formats.Judges(*, judges: List[Judge])

Bases: BaseModel

judges: List[Judge]

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

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

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'judges': FieldInfo(annotation=List[Judge], required=True, title='Judges', description='Judges for the sections.')}

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

This replaces Model.__fields__ from Pydantic V1.

class backend.formats.RegulationRegions(value)

Bases: str, Enum

An enumeration.

AU = 'Australia'

BR = 'Brazil'

CA = 'Canada'

EU = 'European Union'

IN = 'India'

JP = 'Japan'

KR = 'South Korea'

OTHER = 'Other'

SG = 'Singapore'

UK = 'United Kingdom'

US = 'United States'

USCA = 'California'

ZA = 'South Africa'

class backend.formats.SectionContent(*, name: SectionNames, content: str)

Bases: BaseModel

content: str

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

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

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'content': FieldInfo(annotation=str, required=True, title='Section Content'), 'name': FieldInfo(annotation=SectionNames, required=True, title='Section Name')}

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

This replaces Model.__fields__ from Pydantic V1.

name: SectionNames

class backend.formats.SectionKeyPoints(*, name: SectionNames, key_points: List[str])

Bases: BaseModel

key_points: List[str]

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

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

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'key_points': FieldInfo(annotation=List[str], required=True, title='List of Key Points'), 'name': FieldInfo(annotation=SectionNames, required=True, title='Section Name')}

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

This replaces Model.__fields__ from Pydantic V1.

name: SectionNames

class backend.formats.SectionNames(value)

Bases: str, Enum

An enumeration.

SECTION1 = 'Introduction'

SECTION10 = 'Cookies and Tracking Technologies'

SECTION11 = 'Changes to the Privacy Policy'

SECTION12 = 'Contact Information'

SECTION2 = 'Data Controller Information'

SECTION3 = 'Data Collection and Usage'

SECTION4 = 'Data Subject Rights'

SECTION5 = 'Data Sharing and Transfers'

SECTION6 = 'Data Retention'

SECTION7 = 'Disclosure of Personal Information'

SECTION8 = 'Security Measures'

SECTION9 = 'Automated Decision-Making and Profiling'

class backend.formats.SelectedRegions(*, regions: List[RegulationRegions])

Bases: BaseModel

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

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

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'regions': FieldInfo(annotation=List[RegulationRegions], required=True, title='List of Selected Regions', description='List of selected regions. Note that some regions could be mutually inclusive.')}

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

This replaces Model.__fields__ from Pydantic V1.

regions: List[RegulationRegions]

class backend.formats.Syllabus(*, sections: Annotated[List[SectionKeyPoints], Len(min_length=12, max_length=12)])

Bases: BaseModel

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

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

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'sections': FieldInfo(annotation=List[SectionKeyPoints], required=True, title='List of Sections', metadata=[Len(min_length=12, max_length=12)])}

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

This replaces Model.__fields__ from Pydantic V1.

sections: Annotated[List[SectionKeyPoints], Len(min_length=12, max_length=12)]