显示给定对象的帮助和其他信息。

根据传入的对象类型,这将显示对象的名称、类型、值、签名、文档字符串和成员变量、方法——以及成员和方法的文档字符串。

函数签名[source]

st.help(obj=)

参数

obj (any)

应显示信息的对象。如果未指定,此调用将显示Streamlit本身的帮助信息。

示例

不记得如何初始化一个数据框?试试这个:

import streamlit as st
import pandas

st.help(pandas.DataFrame)

想快速检查某个函数输出的数据类型是什么? 试试:

import streamlit as st

x = my_poorly_documented_function()
st.help(x)

想要快速检查一个对象吗?没问题:

class Dog:
  '''A typical dog.'''

  def __init__(self, breed, color):
    self.breed = breed
    self.color = color

  def bark(self):
    return 'Woof!'


fido = Dog("poodle", "white")

st.help(fido)

如果你正在使用Magic,你可以在不输入st.help的情况下获取函数、类和模块的帮助:

import streamlit as st
import pandas

# Get help for Pandas read_csv:
pandas.read_csv

# Get help for Streamlit itself:
st
forum

还有问题吗?

我们的 论坛 充满了有用的信息和Streamlit专家。