Initial template def and data fetch and post. #54
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dourvaris
requested changes
Jun 18, 2024
| @@ -146,6 +147,44 @@ async def send_event( | |||
| raise DeviceError(response.status, confirmation["message"]) | |||
| return Event.from_dict(confirmation["result"]) | |||
|
|
|||
| async def get_template(self) -> Template: | |||
| """ | |||
| :raises | |||
| return Template.fromdict(result) | ||
|
|
||
| async def get_template_data(self): | ||
| """ """ |
| @@ -3,6 +3,7 @@ | |||
| import enum | |||
| import logging | |||
| import typing as T | |||
| import uuid | |||
There was a problem hiding this comment.
Prefer to use from module import thing as it shows issues at compile time rather than run time attribute errors ie:
from uuid import UUID
from datetime import datetime
| def fromdict(cls, data: T.Dict) -> "Template": | ||
| items = [TemplateItem.fromdict(item) for item in data.get("items", [])] | ||
| return cls( | ||
| archived_at=datetime.fromisoformat(data["archived_at"]) |
There was a problem hiding this comment.
Perhaps this needs to be datetime.datetime.fromisoformat?
| id: T.Optional[uuid.UUID] = None | ||
| input_type: str = dataclasses.field(default="any") | ||
| required: bool = dataclasses.field(default=False) | ||
| title: T.Optional[str] = None |
There was a problem hiding this comment.
I don't think some of these properties can actually be None, would be better to put Optional only on fields that can be None.
| updated_at: T.Optional[datetime.datetime] = None | ||
|
|
||
| @classmethod | ||
| def fromdict(cls, data: T.Dict) -> "Template": |
There was a problem hiding this comment.
Something to consider in the future is something like pydantic and get all the validation/conversion for free, eg:
from uuid import UUID
from datetime import datetime
from typing import Literal
from pydantic.dataclasses import dataclass
@dataclass
class Template:
id: UUID
created_at: datetime
items: list[TemplateItem]
WidgetType = Literal["TEXT", "PARAGRAPH", "RADIO_LIST", "CHECKBOX_LIST", "SECTION_HEADER", "PAGE_BREAK"]
@dataclass
class TemplateItem:
widget_type: WidgetType
title: str
json_data = {
"id": "99ae566d-5988-4e47-8147-297d9ac989a4",
"created_at": "2022-01-01T01:01:01",
"items": [
{"widget_type": "TEXT", "title": "a question"},
],
}
Template(**json_data)
# Template(id=UUID('99ae566d-5988-4e47-8147-297d9ac989a4'), created_at=datetime.datetime(2022, 1, 1, 1, 1, 1), items=[TemplateItem(widget_type='TEXT', title='a question')])for more information, see https://pre-commit.ci
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.