تقدير المشروع
← كل المقالات

Streamlit للتطبيقات التجريبية البسيطة: المزايا والعيوب

هل صادفت يومًا عرضًا تجريبيًا لنموذج تعلّم آلة بواجهة رسومية أنيقة؟ على الأرجح أنه بُني باستخدام Streamlit. تابع القراءة لتعرف المزيد عن هذا الإطار.

9 دقائق قراءة
تعلّم الآلةStreamlitPythonتصوّر البياناتالنماذج الأولية

ما هو Streamlit؟

هل صادفت يومًا عرضًا تجريبيًا لنموذج تعلّم آلة بواجهة رسومية أنيقة؟ على الأرجح أنه بُني بإطار Streamlit. Streamlit هو إطار عمل مفتوح المصدر بلغة Python للنمذجة الأولية السريعة وبناء التصورات ولوحات المعلومات، ولا يتطلب أي معرفة بتقنيات الواجهة الأمامية مثل JS أو HTML. وتكفي بضعة أسطر من الشيفرة لبناء تطبيقات ديناميكية جميلة المظهر يستطيع المستخدمون فيها إدخال البيانات ورؤية النتائج في الوقت الفعلي. وعند تشغيل تطبيق Streamlit تُنفَّذ شيفرة Python وتنتج HTML وCSS وJavaScript اللازمة لعرض التطبيق في متصفح الويب.

فيمَ يُستخدم؟

غرضه الرئيسي بناء تطبيقات ويب بسيطة تعرض كيفية عمل نماذج تعلّم الآلة أو الخوارزميات، أو تقدّم البيانات. ويأتي مع عدد جيد من الودجات الجاهزة لإدخال المعاملات وعرض أنواع مختلفة من البيانات - من النصوص مرورًا بالصور وصولًا إلى الصوت. وهذه العناصر مبنية بـ JS لكنها تكشف واجهة Python بسيطة. ولأنه سهل الاستخدام للغاية، فهو مناسب للنمذجة الأولية السريعة وبناء التطبيقات التجريبية.

وقد طُبّقت معظم المواضيع التي تغطيها هذه المقالة عمليًا في تطبيق تجريبي.

المزايا

إليك ما نقدّره في هذا الإطار.

حالة الجلسة

بما أن الإطار تفاعلي بطبيعته، يُعاد تشغيل التطبيق كلما تغيرت حالته واحتاج المشهد إلى التحديث. وتوجد حالة الجلسة (session state) للاحتفاظ بحالة التطبيق عبر عمليات إعادة التشغيل هذه. والتطبيق المبني بهذه الطريقة يدور حول قراءة القيم من حالة الجلسة وكتابتها فيها، مما يجعلها جزءًا مركزيًا في كل تطبيق يُكتب بهذا الإطار. وحالة الجلسة آمنة على مستوى الخيوط: فلكل جلسة حالتها الخاصة، لذا لن يزعج عدة مستخدمين حالة تطبيق بعضهم بعضًا. وهي متغير عام على مستوى الحزمة وله الواجهة نفسها لقاموس Python العادي.

حالات الودجات التفاعلية

قراءة حالة الودجات وتحديثها، مثل مربع الاختيار، أمر بسيط. فكل ما عليك هو تعريف مفتاح في قاموس حالة الجلسة تُحفظ تحته حالة الودجة – لا شيء أكثر. ومن هناك يمكننا الانتقال إلى كتابة منطق التطبيق.

view.py

import streamlit as st

from demo_streamlit.callbacks import sample_index_callback
from demo_streamlit.load_data import load_dataset
from demo_streamlit.settings import Settings

def sidebar_view() -> None:
    """Draw side bar."""
    samples = load_dataset()
    st.sidebar.selectbox(
        "Select sample index:",
        options=list(range(0, len(samples))),
        key=Settings.selected_sample_index,
        on_change=sample_index_callback,
    )

وتُسترجع قيمة الودجة باستخدام مفتاحها:

app_state.py

from dataclasses import dataclass

import streamlit as st

from demo_streamlit.settings import Settings

@dataclass
class AppState:
    """An app state model."""

    selected_sample_index: int
    """Selected sample index."""

    message: str
    """UI message."""

def get_app_state() -> AppState:
    """Get AppState dataclass from session state."""
    return AppState(
        selected_sample_index=int(
            st.session_state.get(Settings.selected_sample_index, 0)
        ),
        message=st.session_state.get(Settings.message, ""),
    )

عناصر singleton والذاكرة المؤقتة الآمنة على مستوى الخيوط

الذاكرة المؤقتة ميزة شائعة الاستخدام تتيح لك تحسين العمليات المستهلكة للوقت عند تحديث عرض التطبيق. وآلية التخزين المؤقت المضمّنة في الإطار سهلة الاستخدام جدًا. فهي تعتمد على المزخرِف @st.cache، حيث يمكنك أن تضبط مثلًا معامل مدة البقاء (TTL) ودوال التجزئة للكائنات المخصصة. وتأخذ الذاكرة المؤقتة في الحسبان الوسائط، وجسم الدالة مع كل دالة تستدعيها، وأي متغيرات خارجية تستخدمها الدالة. ولأن الإطار تفاعلي ويعيد رسم الواجهة عند كل تغيّر في الحالة، فإن التخزين المؤقت لا غنى عنه للحفاظ على سرعة التطبيق واستجابته بشكل معقول.

تعرّف الشيفرة التالية دالة تعيد الكائنات المخزنة في قاعدة البيانات والتي تطابق استعلامًا. ولأن تنفيذها يستغرق بعض الوقت، فقد حُسّنت بآلية التخزين المؤقت، وضُبط معامل TTL على 10 دقائق. وللكائنات التي لا يستطيع الإطار تجزئتها بنفسه، زُوّدت دوال تجزئة مخصصة. وبالنسبة للكائنات المعقدة، تعيد هذه الدوال None، مما يستبعد تلك الكائنات من حساب التجزئة.

database.py

@st.cache(
    hash_funcs={
        Collection: lambda _: None,
        database.Database: lambda _: None,
        MongoClient: lambda _: None,
    },
    ttl=600,  # TTL value in seconds
)
def list_items(
    self,
    query: dict[str, Any] | None = None,
) -> list[dict[str, Any]]:
        if query is None:
            query = {}

        items: list[dict[str, Any]] = [item for item in self._collection.find(query, sort=[("timestamp_created", -1)])]

        return items

ردود نداء مرنة للودجات

الإطار مرن جدًا في تعريف ردود النداء (callbacks) لأحداث الودجات. توجد أحداث قليلة فقط، لكنها تغطي معظم الاحتياجات: on_click وon_change. وعند إنشاء ودجة، يمكننا تمرير دالة إلى on_click أو on_change تُستدعى عند وقوع الحدث. ويمكننا أيضًا تمرير معاملات اعتباطية على شكل صف (tuple) عبر الوسيط args.

callback.py

import logging
from typing import Any

import streamlit as st

logger = logging.getLogger(__name__)

def button_callback(index: str, headers: dict[str, Any] | None) -> None:
    """Button on_click callback."""
    logger.info(  # pylint: disable = (logging-fstring-interpolation)
        f"Passed arguments: ({index}, {headers})."
    )

view.py

import streamlit as st
from streamlit.web.server.websocket_headers import _get_websocket_headers

from demo_streamlit.callbacks import button_callback
from demo_streamlit.settings import Settings

def sidebar_view() -> None:
    """Draw side bar."""
    headers: dict[str, str] | None = _get_websocket_headers()
    if headers:
        with st.sidebar.expander("HTTP header"):
            st.json(headers)

    st.sidebar.button(
        label="Log parameters to terminal",
        on_click=button_callback,
        args=(
            st.session_state.get(Settings.selected_sample_index, 0),
            headers,
        ),
    )

وبعد النقر على الزر، أظهرت الطرفية المخرجات التالية:

معاملات الاستعلام لحفظ حالة التطبيق في عنوان URL

عندما يستخدم عدة أشخاص التطبيق، قد يرغبون في مشاركة إعداداته مع بعضهم. وهذا هو غرض وظيفة query_params في الإطار. فالدالة st.experimental_set_query_params تقبل قاموسًا يُحوَّل إلى معاملات GET في عنوان URL. وبالطريقة نفسها، تقرأ الدالة st.experimental_set_query_params قاموسًا من المعاملات من عنوان URL. وهذا يتيح إرسال عنوان URL يحوي المعاملات المحفوظة إلى شخص ما، بحيث يعرض له فتح التطبيق العرض نفسه تمامًا. والمشكلة هي صيغة البيانات المدعومة، التي يجب أن تكون dict[str, list[str]].

مزخرِفات Python لتحديثات الحالة

تستحق المزخرِفات (decorators) النظر في العمليات التي تتكرر باستمرار. فتحديث query_params مثلًا يمكن تغليفه في مزخرِف وإلحاقه بكل رد نداء يستجيب لتغيّرات حالة الودجات.

query_params.py

from functools import wraps

import streamlit as st

def update_query_params() -> None:
    """Updates the URL query params."""
    query_params: dict[str, list[str]] = dict()
    query_params["text_input"] = [st.session_state.get("text_input", "")]
    query_params["checkbox_state"] = [str(st.session_state.get("checkbox_state", False))]
    st.experimental_set_query_params(**query_params)

def refresh_query_params(f):
    """Updates the URL query params after every app state change."""

    @wraps(f)
    def wrapper(*args, **kwargs):
        retval = f(*args, **kwargs)
        update_query_params()
        return retval

    return wrapper

callback.py

from query_params import refresh_query_params

@refresh_query_params
def checbox_callback() -> None:
    ...

 @refresh_query_params
def text_input_callback() -> None:
    ...

وضع خادم التطوير مع مراقبة التغييرات في الشيفرة

هذا مفيد ببساطة. لا حاجة إلى إعادة تشغيل التطبيق بعد كل تعديل على شيفرته المصدرية. فبشكل افتراضي يشغّل streamlit التطبيقات في وضع المطوّر الذي يراقب الشيفرة المصدرية بحثًا عن التعديلات. وتُلتقط كل تغييرات، ويكيّف التطبيق سلوكه فورًا.

الوصول إلى ترويسات طلبات HTTP

بدءًا من الإصدار 1.14.0، يمكنك قراءة ترويسة HTTP الخام التي وصلت إلى التطبيق. وهذا مفيد عندما تحتاج إلى استخراج معلومات محددة من ترويسات HTTP، مثل معرّف/بريد مستخدم تمت مصادقته عبر Google Cloud:

import streamlit as st
from streamlit.web.server.websocket_headers import _get_websocket_headers

headers = _get_websocket_headers()
access_token = headers.get("X-Access-Token")
if access_token is not None:
  # authenticate the user or whatever
  ...

النشر

نشر التطبيق سهل جدًا، وتغطيه الوثائق بالتفصيل. فهي تشرح كيفية النشر باستخدام Docker أو kubernetes أو حاويات Streamlit Cloud. ويأتي كل دليل مع مقتطفات شيفرة نموذجية، بحيث يُرشَد المستخدم خلال العملية كلها خطوة بخطوة.

ولإطلاق تطبيق على Streamlit Cloud، كل ما تحتاجه هو رابط إلى مستودع GitHub. وبعد بضع نقرات نحصل على عنوان URL عام يتوفر عليه تطبيقنا العامل.

العيوب

فيما يلي نقاط ضعف الإطار التي يجدر وضعها في الحسبان أثناء تصميم التطبيق.

يُعاد رسم المشهد في كل مرة تتغير فيها الحالة

كما ذُكر سابقًا، فإن كل تغيير في حالة الواجهة يجعل التطبيق ينفذ شيفرته من البداية، مع حفظ حالة التطبيق كلها في حالة الجلسة. وعندما تتغير حالات الودجات كثيرًا، قد يتحدث التطبيق بوتيرة مزعجة، مما يضيف تأخيرًا كبيرًا. ويدفعك هذا السلوك إلى تصميم التطبيق بحيث تُخزَّن أكبر عدد ممكن من الدوال البطيئة مؤقتًا، لكن ذلك لا يكفي لأنواع معينة من التطبيقات.

لا يمكن تداخل الحاويات

لا يمكن تداخل العروض، مما يحد بشكل كبير من طريقة تصميم تخطيط التطبيق. ويصبح هذا مشكلة في العروض الأكثر تعقيدًا أو عندما تريد عرض كائنين معقدين جنبًا إلى جنب للمقارنة. وبسبب هذا القيد، علينا إيجاد حلول بديلة قد تكون أقل راحة.

حالة الجلسة بأزواج مفتاح–قيمة بسيطة فقط

تعمل حالة الجلسة بشكل جيد جدًا مع أزواج المفتاح–القيمة البسيطة، مثل حفظ حالات الودجات. أما التطبيقات الواقعية فتعتمد في الغالب على كائنات معقدة تحمل حالة التطبيق بأكمله. وبهذه الطريقة يمثل كائن واحد التطبيق بأكمله، ويمكن فرض أنواع حقول صنفه. للأسف لا يدعم الإطار ذلك حاليًا. وللحصول على هذه النتيجة، علينا كتابة دالتين لتحميل صنف من حالة الجلسة وحفظه فيها.

app_state.py

import streamlit as st
from dataclasses import dataclass

@dataclass
class AppState:
    checkbox_state: bool
    text_input: str

def load_app_state() -> AppState:
    return AppState(
        checkbox_state=st.session_state.get("checkbox_state", False),
        text_input=st.session_state.get("text_input", ""),
    )

def save_app_state(state: AppState) -> None:
    st.session_state["checkbox_state"] = state.checkbox_state
    st.session_state["text_input"] = state.text_input

تكرار العناصر في الشيفرة عند إعادة استخدام الودجات/الحاويات

تتطلب مقارنة كائنين الاحتفاظ بمجموعة من المتغيرات لكليهما في حالة الجلسة. وبما أن حالة الجلسة تحتفظ بأزواج مفتاح–قيمة، فعلينا إما أن نحتفظ بقائمة عناصر تحت مفتاح واحد أو أن نعرّف مفاتيح منفصلة لكل كائن، مثل text_input_1 وtext_input_2. وهذا ليس أنيقًا ويزيد احتمال الأخطاء.

الحاجة إلى إسقاط العناصر من حالة الجلسة

الكائنات المخزنة في حالة الجلسة ليس لها نوع مصرّح به، لذا لا يمكننا التأكد من نوع الكائن الذي سنحصل عليه. وللاحتياط، يمكننا تطبيق الدالة cast من الحزمة typing.

cast_example.py

import streamlit as st
from typing import cast, Any

value: list[str]
value = cast(list[str], st.session_state["key"])

الخلاصة

Streamlit إطار ممتاز لبناء التطبيقات التجريبية البسيطة. وعندما تتغير حالة التطبيق كثيرًا، قد تؤدي إعادة رسم المشهد من الصفر بعد كل تغيير إلى مشكلات في الأداء والتأخير. وثمة قيد آخر هو أن الحاويات مثل العمود لا يمكن تداخلها، مما يضيّق خيارات تخطيط الصفحة.

وتتيح الميزات التي يقدمها الإطار، ومنها حالة الجلسة والذاكرة المؤقتة وردود نداء الودجات، بناء مسارات تطبيق معقدة بسرعة.

وفي التطبيقات الأكثر تعقيدًا، قد تواجه قيودًا ناتجة عن طريقة تصميم الإطار. ومن الجيد أن توازن بين متطلبات التطبيق الذي تبنيه وتقرر ما إذا كان Streamlit هو الخيار المناسب. توجد أطر عمل كثيرة مماثلة تختلف في التعقيد والإمكانات؛ ويمكنك الاطلاع على مقارنة بينها هنا.