-
Notifications
You must be signed in to change notification settings - Fork 857
feat(models): add typed model classes for TableBlock cells and column_settings #1939
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.
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
Open
srtaalej
wants to merge
6
commits into
main
Choose a base branch
from
table-block-typed-models
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
ab98fbe
feat(models): add typed model classes for TableBlock cells and column…
srtaalej 5325ecb
fix(models): remove RawNumberCell until client rendering is confirmed
srtaalej 8df84fa
docs(models): align ColumnSettings docstrings with official docs
srtaalej 90a4b8c
Merge branch 'main' into table-block-typed-models
srtaalej 61b147a
refactor(models): remove RichTextCell, rename ColumnSettings to Table…
srtaalej e80261f
style(models): fix line length in TableBlockColumnSettings.parse
srtaalej File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -35,6 +35,7 @@ | |||||||||
| SectionBlock, | ||||||||||
| StaticSelectElement, | ||||||||||
| TableBlock, | ||||||||||
| TableBlockColumnSettings, | ||||||||||
| TaskCardBlock, | ||||||||||
| VideoBlock, | ||||||||||
| ) | ||||||||||
|
|
@@ -1462,6 +1463,72 @@ def test_with_block_id(self): | |||||||||
| } | ||||||||||
| self.assertDictEqual(input, TableBlock(**input).to_dict()) | ||||||||||
|
|
||||||||||
| def test_with_column_settings_objects(self): | ||||||||||
| """Test table using typed TableBlockColumnSettings objects""" | ||||||||||
| block = TableBlock( | ||||||||||
| rows=[[{"type": "raw_text", "text": "A"}, {"type": "raw_text", "text": "B"}]], | ||||||||||
| column_settings=[ | ||||||||||
| TableBlockColumnSettings(align="right", is_wrapped=True), | ||||||||||
| TableBlockColumnSettings(align="left"), | ||||||||||
| ], | ||||||||||
| ) | ||||||||||
| expected = { | ||||||||||
| "type": "table", | ||||||||||
| "column_settings": [{"align": "right", "is_wrapped": True}, {"align": "left"}], | ||||||||||
| "rows": [[{"type": "raw_text", "text": "A"}, {"type": "raw_text", "text": "B"}]], | ||||||||||
| } | ||||||||||
| self.assertDictEqual(expected, block.to_dict()) | ||||||||||
|
|
||||||||||
| def test_with_rich_text_cell_objects(self): | ||||||||||
| """Test table using typed RichTextBlock objects""" | ||||||||||
| cell = RichTextBlock(elements=[{"type": "rich_text_section", "elements": [{"type": "text", "text": "Hello"}]}]) | ||||||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🪬 suggestion: Let's strengthen the parsing checks of this test with rich text elements too!
Suggested change
|
||||||||||
| block = TableBlock( | ||||||||||
| rows=[ | ||||||||||
| [RawTextObject(text="Header"), cell], | ||||||||||
| ], | ||||||||||
| ) | ||||||||||
| expected = { | ||||||||||
| "type": "table", | ||||||||||
| "rows": [ | ||||||||||
| [ | ||||||||||
| {"type": "raw_text", "text": "Header"}, | ||||||||||
| { | ||||||||||
| "type": "rich_text", | ||||||||||
| "elements": [{"type": "rich_text_section", "elements": [{"type": "text", "text": "Hello"}]}], | ||||||||||
| }, | ||||||||||
| ] | ||||||||||
| ], | ||||||||||
| } | ||||||||||
| self.assertDictEqual(expected, block.to_dict()) | ||||||||||
|
|
||||||||||
| def test_mixed_typed_and_dict_cells(self): | ||||||||||
| """Test table accepts a mix of typed objects and plain dicts""" | ||||||||||
| block = TableBlock( | ||||||||||
| rows=[ | ||||||||||
| [RawTextObject(text="Col A"), RawTextObject(text="Col B")], | ||||||||||
| [ | ||||||||||
| {"type": "raw_text", "text": "Data"}, | ||||||||||
| RichTextBlock(elements=[{"type": "rich_text_section", "elements": [{"type": "text", "text": "rich"}]}]), | ||||||||||
| ], | ||||||||||
| ], | ||||||||||
| column_settings=[TableBlockColumnSettings(align="left"), {"align": "right"}], | ||||||||||
| ) | ||||||||||
| expected = { | ||||||||||
| "type": "table", | ||||||||||
| "column_settings": [{"align": "left"}, {"align": "right"}], | ||||||||||
| "rows": [ | ||||||||||
| [{"type": "raw_text", "text": "Col A"}, {"type": "raw_text", "text": "Col B"}], | ||||||||||
| [ | ||||||||||
| {"type": "raw_text", "text": "Data"}, | ||||||||||
| { | ||||||||||
| "type": "rich_text", | ||||||||||
| "elements": [{"type": "rich_text_section", "elements": [{"type": "text", "text": "rich"}]}], | ||||||||||
| }, | ||||||||||
| ], | ||||||||||
| ], | ||||||||||
| } | ||||||||||
| self.assertDictEqual(expected, block.to_dict()) | ||||||||||
|
|
||||||||||
| def test_column_settings_variations(self): | ||||||||||
| """Test various column_settings configurations""" | ||||||||||
| # Left align | ||||||||||
|
|
||||||||||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🧮 question: I'm curious if keeping this beside the
TableBlockimplementation is best? Or if it's right to keep here? AFAICT we won't share these settings with other blocks...