Skip to content
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

Add support for computed_field in Table component. #321

Merged
merged 6 commits into from
May 28, 2024
Merged

Add support for computed_field in Table component. #321

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3e74a61
Add support for `computed_field` in `Table` component.
hasansezertasan May 27, 2024
6835414
Remove trailing-whitespace
hasansezertasan May 27, 2024
fd804ea
Lint
hasansezertasan May 27, 2024
7b858c2
Remove ending commas
hasansezertasan May 27, 2024
3e09fd8
Linted and formatted with make commands.
hasansezertasan May 27, 2024
b7a01b9
Add title to computed_field for coverage.
hasansezertasan May 27, 2024
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
19 changes: 12 additions & 7 deletions src/python-fastui/fastui/components/tables.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,16 +44,21 @@ def _fill_columns(self) -> _te.Self:
raise ValueError('Cannot infer model from empty data, please set `Table(..., model=MyModel)`')

if self.columns is None:
self.columns = [
display.DisplayLookup(field=name, title=field.title)
for name, field in data_model_type.model_fields.items()
]
self.columns = []
for name, field in data_model_type.model_fields.items():
self.columns.append(display.DisplayLookup(field=name, title=field.title))
for name, field in data_model_type.model_computed_fields.items():
self.columns.append(display.DisplayLookup(field=name, title=field.title))

else:
# add pydantic titles to columns that don't have them
for column in (c for c in self.columns if c.title is None):
field = data_model_type.model_fields.get(column.field)
if field and field.title:
column.title = field.title
model_field = data_model_type.model_fields.get(column.field)
computed_field = data_model_type.model_computed_fields.get(column.field)
if model_field and model_field.title:
column.title = model_field.title
elif computed_field and computed_field.title:
column.title = computed_field.title
return self

@classmethod
Expand Down
46 changes: 37 additions & 9 deletions src/python-fastui/tests/test_tables_display.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,18 @@
import pytest
from fastui import components
from fastui.components import display
from pydantic import BaseModel, Field
from pydantic import BaseModel, Field, computed_field


class User(BaseModel):
id: int
name: str = Field(title='Name')

@computed_field(title='Representation')
@property
def representation(self) -> str:
return f'{self.id}: {self.name}'


users = [User(id=1, name='john'), User(id=2, name='jack')]

Expand All @@ -17,21 +22,40 @@ def test_table_no_columns():

# insert_assert(table.model_dump(by_alias=True, exclude_none=True))
assert table.model_dump(by_alias=True, exclude_none=True) == {
'data': [{'id': 1, 'name': 'john'}, {'id': 2, 'name': 'jack'}],
'columns': [{'field': 'id'}, {'field': 'name', 'title': 'Name'}],
'data': [
{'id': 1, 'name': 'john', 'representation': '1: john'},
{'id': 2, 'name': 'jack', 'representation': '2: jack'},
],
'columns': [
{'field': 'id'},
{'field': 'name', 'title': 'Name'},
{'field': 'representation', 'title': 'Representation'},
],
'type': 'Table',
}


def test_table_columns():
table = components.Table(
data=users, columns=[display.DisplayLookup(field='id', title='ID'), display.DisplayLookup(field='name')]
data=users,
columns=[
display.DisplayLookup(field='id', title='ID'),
display.DisplayLookup(field='name'),
display.DisplayLookup(field='representation'),
],
)

# insert_assert(table.model_dump(by_alias=True, exclude_none=True))
assert table.model_dump(by_alias=True, exclude_none=True) == {
'data': [{'id': 1, 'name': 'john'}, {'id': 2, 'name': 'jack'}],
'columns': [{'title': 'ID', 'field': 'id'}, {'field': 'name', 'title': 'Name'}],
'data': [
{'id': 1, 'name': 'john', 'representation': '1: john'},
{'id': 2, 'name': 'jack', 'representation': '2: jack'},
],
'columns': [
{'title': 'ID', 'field': 'id'},
{'title': 'Name', 'field': 'name'},
{'title': 'Representation', 'field': 'representation'},
],
'type': 'Table',
}

Expand All @@ -47,7 +71,11 @@ def test_table_empty_data_model():
# insert_assert(table.model_dump(by_alias=True, exclude_none=True))
assert table.model_dump(by_alias=True, exclude_none=True) == {
'data': [],
'columns': [{'field': 'id'}, {'title': 'Name', 'field': 'name'}],
'columns': [
{'field': 'id'},
{'title': 'Name', 'field': 'name'},
{'title': 'Representation', 'field': 'representation'},
],
'type': 'Table',
}

Expand All @@ -57,7 +85,7 @@ def test_display_no_fields():

# insert_assert(d.model_dump(by_alias=True, exclude_none=True))
assert d.model_dump(by_alias=True, exclude_none=True) == {
'data': {'id': 1, 'name': 'john'},
'data': {'id': 1, 'name': 'john', 'representation': '1: john'},
'fields': [{'field': 'id'}, {'title': 'Name', 'field': 'name'}],
'type': 'Details',
}
Expand All @@ -70,7 +98,7 @@ def test_display_fields():

# insert_assert(d.model_dump(by_alias=True, exclude_none=True))
assert d.model_dump(by_alias=True, exclude_none=True) == {
'data': {'id': 1, 'name': 'john'},
'data': {'id': 1, 'name': 'john', 'representation': '1: john'},
'fields': [{'title': 'ID', 'field': 'id'}, {'title': 'Name', 'field': 'name'}],
'type': 'Details',
}
Loading