Streamlit应用中动态显示多PDF文件于标签页的教程

引言：Streamlit中PDF展示的挑战

在streamlit应用中，用户常常需要上传并查看pdf文件。当需要同时处理并显示多个pdf文件时，一个常见的需求是为每个文件创建独立的视图，例如通过标签页（tabs）的形式。传统的pdf处理方式，如使用pypdf2库解析pdf并将其渲染为图像，不仅代码复杂，涉及文件读写、页面渲染和图像显示，而且在处理多个文件时，手动管理标签页的动态创建和销毁会变得非常繁琐，效率也较低。尤其是在用户取消选择某个文件时，对应的标签页需要自动消失，这给开发者带来了不小的挑战。

解决方案：streamlit-pdf-viewer组件

为了解决Streamlit中PDF文件展示的复杂性，特别是实现多文件动态标签页显示的需求，推荐使用专门为Streamlit设计的第三方组件streamlit-pdf-viewer。这个组件极大地简化了PDF的渲染过程，它能够直接在Streamlit应用中嵌入PDF查看器，支持从文件路径或字节流加载PDF，并提供了内置的页面导航、缩放等功能，极大地提升了开发效率和用户体验。

安装与基础使用

在使用streamlit-pdf-viewer之前，需要先通过pip安装该库：

pip install streamlit-pdf-viewer

安装完成后，其基本使用非常简单。pdf_viewer函数接受PDF文件的路径字符串或其二进制内容作为参数：

import streamlit as st
from streamlit_pdf_viewer import pdf_viewer

st.title("PDF查看器示例")

# 示例：从本地文件路径加载
# pdf_viewer("path/to/your/document.pdf")

# 示例：从字节流加载（更适用于上传文件场景）
# with open("path/to/your/document.pdf", "rb") as f:
#     pdf_bytes = f.read()
#     pdf_viewer(pdf_bytes)

实现多PDF文件动态标签页显示

结合Streamlit的st.file_uploader和st.tabs功能，我们可以优雅地实现多PDF文件的动态标签页显示。当用户上传或选择多个PDF文件时，每个文件将被读取为字节流，然后通过st.tabs为每个文件创建一个独立的标签页，并在对应的标签页中调用pdf_viewer来显示PDF内容。

以下是实现此功能的完整代码示例：

芦笋演示

一键出成片的录屏演示软件，专为制作产品演示、教学课程和使用教程而设计。

34

查看详情

import streamlit as st
from streamlit_pdf_viewer import pdf_viewer
import io

st.set_page_config(layout="wide") # 设置页面布局为宽屏，以更好地显示PDF
st.title("Streamlit 多PDF文件动态查看器")

st.markdown("""
本应用允许您上传多个PDF文件，并为每个文件动态创建独立的标签页进行查看。
当您取消选择某个文件时，对应的标签页将自动消失。
""")

# 使用st.file_uploader获取上传的PDF文件
# accept_multiple_files=True 允许用户上传多个文件
uploaded_files = st.file_uploader(
    "请上传PDF文件",
    type=["pdf"],
    accept_multiple_files=True
)

# 字典用于存储文件名和对应的PDF字节内容
# 这样可以方便地在st.tabs中使用文件名作为键，PDF内容作为值
pdf_contents = {}

if uploaded_files:
    for uploaded_file in uploaded_files:
        # 读取上传文件的字节内容
        # 使用io.BytesIO包装，确保pdf_viewer能正确处理
        pdf_bytes = io.BytesIO(uploaded_file.read())
        pdf_contents[uploaded_file.name] = pdf_bytes

    # 检查是否有PDF文件内容可供显示
    if pdf_contents:
        # 使用st.tabs创建动态标签页
        # list(pdf_contents.keys()) 将字典的键（文件名）作为标签页的标题
        # st.tabs会返回一个列表，其中每个元素都是一个with上下文管理器
        tabs = st.tabs(list(pdf_contents.keys()))

        # 遍历每个标签页，并在其中显示对应的PDF
        for i, file_name in enumerate(pdf_contents.keys()):
            with tabs[i]: # 进入当前标签页的上下文
                st.subheader(f"正在查看: {file_name}")
                # 调用pdf_viewer显示PDF内容
                # 注意：pdf_viewer可以直接接受io.BytesIO对象或字节数据
                pdf_viewer(pdf_contents[file_name].getvalue(), # 获取BytesIO的实际字节内容
                           height=700, # 设置PDF查看器的高度
                           width=800) # 设置PDF查看器的宽度 (可选，layout="wide"通常足够)
                st.markdown("---") # 分隔线
    else:
        st.info("请上传PDF文件以进行查看。")
else:
    st.info("请上传PDF文件以进行查看。")

st.markdown("---")
st.caption("由 `streamlit-pdf-viewer` 提供支持。")

代码解析：

1. st.file_uploader("请上传PDF文件", type=["pdf"], accept_multiple_files=True): 允许用户上传一个或多个PDF文件。uploaded_files会是一个列表，包含所有上传文件的UploadedFile对象。
2. pdf_contents = {}: 创建一个字典，用于存储每个上传文件的文件名（作为键）和其对应的字节内容（作为值）。
3. for uploaded_file in uploaded_files:: 遍历所有上传的文件。
4. pdf_bytes = io.BytesIO(uploaded_file.read()): 读取每个UploadedFile对象的原始字节内容，并将其封装在io.BytesIO对象中。streamlit-pdf-viewer可以直接处理字节流，无需将文件保存到临时磁盘。
5. pdf_contents[uploaded_file.name] = pdf_bytes: 将文件名和处理后的PDF字节流存储到pdf_contents字典中。
6. tabs = st.tabs(list(pdf_contents.keys())): 这是实现动态标签页的关键。st.tabs函数接受一个字符串列表作为标签页的标题。这里我们直接使用pdf_contents字典的所有键（即文件名）作为标签页的标题。Streamlit会根据这个列表动态创建标签页。
7. for i, file_name in enumerate(pdf_contents.keys()): with tabs[i]:: 遍历tabs列表和pdf_contents字典的键。with tabs[i]:语句确保后续的代码块内容只在当前选中的标签页中显示。
8. pdf_viewer(pdf_contents[file_name].getvalue(), ...): 在每个标签页内部，调用pdf_viewer来显示对应的PDF文件内容。pdf_contents[file_name].getvalue()用于从io.BytesIO对象中获取实际的字节数据。

动态增减标签页的原理：

当用户通过st.file_uploader上传或取消选择文件时，Streamlit应用会重新运行。在每次运行时，uploaded_files列表会根据用户的当前选择进行更新。这意味着pdf_contents字典也会随之更新。st.tabs(list(pdf_contents.keys()))会根据最新的pdf_contents字典的键来生成标签页。因此，如果用户取消选择某个文件，该文件将不再出现在pdf_contents的键中，其对应的标签页在下一次应用重运行时就不会被创建，从而实现了标签页的动态增减。

组件特性与使用注意事项

• 内置功能丰富：streamlit-pdf-viewer组件通常会提供基本的PDF查看功能，如页面导航（上下页）、缩放、适应宽度/高度等。这些功能通常是内置的，无需额外配置。
• 性能考量：对于非常大的PDF文件或同时加载大量PDF文件，可能会有较长的加载时间。建议对用户界面进行优化，例如显示加载指示器。
• 内存使用：将整个PDF文件读取到内存中（作为字节流）可能会消耗较多内存，特别是当处理大量大文件时。但对于大多数常见用例，这种方式是高效且方便的。
• 避免临时文件：使用io.BytesIO直接处理上传文件的字节流，避免了将文件写入磁盘的步骤，这不仅提升了效率，也减少了文件系统操作带来的潜在问题（如权限、清理等）。
• 用户体验：确保标签页的标题清晰明了，通常直接使用文件名即可。可以根据需要调整pdf_viewer的高度和宽度参数，以适应不同的屏幕尺寸和布局。

总结

通过结合streamlit-pdf-viewer组件和Streamlit内置的st.file_uploader与st.tabs功能，开发者可以轻松地在Streamlit应用中实现一个功能强大、用户友好的多PDF文件动态查看器。这种方法不仅简化了代码逻辑，提高了开发效率，还提供了出色的用户体验，满足了在不同PDF文件之间快速切换查看的需求。推荐在Streamlit项目中采用这种现代化的PDF处理方案。

以上就是Streamlit应用中动态显示多PDF文件于标签页的教程的详细内容，更多请关注php中文网其它相关文章！