『玩转Streamlit』--可编辑表格

俞云

之前介绍过两个数据展示的组件，st.dataframe和st.table。
今天介绍的st.data_editor组件，除了展示数据的功能更加强大之外，还可以编辑数据。
1. 概要

st.data_editor组件在数据展示和编辑中都发挥着独特且重要的作用。
首先，在数据展示方面，它的优势在于：

• 直观性：以表格形式展示数据，使得数据更加直观易懂。通过该组件可以方便地查看数据集的整体结构和细节
  
• 适应性：能够自动适应屏幕宽度，并支持水平或垂直滚动，确保用户能方便地浏览整个数据集
  
• 交互性：支持对数据进行排序、筛选和搜索等操作，增强了数据的可读性和交互性
  

在数据编辑方面，优势也很明显：

• 灵活性：支持类电子表格编辑，可以在界面上直接对数据进行增删改操作，无需通过代码实现，提高了数据编辑的灵活性
  
• 定制性：提供了丰富的列定制选项，如通过st.column_config可以设置列的标题、类型、格式以及编辑属性（如最小/最大值或步长）等，以满足不同场景下的数据编辑需求
  
• 多数据类型支持：支持多种数据类型的数据编辑，包括数值、文本、日期、时间等，使得数据编辑更加全面和便捷
  
• 状态管理：具有状态管理机制，可以记录用户的编辑操作，并在必要时进行回滚或提交。这使得数据编辑过程更加安全和可控
  

2. 基本用法

st.data_editor组件多用在需要实时编辑数据的情况，它主要参数有：
名称类型说明data-任何适合渲染成表格的数据类型widthint数据编辑器的宽度，单位 pxheightint数据编辑器的高度，单位 pxuse_container_widthbool是否使用父容器宽度hide_indexbool是否隐藏索引列column_order[str]指定列的显示顺序column_configdict配置列的显示方式，例如标题、可见性、类型或格式，以及编辑属性等等num_rowsstr控制用户是否可以在数据编辑器中添加和删除行disabledbool 或 [str]是否禁用编辑keystr组件名称，具有唯一性这里重点关注两个参数，data和column_config。
data这个参数支持的数据类型非常宽泛，具体包括：pandas.DataFrame, pandas.Series, pandas.Styler, pandas.Index, pyarrow.Table, numpy.ndarray, pyspark.sql.DataFrame, snowflake.snowpark.DataFrame, list, set, tuple, dict等等。
几乎所有常用的存储数据的结构都包含了。
column_config这个参数可以高度定制列的显示和编辑行为，极大的增强了st.data_editor的能力，
在后面的高级用法中会详细介绍。
2.1. 使用示例

下面通过一个根据实际应用简化的示例来演示st.data_editor基本用法。
我们构建一个简单的产品库存管理系统，通过一个界面来展示和编辑产品的库存数据。
上面用st.data_editor来编辑表格数据，下面用st.dataframe同步显示编辑后的数据。

1. import streamlit as st
2. import pandas as pd
4. # 模拟产品库存数据
5. inventory_data = pd.DataFrame(
6.     {
7.         "Product ID": [1, 2, 3],
8.         "Product Name": ["Apple", "Banana", "Cherry"],
9.         "Quantity": [100, 150, 200],
10.         "Price": [0.5, 0.3, 1.0],
11.     }
12. )
14. # 使用st.data_editor展示和编辑库存数据
15. st.title("产品库存管理系统")
16. edited_inventory = st.data_editor(
17.     inventory_data,
18.     width=600,
19.     height=300,
20.     num_rows="dynamic",
21. )
23. # 显示编辑后的数据（可选，此处仅为展示效果）
24. st.write("编辑后的库存数据：")
25. st.dataframe(edited_inventory)

复制代码

3. 高级用法

结合column_config参数，我们可以高度定制st.data_editor的列的显示和编辑行为。
比如：

• 自定义列显示：设置列的标题、帮助信息、格式等，使数据编辑器的界面更加友好和易读
  
• 控制列编辑行为：指定列的数据类型、最小值、最大值、步长等，从而控制用户对该列的编辑行为。例如，可以将一列设置为数字类型，并限制其输入范围
  
• 添加特殊类型的列：支持多种特殊类型的列，如图表列、进度条列、链接列等，这些特殊类型的列可以提供更丰富的数据展示和编辑体验
  

3.1. 使用示例

下面我们构建一个学生成绩管理系统，使用st.data_editor展示和编辑学生成绩，
并通过st.column_config定制列的显示和编辑行为。
下面的示例中，定义了每个列的标题，同时定义了各科目的最高分和显示的format。

1. import streamlit as st
2. import pandas as pd
4. # 模拟学生成绩数据
5. student_grades = pd.DataFrame(
6.     {
7.         "Student Name": ["Alice", "Bob", "Charlie"],
8.         "Math": [125, 90, 140],
9.         "Science": [38, 20, 34],
10.         "English": [88, 114, 96],
11.     }
12. )
14. # 定义列配置
15. column_config = {
16.     "Student Name": {"label": "学生姓名"},
17.     "Math": st.column_config.NumberColumn(
18.         label="数学成绩",
19.         min_value=0,
20.         max_value=150,
21.         format="%d 分",
22.     ),
23.     "Science": st.column_config.NumberColumn(
24.         label="科学成绩",
25.         min_value=0,
26.         max_value=40,
27.         format="%d 分",
28.     ),
29.     "English": st.column_config.NumberColumn(
30.         label="英语成绩",
31.         min_value=0,
32.         max_value=120,
33.         format="%d 分",
34.     ),
35. }
37. # 使用st.data_editor展示和编辑学生成绩，并应用列配置
38. st.title("学生成绩管理系统")
39. edited_grades = st.data_editor(
40.     student_grades,
41.     width=500,
42.     height=300,
43.     column_config=column_config,
44.     num_rows="dynamic",
45. )
47. # 显示编辑后的数据（用于确认更改）
48. st.write("编辑后的学生成绩：")
49. st.dataframe(edited_grades)

复制代码

下面构造一个更复杂的列的示例，其中使用了下拉框，进度条和柱状图作为列。
注意，进度条和柱状图的列是不能编辑的。

1. # 模拟项目数据
2. project_data = pd.DataFrame(
3.     {
4.         "Project Name": ["Project A", "Project B", "Project C"],
5.         "Status": ["In Progress", "Completed", "Pending"],
6.         "Progress": [60, 100, 30],  # 进度百分比
7.         "Sales": [
8.             [1000, 1500, 500],
9.             [200, 500, 1500],
10.             [1800, 500, 1000],
11.         ],  # 销售额
12.     }
13. )
15. # 定义状态选项列表
16. statuses = ["In Progress", "Completed", "Pending", "On Hold"]
18. # 定义列配置
19. column_config = {
20.     "Project Name": {"label": "项目名称"},
21.     "Status": st.column_config.SelectboxColumn(
22.         "状态",
23.         options=statuses,
24.     ),
25.     "Progress": st.column_config.ProgressColumn(
26.         "进度",
27.         min_value=0,
28.         max_value=100,
29.         format="%d%%",  # 显示百分比
30.     ),
31.     "Sales": st.column_config.BarChartColumn(
32.         "销售额变化",
33.         y_min=100,
34.         y_max=2000,
35.     ),
36. }
38. # 使用st.data_editor展示和编辑项目数据（不包含图表列）
39. st.title("项目管理系统")
40. edited_projects = st.data_editor(
41.     project_data,
42.     width=500,
43.     height=300,
44.     column_config=column_config,
45.     num_rows="dynamic",
46. )

复制代码

4. 总结

总之，st.data_editor是Streamlit中一个功能强大的组件，它提供了类似电子表格的方式在线编辑DataFrame或其他类似结构的数据，直观易用。
然而，它也存在一些劣势，如状态管理复杂性、性能问题以及定制化限制等。
在实际应用中，需要根据具体需求权衡利弊，并结合Streamlit的其他组件和Python的强大生态来实现更复杂的数据处理和分析功能。

来源:https://www.cnblogs.com/wang_yb/p/18576592
免责声明：由于采集信息均来自互联网，如果侵犯了您的权益，请联系我们【E-Mail:cb@itdo.tech】 我们会及时删除侵权内容，谢谢合作！