-
Notifications
You must be signed in to change notification settings - Fork 75
/
_data_frame.py
1040 lines (865 loc) · 38.5 KB
/
_data_frame.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
from __future__ import annotations
import warnings
# TODO-barret-render.data_frame; Docs
# TODO-barret-render.data_frame; Add examples!
from typing import TYPE_CHECKING, Any, Awaitable, Callable, Literal, Union, cast
from htmltools import Tag
from .. import reactive, ui
from .._docstring import add_example
from .._utils import wrap_async
from ..session._utils import require_active_session, session_context
from ..types import JsonifiableDict, ListOrTuple
from ._data_frame_utils import (
AbstractTabularData,
BrowserCellSelection,
CellPatch,
CellSelection,
CellValue,
DataGrid,
DataTable,
PatchesFn,
PatchesFnSync,
PatchFn,
PatchFnSync,
SelectionModes,
as_cell_selection,
assert_patches_shape,
)
from ._data_frame_utils._html import maybe_as_cell_html
from ._data_frame_utils._styles import as_browser_style_infos
from ._data_frame_utils._tbl_data import (
apply_frame_patches__typed,
frame_columns,
frame_shape,
serialize_dtype,
subset_frame__typed,
)
from ._data_frame_utils._types import (
CellPatchProcessed,
ColumnFilter,
ColumnSort,
DataFrameLikeT,
FrameDtype,
FrameRender,
cell_patch_processed_to_jsonifiable,
frame_render_to_jsonifiable,
)
# as_selection_location_js,
from .renderer import Jsonifiable, Renderer, ValueFn
if TYPE_CHECKING:
from ..session import Session
DataFrameResult = Union[
None,
DataFrameLikeT,
"DataGrid[DataFrameLikeT]",
"DataTable[DataFrameLikeT]",
]
DataFrameValue = Union[None, DataGrid[DataFrameLikeT], DataTable[DataFrameLikeT]]
# # TODO-future; Use `dataframe-api-compat>=0.2.6` to injest dataframes and return standardized dataframe structures
# # TODO-future: Find this type definition: https://github.com/data-apis/dataframe-api-compat/blob/273c0be45962573985b3a420869d0505a3f9f55d/dataframe_api_compat/polars_standard/dataframe_object.py#L22
# # Related: https://data-apis.org/dataframe-api-compat/quick_start/
# # Related: https://github.com/data-apis/dataframe-api-compat
# # Related: `.collect()` is needed. Boo. : https://data-apis.org/dataframe-api-compat/basics/dataframe/#__tabbed_2_2
# from dataframe_api import DataFrame as DataFrameStandard
# class ConsortiumNamespaceDataframe(Protocol):
# def __dataframe_namespace__(self) -> DataFrameStandard: ...
# class ConsortiumStandardDataframe(Protocol):
# def __dataframe_consortium_standard__(self,api_version: str) -> DataFrameStandard: ...
# # https://data-apis.org/dataframe-protocol/latest/purpose_and_scope.html#this-dataframe-protocol
# def get_compliant_df(
# df: ConsortiumNamespaceDataframe | ConsortiumStandardDataframe,
# ) -> DataFrameStandard:
# """Utility function to support programming against a dataframe API"""
# if hasattr(df, "__dataframe_namespace__"):
# # Is already Standard-compliant DataFrame, nothing to do here.
# pass
# elif hasattr(df, "__dataframe_consortium_standard__"):
# # Convert to Standard-compliant DataFrame.
# df = df.__dataframe_consortium_standard__(api_version="2023.11-beta")
# else:
# # Here we can raise an exception if we only want to support compliant dataframes,
# # or convert to our default choice of dataframe if we want to accept (e.g.) dicts
# raise TypeError(
# "Expected Standard-compliant DataFrame, or DataFrame with Standard-compliant implementation"
# )
# return df
@add_example()
class data_frame(Renderer[DataFrameResult[DataFrameLikeT]]):
"""
Decorator for a function that returns a pandas `DataFrame` object (or similar) to
render as an interactive table or grid. Features fast virtualized scrolling, sorting,
filtering, and row selection (single or multiple).
Returns
-------
:
A decorator for a function that returns any of the following:
1. A :class:`~shiny.render.DataGrid` or :class:`~shiny.render.DataTable` object,
which can be used to customize the appearance and behavior of the data frame
output.
2. A pandas `DataFrame` object. (Equivalent to
`shiny.render.DataGrid(df)`.)
3. Any object that has a `.to_pandas()` method (e.g., a Polars data frame or
Arrow table). (Equivalent to `shiny.render.DataGrid(df.to_pandas())`.)
Row selection
-------------
When using the row selection feature, you can access the selected rows by using the
`<data_frame_renderer>.cell_selection()` method, where `<data_frame_renderer>`
is the `@render.data_frame` function name that corresponds with the `id=` used in
:func:`~shiny.ui.outout_data_frame`. Internally,
`<data_frame_renderer>.cell_selection()` retrieves the selected cell
information from session's `input.<data_frame_renderer>_cell_selection()` value and
upgrades it for consistent subsetting.
To filter your pandas data frame (`df`) down to the selected rows, you can use:
* `df.iloc[list(input.<data_frame_renderer>_cell_selection()["rows"])]`
* `df.iloc[list(<data_frame_renderer>.cell_selection()["rows"])]`
* `df.iloc[list(<data_frame_renderer>.data_view_info()["selected_rows"])]`
* `<data_frame_renderer>.data_view(selected=True)`
Editing cells
-------------
When a returned `DataTable` or `DataGrid` object has `editable=True`, app users will
be able to edit the cells in the table. After a cell has been edited, the edited
value will be sent to the server for processing. The handling methods are set via
`@<data_frame_renderer>.set_patch_fn` or `@<data_frame_renderer>.set_patches_fn`
decorators. By default, both decorators will return a string value.
To access the data viewed by the user, use `<data_frame_renderer>.data_view()`. This
method will sort, filter, and apply any patches to the data frame as viewed by the
user within the browser. This is a shallow copy of the original data frame. It is
possible that alterations to `data_view` could alter the original `data` data frame.
To access the original data, use `<data_frame_renderer>.data()`. This is a quick
reference to the original data frame (converted to a `pandas.DataFrame`) that was
returned from the app's render function. If it is mutated in place, it **will**
modify the original data.
Note... if the data frame renderer is re-rendered due to reactivity, then (currently)
the user's edits, sorting, and filtering will be lost. We hope to improve upon this
in the future.
Tip
---
This decorator should be applied **before** the ``@output`` decorator (if that
decorator is used). Also, the name of the decorated function (or
``@output(id=...)``) should match the ``id`` of a :func:`~shiny.ui.output_data_frame`
container (see :func:`~shiny.ui.output_data_frame` for example usage).
See Also
--------
* :func:`~shiny.ui.output_data_frame`
* :class:`~shiny.render.DataGrid` and :class:`~shiny.render.DataTable` are the
objects you can return from the rendering function to specify options.
"""
_value: reactive.Value[DataFrameValue[DataFrameLikeT] | None]
"""
Reactive value of the data frame's rendered object.
"""
_type_hints: reactive.Value[list[FrameDtype] | None]
"""
Reactive value of the data frame's type hints for each column.
This is enhanced with `"html"` type for rendering HTML content in the data frame.
"""
_patch_fn: PatchFn
"""
User-defined function to update a single cell in the data frame.
Defaults to return the value as is.
"""
_patches_fn: PatchesFn
"""
User-defined function to update all cells in a batch actions.
It gives the user opportunity to return less, the same, or even more patches than
originally requested by the browser.
Defaults to calling `._patch_fn()` on each input patch and returning the input
patches with updated values.
"""
_cell_patch_map: reactive.Value[dict[tuple[int, int], CellPatch]]
"""
Reactive dictionary of patches to be applied to the data frame.
This map is used for faster deduplications of patches at each location given the row
and column indices.
The key is defined as `(row_index, column_index)`.
"""
cell_patches: reactive.Calc_[list[CellPatch]]
"""
Reactive value of the data frame's edits provided by the user.
"""
data: reactive.Calc_[DataFrameLikeT]
"""
Reactive value of the data frame's output data.
This is a quick reference to the original data frame that was returned from the
app's render function. If it is mutated in place, it **will** modify the original
data.
Even if the rendered data value was not of type `pd.DataFrame` or `pl.DataFrame`, this method currently
converts it to a `pd.DataFrame`.
"""
_data_view_all: reactive.Calc_[DataFrameLikeT]
"""
Reactive value of the full (sorted and filtered) data.
"""
_data_view_selected: reactive.Calc_[DataFrameLikeT]
"""
Reactive value of the selected rows of the (sorted and filtered) data.
"""
@add_example(ex_dir="../api-examples/data_frame_data_view")
def data_view(self, *, selected: bool = False) -> DataFrameLikeT:
"""
Reactive function that retrieves the data how it is viewed within the browser.
This function will sort, filter, and apply any patches to the data frame as
viewed by the user within the browser.
This is a shallow copy of the original data frame. It is possible that
alterations to `data_view` could alter the original `data` data frame. Please be
cautious when using this value directly.
Parameters
----------
selected
If `True`, subset the viewed data to the selected area. Defaults to `False`.
Returns
-------
:
A view of the data frame as seen in the browser. Even if the rendered data
value was not of type `pd.DataFrame` or `pl.DataFrame`, this method currently returns the converted
`pd.DataFrame`.
See Also
--------
* [`pandas.DataFrame.copy` API documentation]h(ttps://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.copy.html)
"""
# Return reactive calculations so that they can be cached for other calculations
if selected:
return self._data_view_selected()
else:
return self._data_view_all()
# TODO-barret-render.data_frame; Allow for DataTable and DataGrid to accept SelectionModes
selection_modes: reactive.Calc_[SelectionModes]
"""
Reactive value of the data frame's possible selection modes.
"""
cell_selection: reactive.Calc_[CellSelection]
"""
Reactive value of selected cell information.
This method is a wrapper around `input.<id>_cell_selection()`, where `<id>` is
the `id` of the data frame output. This method returns the selected rows and
will cause reactive updates as the selected rows change.
The value has been enhanced from it's vanilla form to include the missing `cols` key
(or `rows` key) as a tuple of integers representing all column (or row) numbers.
This allows for consistent usage within code when subsetting your data. These
missing keys are not sent over the wire as they are independent of the selection.
Returns
-------
:
:class:`~shiny.render.CellSelection` representing the indices of the selected
cells. If no cells are currently selected, `None` is returned.
"""
data_view_rows: reactive.Calc_[tuple[int, ...]]
"""
Reactive value of the data frame's user view row numbers.
This value is a wrapper around `input.<id>_data_view_rows()`, where `<id>` is the
`id` of the data frame output.
Returns
-------
:
The row numbers of the data frame that are currently being viewed in the browser
after sorting and filtering has been applied.
"""
_data_patched: reactive.Calc_[DataFrameLikeT]
"""
Reactive value of the data frame's patched data.
Returns
-------
:
The data frame with all the user's edit patches applied to it.
"""
sort: reactive.Calc_[tuple[ColumnSort, ...]]
"""
Reactive value of the data frame's column sorting information.
Returns
-------
:
An array of `col`umn number and _is `desc`ending_ information.
"""
filter: reactive.Calc_[tuple[ColumnFilter, ...]]
"""
Reactive value of the data frame's column filters.
Returns
-------
:
An array of `col`umn number and `value` information.
"""
def _reset_reactives(self) -> None:
self._value.set(None)
self._cell_patch_map.set({})
self._type_hints.set(None)
def _init_reactives(self) -> None:
from .. import req
# Init
self._value: reactive.Value[DataFrameValue[DataFrameLikeT] | None] = (
reactive.Value(None)
)
self._type_hints: reactive.Value[list[FrameDtype] | None] = reactive.Value(None)
self._cell_patch_map = reactive.Value({})
@reactive.calc
def self_cell_patches() -> list[CellPatch]:
return list(self._cell_patch_map().values())
self.cell_patches = self_cell_patches
@reactive.calc
def self_data() -> DataFrameLikeT:
value = self._value()
req(value)
if not isinstance(value, (DataGrid, DataTable)):
raise TypeError(
f"Unsupported type returned from render function: {type(value)}. Expected `DataGrid` or `DataTable`"
)
return value.data
self.data = self_data
@reactive.calc
def self_selection_modes() -> SelectionModes:
value = self._value()
req(value)
if not isinstance(value, (DataGrid, DataTable)):
raise TypeError(
f"Unsupported type returned from render function: {type(value)}. Expected `DataGrid` or `DataTable`"
)
return value.selection_modes
self.selection_modes = self_selection_modes
@reactive.calc
def self_cell_selection() -> CellSelection:
browser_cell_selection = cast(
BrowserCellSelection,
self._get_session().input[f"{self.output_id}_cell_selection"](),
)
cell_selection = as_cell_selection(
browser_cell_selection,
selection_modes=self.selection_modes(),
data=self.data(),
data_view_rows=self.data_view_rows(),
# TODO-barret: replace methods like .shape, .loc. .iat with those from
# _tbl_data.py, test in the playright app.
data_view_cols=tuple(range(frame_shape(self.data())[1])),
)
return cell_selection
self.cell_selection = self_cell_selection
@reactive.calc
def self_sort() -> tuple[ColumnSort, ...]:
column_sort = self._get_session().input[f"{self.output_id}_column_sort"]()
return tuple(column_sort)
self.sort = self_sort
@reactive.calc
def self_filter() -> tuple[ColumnFilter, ...]:
column_filter = self._get_session().input[
f"{self.output_id}_column_filter"
]()
return tuple(column_filter)
self.filter = self_filter
@reactive.calc
def self_data_view_rows() -> tuple[int, ...]:
data_view_rows = self._get_session().input[
f"{self.output_id}_data_view_rows"
]()
return tuple(data_view_rows)
self.data_view_rows = self_data_view_rows
@reactive.calc
def self__data_patched() -> DataFrameLikeT:
return apply_frame_patches__typed(self.data(), self.cell_patches())
self._data_patched = self__data_patched
# Apply filtering and sorting
# https://github.com/posit-dev/py-shiny/issues/1240
def _subset_data_view(selected: bool) -> DataFrameLikeT:
"""
Helper method to subset data according to what is viewed in the browser;
Applies filtering and sorting to the patched data. If `selected=True`, only
the user selected rows are returned.
Note Future rect selection changes
----------------------------------
In the future, the selected rows may need to be **after** filtering
and sorting are applied. This would allow for rectangular selections to be
applied to the filtered and sorted data given min/max row info.
Where as, currently, the selected rows are applied to the original data
before filtering and sorting are applied. Serializing the rect selection
would require tuple info of all cells selected.
"""
if selected:
rows = self.cell_selection()["rows"]
else:
rows = self.data_view_rows()
return subset_frame__typed(self._data_patched(), rows=rows)
# Helper reactives so that internal calculations can be cached for use in other calculations
@reactive.calc
def self__data_view() -> DataFrameLikeT:
return _subset_data_view(selected=False)
@reactive.calc
def self__data_view_selected() -> DataFrameLikeT:
return _subset_data_view(selected=True)
self._data_view_all = self__data_view
self._data_view_selected = self__data_view_selected
def _get_session(self) -> Session:
if self._session is None:
raise RuntimeError(
"The data frame being used was not initialized within a reactive context / session. Please call `@render.data_frame` where `shiny.session.get_current_context()` returns a non-`None` value."
)
return self._session
@add_example(ex_dir="../api-examples/data_frame_data_view")
def set_patch_fn(self, fn: PatchFn | PatchFnSync) -> None:
"""
Decorator to set the function that updates a single cell in the data frame.
The default patch function returns the value as is.
Parameters
----------
fn
A function that accepts a kwarg `patch` and returns the processed
`patch.value` for the cell.
"""
self._patch_fn = wrap_async( # pyright: ignore[reportGeneralTypeIssues,reportAttributeAccessIssue]
fn
)
# Do not return self here as it is typically used as a decorator (which would return `self`)
# By returning `self` in express mode, it is attempted to be registered twice. That is bad.
# So for now, we will not return `self` here.
# from .._typing_extensions import Self
# return self
@add_example(ex_dir="../api-examples/data_frame_set_patches")
def set_patches_fn(self, fn: PatchesFn | PatchesFnSync) -> None:
"""
Decorator to set the function that updates a batch of cells in the data frame.
The default patches function calls the async `._patch_fn()` on each input patch
and returns the updated patch values.
There are no checks made on the quantity of patches returned. The user can
return more, less, or the same number of patches as the input patches. This
allows for the app author to own more control over which columns are updated and
how they are updated.
"""
self._patches_fn = wrap_async( # pyright: ignore[reportGeneralTypeIssues,reportAttributeAccessIssue]
fn
)
# Do not return self here as it is typically used as a decorator (which would return `self`)
# By returning `self` in express mode, it is attempted to be registered twice. That is bad.
# So for now, we will not return `self` here.
# from .._typing_extensions import Self
# return self
def _init_patch_fns(self) -> None:
"""
Initialize `._patch_fn()` and `._patches_fn()`.
"""
async def patch_fn(
*,
patch: CellPatch,
) -> CellValue:
return patch["value"]
async def patches_fn(
*,
patches: tuple[CellPatch, ...],
) -> ListOrTuple[CellPatch]:
ret_patches: list[CellPatch] = []
for patch in patches:
new_patch = patch.copy()
new_patch["value"] = await self._patch_fn(patch=patch)
ret_patches.append(new_patch)
return ret_patches
self.set_patch_fn(patch_fn)
self.set_patches_fn(patches_fn)
def _set_patches_handler_impl(
self,
handler: Callable[..., Awaitable[Jsonifiable]] | None,
) -> str:
"""
Set the client patches request handler for the data frame.
This method should be removed when the rendered result is `None`.
(... b/c there is no data frame to send requests!)
"""
session = self._get_session()
key = session.set_message_handler(
f"data_frame_patches_{self.output_id}",
handler,
)
return key
def _reset_patches_handler(self) -> str:
"""
Resets the client patches request handler for the data frame.
"""
return self._set_patches_handler_impl(None)
def _set_patches_handler(self) -> str:
"""
Set the client patches handler for the data frame.
This method **must be** called as late as possible as it depends on the ID of the output.
"""
return self._set_patches_handler_impl(self._patches_handler)
# Do not change this method name unless you update corresponding code in `/js/dataframe/`!!
async def _patches_handler(self, patches: tuple[CellPatch, ...]) -> Jsonifiable:
"""
Accepts edit patches requests from the client and returns the processed patches.
Parameters
----------
patches
A list of patches to apply to the data frame.
Returns
-------
:
A list of processed patches to apply to the data frame. The number of
processed patches can be different from the number of input patches.
"""
assert_patches_shape(patches)
with session_context(self._get_session()):
# Call user's cell update method to retrieve formatted values
val = await self._patches_fn(patches=patches)
patches = tuple(val)
# Check to make sure `updated_infos` is a list of dicts with the correct keys
bad_patches_format = not isinstance(patches, list)
if not bad_patches_format:
for patch in patches:
if not (
# Verify structure
isinstance(patch, dict)
# Verify types
and isinstance(patch["row_index"], int)
and isinstance(patch["column_index"], int)
# # Do not check the value type here. It should be validated by
# # `._set_cell_patch_map_value()` later with more type hint context
# and isinstance(updated_patch["value"], CellValue)
):
raise ValueError(
f"The return value of {self.output_id}'s `_patches_fn()` "
f"(typically set by `@{self.output_id}.set_patches_fn`) "
f"must be a list where each item has a row_index (`int`), column_index (`int`), and value (`TagChild`)."
)
# Add (or overwrite) new cell patches by setting each patch into the cell patch map
for patch in patches:
self._set_cell_patch_map_value(
value=patch["value"],
row_index=patch["row_index"],
column_index=patch["column_index"],
)
# Upgrade any HTML-like content to `CellHtml` json objects
processed_patches: list[CellPatchProcessed] = [
{
"row_index": patch["row_index"],
"column_index": patch["column_index"],
# Only upgrade the value if it is necessary
"value": maybe_as_cell_html(
patch["value"],
session=self._get_session(),
),
}
for patch in patches
]
# Prep the processed patches for sending to the client
jsonifiable_patches: list[Jsonifiable] = [
cell_patch_processed_to_jsonifiable(ret_processed_patch)
for ret_processed_patch in processed_patches
]
await self._attempt_update_cell_style()
# Return the processed patches to the client
return jsonifiable_patches
def _set_cell_patch_map_value(
self,
value: CellValue,
*,
row_index: int,
column_index: int,
):
"""
Set the value within the cell patch map.
Parameters
----------
value
The new value to set the cell to.
row_index
The row index of the cell to update.
column_index
The column index of the cell to update.
"""
assert isinstance(
row_index, int
), f"Expected `row_index` to be an `int`, got {type(row_index)}"
assert isinstance(
column_index, int
), f"Expected `column_index` to be an `int`, got {type(column_index)}"
# TODO-barret-render.data_frame; Check for cell type and compare against self._type_hints
# TODO-barret-render.data_frame; The `value` should be coerced by pandas to the correct type
# TODO-barret; See https://pandas.pydata.org/pandas-docs/stable/user_guide/basics.html#object-conversion
cell_patch: CellPatch = {
"row_index": row_index,
"column_index": column_index,
"value": value,
}
# Use copy to set the new value
cell_patch_map = self._cell_patch_map().copy()
cell_patch_map[(row_index, column_index)] = cell_patch
self._cell_patch_map.set(cell_patch_map)
async def _attempt_update_cell_style(self) -> None:
with session_context(self._get_session()):
rendered_value = self._value()
if not isinstance(rendered_value, (DataGrid, DataTable)):
return
styles_fn = rendered_value.styles
if not callable(styles_fn):
return
new_styles = as_browser_style_infos(styles_fn, data=self._data_patched())
await self._send_message_to_browser(
"updateStyles",
{"styles": new_styles},
)
# TODO-barret-render.data_frame; Add `update_cell_value()` method
# def _update_cell_value(
# self, value: CellValue, *, row_index: int, column_index: int
# ) -> CellPatch:
# """
# Update the value of a cell in the data frame.
#
# Parameters
# ----------
# value
# The new value to set the cell to.
# row_index
# The row index of the cell to update.
# column_index
# The column index of the cell to update.
# """
# cell_patch_processed = self._set_cell_patch_map_value(
# value, row_index=row_index, column_index=column_index
# )
# # TODO-barret-render.data_frame; Send message to client to update cell value
# return cell_patch_processed
def auto_output_ui(self) -> Tag:
return ui.output_data_frame(id=self.output_id)
def __init__(self, fn: ValueFn[DataFrameResult[DataFrameLikeT]]):
super().__init__(fn)
# Set reactives from calculated properties
self._init_reactives()
# Set update functions
self._init_patch_fns()
def _set_output_metadata(self, *, output_id: str) -> None:
super()._set_output_metadata(output_id=output_id)
# Verify that the session used (during `__init__`) when creating the renderer is
# the same session used when executing the renderer. This is to prevent a user
# from creating a renderer in one module and registering it on an output with a
# different session.
active_session = require_active_session(None)
if self._get_session() != active_session:
raise RuntimeError(
"The session used when creating the renderer "
"is not the same session used when executing the renderer. "
"Please file an issue on "
"GitHub <https://github.com/posit-dev/py-shiny/issues/new> "
"with an example of how you are reproducing this error. "
"We would be curious to know your use case!"
)
async def render(self) -> JsonifiableDict | None:
# Reset value
self._reset_reactives()
self._reset_patches_handler()
value = await self.fn()
if value is None:
return None
if not isinstance(value, AbstractTabularData):
try:
value = DataGrid(value)
except TypeError as e:
raise TypeError(
"@render.data_frame doesn't know how to render objects of type ",
type(value),
) from e
# Set patches url handler for client
patch_key = self._set_patches_handler()
self._value.set(value) # pyright: ignore[reportArgumentType]
# Use session context so `to_payload()` gets the correct session
with session_context(self._get_session()):
payload = value.to_payload()
self._type_hints.set(payload["typeHints"])
ret: FrameRender = {
"payload": payload,
"patchInfo": {
"key": patch_key,
},
"selectionModes": self.selection_modes().as_dict(),
}
return frame_render_to_jsonifiable(ret)
async def _send_message_to_browser(self, handler: str, obj: dict[str, Any]):
session = self._get_session()
id = session.ns(self.output_id)
await session.send_custom_message(
"shinyDataFrameMessage",
{
"id": id,
"handler": handler,
"obj": obj,
},
)
async def update_cell_selection(
# self, selection: SelectionLocation | CellSelection
self,
selection: CellSelection | Literal["all"] | None | BrowserCellSelection,
) -> None:
"""
Update the cell selection in the data frame.
Currently only single (`"type": "row"`) or multiple (`"type": "rows"`) row
selection is supported.
If the current data frame selection mode is `"none"` and a non-none selection is
provided, a warning will be raised and no rows will be selected. If cells are
supposes to be selected, the selection mode returned from the render function
must (currently) be set to `"row"` or `"rows"`.
Parameters
----------
selection
The cell selection to apply to the data frame. This can be a `CellSelection`
object, `"all"` to select all cells (if possible), or `None` to clear the
selection.
"""
with reactive.isolate():
selection_modes = self.selection_modes()
data = self.data()
data_view_rows = self.data_view_rows()
data_view_cols = tuple(range(data.shape[1]))
if selection_modes._is_none():
warnings.warn(
'Cell selection cannot be updated when `.selection_mode=` contains "none". '
'Please set `selection_mode=` to contain a non-`"none"` value '
"(e.g. 'row' or 'rows') in the return value of "
"`@render.data_frame` to enable cell selection.",
stacklevel=2,
)
selection = None
cell_selection = as_cell_selection(
selection,
selection_modes=selection_modes,
data=data,
data_view_rows=data_view_rows,
data_view_cols=data_view_cols,
)
if cell_selection["type"] == "none":
pass
elif cell_selection["type"] == "rect":
raise RuntimeError("Rectangle region selection is not yet supported")
elif cell_selection["type"] == "col":
raise RuntimeError("Column selection is not yet supported")
elif cell_selection["type"] == "row":
row_value = cell_selection["rows"]
if selection_modes.row == "single" and len(row_value) > 1:
warnings.warn(
"Attempted to set cell selection to more than 1 row when `.selection_modes()` contains 'row'. "
"Only the first row supplied will be selected.",
stacklevel=2,
)
cell_selection["rows"] = (row_value[0],)
else:
raise ValueError(f"Unhandled selection type: {cell_selection['type']}")
await self._send_message_to_browser(
"updateCellSelection",
{"cellSelection": cell_selection},
)
@add_example(ex_dir="../api-examples/data_frame_update_sort")
async def update_sort(
self,
sort: ListOrTuple[ColumnSort | int] | int | ColumnSort | None,
) -> None:
"""
Update the column sorting in the data frame.
The sort will be applied in reverse order so that the first value has the highest
precedence. This mean _ties_ will go to the second sort column (and so on).
Parameters
----------
sort
A list of column sorting information. If `None`, sorting will be removed. `int` values will be upgraded to `{"col": int, "desc": <DESC>}` where `<DESC>` is `True` if the column is number like and `False` otherwise.
"""
if sort is None:
sort = ()
elif isinstance(sort, int):
sort = (sort,)
elif isinstance(sort, (list, tuple)):
...
else:
raise TypeError(
f"Expected `sort` to be a `list`, `tuple`, `int`, or `None`. Received `{type(sort)}`"
)
vals: list[ColumnSort] = []
if len(sort) > 0:
with reactive.isolate():
data = self.data()
ncol = frame_shape(data)[1]
for val in sort:
val_dict: ColumnSort
if isinstance(val, int):
col = frame_columns(data)[val]
desc = serialize_dtype(col)["type"] == "numeric"
val_dict = {"col": val, "desc": desc}
val_dict: ColumnSort = (
val if isinstance(val, dict) else {"col": val, "desc": True}
)
assert isinstance(val_dict, dict)
assert isinstance(val_dict["col"], int)
assert 0 <= val_dict["col"] < ncol
assert isinstance(val_dict["desc"], bool)
vals.append(val_dict)
await self._send_message_to_browser(
"updateColumnSort",
{"sort": vals},
)
@add_example(ex_dir="../api-examples/data_frame_update_filter")
async def update_filter(
self,
filter: ListOrTuple[ColumnFilter] | None,
) -> None:
"""
Update the column filtering in the data frame.
Parameters
----------
filter
A list of column filtering information. If `None`, filtering will be removed.
"""
assert filter is None or isinstance(filter, (list, tuple))
if filter is None:
filter = []
else:
with reactive.isolate():
data = self.data()
ncol = len(data.columns)
for column_filter, i in zip(filter, range(len(filter))):
assert isinstance(column_filter, dict)
assert isinstance(column_filter["col"], int)
assert 0 <= column_filter["col"] < ncol
if isinstance(column_filter["value"], str):
...
elif isinstance(column_filter["value"], (list, tuple)):
assert len(column_filter["value"]) == 2
if (
column_filter["value"][0] is None
and column_filter["value"][1] is None
):
raise TypeError(
"Expected `filter[{i}]['value']` to be a `str` or a `list`/`tuple` of type `int` or `None`. Received `None` for both values."
)
assert isinstance(
column_filter["value"][0], (int, float, type(None))
)
assert isinstance(
column_filter["value"][1], (int, float, type(None))
)
else:
raise TypeError(
f"Expected `filter[{i}]['value']` to be a `str` or a `list`/`tuple` of type `int` or `None`. Received `{type(column_filter['value'])}`"
)
await self._send_message_to_browser(
"updateColumnFilter",
{"filter": filter},
)
def input_cell_selection(self) -> CellSelection | None:
"""
[Deprecated] Reactive value of selected cell information.