forked from streamlit/streamlit
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathst_help.py
84 lines (64 loc) · 3.26 KB
/
st_help.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
# Copyright (c) Streamlit Inc. (2018-2022) Snowflake Inc. (2022-2024)
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import streamlit as st
from streamlit.elements.doc_string import _get_scriptrunner_frame
if _get_scriptrunner_frame() is None:
st.warning(
"""
You're running this script in an `exec` context, so the `foo` part
of `st.help(foo)` will not appear inside the displayed `st.help` element.
"""
)
# Testing case where there are no docs.
class FooWithNoDocs:
my_static_var_1 = 123
st.help(FooWithNoDocs)
# Testing case where there are no members.
st.help(globals)
# Test case where there the docs need to scroll,
# and test case where some members doesn't have docs.
class FooWithLongDocs:
"""My docstring.
This is a very long one! You probably need to scroll, scroll, scroll, scroll,
scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll,
scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll,
scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll,
scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll,
scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll.
Scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll,
scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll,
scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll,
scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll.
Scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll,
scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll,
scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll,
scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll.
Scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll,
scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll,
scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll,
scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll.
Scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll,
scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll,
scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll,
scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll, scroll.
"""
def __init__(self):
self.my_var_1 = 123
def my_func_1(self, a, b=False):
"Func with doc."
def my_func_2(self):
# Func without doc.
pass
f = FooWithLongDocs()
f