Skip to content

🦺 Add document_type to Document schema #121

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ollyhensby merged 2 commits into from
May 2, 2025
Merged

🦺 Add document_type to Document schema #121

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8b9b55c
🦺 Add document_type to Document schema
May 2, 2025
2ee9c61
💡 Comment out nzc enum value in DocumentTypeEnum
May 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 21 additions & 2 deletions packages/document-issue/src/document_issue/document.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@
from typing import Annotated

from annotated_types import Len
from pydantic import AliasChoices, Field, WithJsonSchema, field_validator
from pydantic import AliasChoices, Field, WithJsonSchema, field_validator, model_validator
from typing_extensions import Literal

from document_issue.basemodel import BaseModel
from document_issue.enums import DocSource, PaperSizeEnum, ScalesEnum
from document_issue.enums import DocSource, DocumentTypeEnum, PaperSizeEnum, ScalesEnum


class FormatConfiguration(BaseModel):
Expand Down Expand Up @@ -67,10 +67,17 @@ class DocumentBase(BaseModel):
examples=DocSource._member_names_,
alias="doc_source",
)
document_type: DocumentTypeEnum = Field(
DocumentTypeEnum.es,
description="type of document",
alias="doc_type",
title="Document Type",
)
paper_size: str | PaperSizeEnum = Field(
"A4",
description="paper size of the document",
alias="size",
json_schema_extra={"disabled": True},
)
scale: str | ScalesEnum = Field(
"nts",
Expand Down Expand Up @@ -111,6 +118,18 @@ def validate_name_nomenclature(cls, v: str)-> str:
li_nomenclature = [s.strip() for s in li_nomenclature]
return "-".join(li_nomenclature)

@model_validator(mode="after")
def set_paper_size_based_on_document_type(self) -> DocumentBase:
"""Set the paper size based on the document type."""
if self.document_type == DocumentTypeEnum.es:
self.paper_size = PaperSizeEnum.A4
elif self.document_type == DocumentTypeEnum.prs:
self.paper_size = PaperSizeEnum.A3
elif self.document_type == DocumentTypeEnum.rds:
self.paper_size = PaperSizeEnum.A4
else:
self.paper_size = PaperSizeEnum.na
return self

class Document(DocumentBase):
"""Document model."""
Expand Down
7 changes: 6 additions & 1 deletion packages/document-issue/src/document_issue/enums.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,5 +64,10 @@ class IssueFormatEnum(Enum):
p = "paper - full size"
r = "paper - reduced size"

class DocumentTypeEnum(str, Enum):
"""maps DocumentType codes to string description."""


es: str = "Equipment Schedule"
rds: str = "Room Data Schedule"
prs: str = "Plantroom Schedule"
# nzc: str = "Net-Zero Carbon Schedule" # TODO: Implement this in the future # noqa: ERA001
Loading