Streamlit의 유지보수와 디버깅 팁

Streamlit

Author

gabriel yang

Published

September 18, 2024

Streamlit은 데이터 과학 및 머신러닝 애플리케이션을 쉽고 빠르게 웹으로 배포할 수 있는 훌륭한 도구입니다. 하지만 애플리케이션을 개발하거나 배포하는 과정에서 유지보수와 디버깅은 필수적입니다. 이 글에서는 Streamlit 애플리케이션의 유지보수 및 디버깅에 유용한 팁과 실전 예시를 소개하겠습니다.

1. Streamlit 유지보수의 중요성

Streamlit은 사용하기 쉽지만, 복잡한 애플리케이션을 개발하다 보면 예상치 못한 오류가 발생할 수 있습니다. 또한, 애플리케이션을 배포한 후에도 새로운 기능을 추가하거나 버그를 수정하는 과정이 필요합니다. 따라서 유지보수와 디버깅을 통해 애플리케이션의 안정성을 높이고 성능을 최적화하는 것이 중요합니다.

2. 디버깅을 위한 기본 도구 및 방법

Streamlit에서 발생하는 오류를 쉽게 해결하려면 몇 가지 디버깅 도구를 활용할 수 있습니다. 이 섹션에서는 기본적인 디버깅 방법을 소개합니다.

2.1 `st.write()` 및 `st.error()` 사용

st.write()는 코드에서 변수나 객체의 상태를 출력하는 데 유용합니다. 이를 활용하여 변수의 상태를 실시간으로 확인하거나 함수의 출력 값을 시각적으로 확인할 수 있습니다. 또한, 오류가 발생하는 부분에서는 st.error()를 사용하여 명확하게 오류 메시지를 표시할 수 있습니다.

import streamlit as st

def divide_numbers(a, b):
    try:
        result = a / b
        return result
    except ZeroDivisionError:
        st.error("0으로 나눌 수 없습니다.")
        return None

st.write("Result:", divide_numbers(10, 2))  # 정상 출력
st.write("Result:", divide_numbers(10, 0))  # 에러 출력

2.2 `st.exception()` 사용

예외 처리 시 st.exception()을 사용하면 Streamlit 인터페이스에 예외와 관련된 자세한 정보를 표시할 수 있습니다. 이를 통해 오류가 발생한 위치와 원인을 명확하게 파악할 수 있습니다.

import streamlit as st

try:
    x = 1 / 0
except Exception as e:
    st.exception(e)

2.3 `st.sidebar()` 활용

애플리케이션이 복잡해질수록 데이터를 시각적으로 확인하는 것이 중요합니다. st.sidebar()를 활용하여 주요 변수나 상태를 사이드바에 배치하면, 애플리케이션 흐름을 쉽게 파악할 수 있습니다.

import streamlit as st

x = 42
st.sidebar.write("Current value of x:", x)

3. 예시: 실시간 디버깅 적용

실시간으로 변수를 추적하고 문제가 발생할 때 즉시 원인을 파악하는 실시간 디버깅 예제를 살펴보겠습니다.

import streamlit as st
import numpy as np

st.title('실시간 디버깅 예시')

# 변수 상태 확인
a = 10
b = st.number_input("나누기 값을 입력하세요", min_value=1, max_value=100, value=5)

# 실시간 값 출력
st.write("a의 값:", a)
st.write("b의 값:", b)

# 나눗셈 계산 및 예외 처리
try:
    result = a / b
    st.write("결과:", result)
except Exception as e:
    st.error("오류 발생!")
    st.exception(e)

이 예시는 사용자가 입력한 값으로 실시간 계산을 수행하고, 만약 문제가 발생하면 즉시 오류를 출력하여 디버깅을 도울 수 있습니다.

4. Streamlit 애플리케이션 최적화 및 유지보수 팁

디버깅 외에도 애플리케이션을 원활하게 유지보수하고 성능을 향상시키기 위한 몇 가지 팁을 소개합니다.

4.1 캐싱을 통한 성능 향상 (`@st.cache_data` 활용)

Streamlit 애플리케이션에서 반복적으로 계산되거나 다운로드되는 데이터를 캐싱하면 성능을 크게 향상시킬 수 있습니다. 캐시는 불필요한 데이터 재처리를 방지해 애플리케이션의 응답 속도를 높여줍니다.

import streamlit as st
import pandas as pd

@st.cache_data
def load_data():
    # 예시 데이터 로드
    df = pd.read_csv('data.csv')
    return df

df = load_data()
st.write(df)

4.2 성능 문제 추적

Streamlit 애플리케이션이 느리다면, 주기적으로 리소스를 많이 소비하는 부분을 추적해야 합니다. time 라이브러리의 time() 함수를 사용하여 함수 실행 시간을 측정하고, 성능 문제를 디버깅할 수 있습니다.

import time
import streamlit as st

start_time = time.time()

# 성능이 느린 작업 예시
for i in range(1000000):
    pass

end_time = time.time()
st.write(f"작업 실행 시간: {end_time - start_time} 초")

4.3 에러 로그 확인

Streamlit은 애플리케이션 실행 중 발생한 오류를 터미널에 기록합니다. 개발 중에는 터미널 로그를 자주 확인하여 오류나 경고를 모니터링하는 것이 좋습니다. 이를 통해 문제가 발생한 부분을 더 빠르게 찾을 수 있습니다.

4.4 버전 관리

Streamlit 애플리케이션의 종속성을 관리하고 팀 간 협업 시 일관된 개발 환경을 유지하기 위해 requirements.txt 파일을 관리하는 것이 좋습니다.

pip freeze > requirements.txt

이렇게 생성된 requirements.txt 파일을 통해 다른 사용자도 동일한 종속성을 설치할 수 있습니다.

5. 결론

Streamlit 애플리케이션을 유지보수하고 디버깅하는 과정은 필수적입니다. st.write(), st.error(), st.exception() 등 기본적인 디버깅 도구를 활용하면 문제를 더 쉽게 추적할 수 있습니다. 또한, 캐싱, 성능 최적화, 에러 로그 모니터링 등을 통해 애플리케이션을 최적화할 수 있습니다.