wfork-streamlit-profiler 1.0.0__py3-none-any.whl → 1.1.0__py3-none-any.whl

wfork_streamlit_profiler/__init__.py

@@ -1,16 +1,35 @@
 import streamlit.components.v1 as components
 from pyinstrument import Profiler as OriginalProfiler
+from pyinstrument.profiler import AsyncMode
+from pyinstrument.session import Session
 
 
 class Profiler(OriginalProfiler):
-    def stop(self):
+    _auto_output_on_stop: bool
+
+    def __init__(
+        self,
+        interval: float = 0.001,
+        async_mode: AsyncMode = "enabled",
+        auto_output_on_stop: bool = True,
+    ):
+        super().__init__(interval, async_mode)
+        self._auto_output_on_stop = auto_output_on_stop
+
+    def stop(self) -> Session:
         session = super().stop()
-        
+
+        if self._auto_output_on_stop:
+            self.output_streamlit()
+
+        return session
+
+    def output_streamlit(self) -> None:
         # Create HTML report of profiling results.
         html = self.output_html()
 
         # Adapt style of html report to match Streamlit's design.
-        
+
         # Default colors for Streamlit's white theme.
         # TODO: Use streamlit's theme colors instead of hardcoding colors. Doesn't work 
         #   currently, see https://github.com/streamlit/streamlit/issues/4198.
@@ -80,5 +99,3 @@ class Profiler(OriginalProfiler):
 
         # Display modified HTML report in iframe.
         components.html(html, height=600)
-        
-        return session

{wfork_streamlit_profiler-1.0.0.dist-info → wfork_streamlit_profiler-1.1.0.dist-info}/METADATA

@@ -1,13 +1,12 @@
 Metadata-Version: 2.3
 Name: wfork-streamlit-profiler
-Version: 1.0.0
+Version: 1.1.0
 Summary: (fork of) Runtime profiler for Streamlit, powered by pyinstrument
 License: MIT
 Author: Wyatt S Carpenter
-Requires-Python: >=3.7,<4.0
+Requires-Python: >=3.8,<4.0
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
@@ -32,8 +31,6 @@ helps you find out which parts of your app are slow. It profiles the code via
 [pyinstrument](https://github.com/joerick/pyinstrument) and shows the results right
 within your Streamlit app.
 
-<sup>Alpha version, use with care.</sup>
-
 ---
 
 <h3 align="center">
@@ -54,19 +51,24 @@ pip install wfork-streamlit-profiler
 
 ## Usage
 
-```python
+```python3
 import streamlit as st
 from wfork_streamlit_profiler import Profiler
 
 with Profiler():
     st.title("My app")
     # ... other code
+```
+
+Or:
+```python3
+import streamlit as st
+from wfork_streamlit_profiler import Profiler
 
-# Or:
-# p = Profiler()
-# p.start()
-# ...
-# p.stop()
+p = Profiler()
+p.start()
+# ... other code
+p.stop()
 ```
 
 Then start your app as usual: `streamlit run my_app.py`
@@ -74,3 +76,5 @@ Then start your app as usual: `streamlit run my_app.py`
 The `Profiler` class is an extension of `pyinstrument.Profiler`, so you can use
 [all of its functions](https://pyinstrument.readthedocs.io/en/latest/reference.html#pyinstrument.Profiler).
 
+Don't want the profiler to immediately display when you stop profiling? Initialize it with `Profiler(auto_output_on_stop=False)` instead, and call the `.output_streamlit()` method whenever you want it to display, instead. You can also set the async_mode of the profiler in the pyinstrument in the same constructor, whatever that means.
+

wfork_streamlit_profiler-1.1.0.dist-info/RECORD

@@ -0,0 +1,5 @@
+wfork_streamlit_profiler/__init__.py,sha256=0pmPDhxnxIGuxbGbwfyTrXDHBeL8vp33n9SpGwwOyfk,3983
+wfork_streamlit_profiler-1.1.0.dist-info/LICENSE,sha256=Y9ej8y1BLFQZSAREXkrHmDgA0M35msgF8d6D9KoFf5c,1071
+wfork_streamlit_profiler-1.1.0.dist-info/METADATA,sha256=WKk-CC-15FRrN79TktsgvJXc91Nwj3Pj7BEB73DWt8k,2873
+wfork_streamlit_profiler-1.1.0.dist-info/WHEEL,sha256=fGIA9gx4Qxk2KDKeNJCbOEwSrmLtjWCwzBz351GyrPQ,88
+wfork_streamlit_profiler-1.1.0.dist-info/RECORD,,

{wfork_streamlit_profiler-1.0.0.dist-info → wfork_streamlit_profiler-1.1.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 2.0.1
+Generator: poetry-core 2.1.2
 Root-Is-Purelib: true
 Tag: py3-none-any

wfork_streamlit_profiler-1.0.0.dist-info/RECORD

@@ -1,5 +0,0 @@
-wfork_streamlit_profiler/__init__.py,sha256=LVSu6yccrR7AYARUDZmk2R9gQlvEnOR_zbgq_jH6iKQ,3503
-wfork_streamlit_profiler-1.0.0.dist-info/LICENSE,sha256=Y9ej8y1BLFQZSAREXkrHmDgA0M35msgF8d6D9KoFf5c,1071
-wfork_streamlit_profiler-1.0.0.dist-info/METADATA,sha256=H4P6JD6-9JMFFZODTBLKuuYsEPR0LASv1TSlNVo6CBY,2539
-wfork_streamlit_profiler-1.0.0.dist-info/WHEEL,sha256=IYZQI976HJqqOpQU6PHkJ8fb3tMNBFjg-Cn-pwAbaFM,88
-wfork_streamlit_profiler-1.0.0.dist-info/RECORD,,