Refactor and test examples

Signed-off-by: Tim Paine <[email protected]>
Point72 · Feb 13, 2024 · 6b90b42 · 6b90b42
1 parent 388eb26
commit 6b90b42
Show file tree

Hide file tree

Showing 43 changed files with 44 additions and 67 deletions.
diff --git a/.gitignore b/.gitignore
@@ -78,6 +78,9 @@ lib-cov
 coverage
 junit.xml
 
+# Temp files
+tmp*.*
+
 # Documentation
 docs/_build/
 /site
@@ -100,9 +103,6 @@ csp/include/
 csp/lib/
 *.so
 *.tsbuildinfo
-csp/extension
-csp/nbextension
-csp/labextension
 
 # Jupyter / Editors
 .ipynb_checkpoints

diff --git a/MANIFEST.in b/MANIFEST.in
@@ -17,10 +17,12 @@ prune _skbuild
 include vcpkg.json
 prune vcpkg
 
-# IDE / VCS files
+# IDE / VCS / docs files
 prune .git
 prune .github
 prune .vscode
+prune ci
+prune examples
 exclude .clang-format
 exclude .gitattributes
 exclude .gitignore

diff --git a/csp/examples/e_03_numba_simple_example.py b/csp/examples/e_03_numba_simple_example.py
diff --git a/csp/examples/e_24_cpp_struct_example/mystruct/__init__.py b/csp/examples/e_24_cpp_struct_example/mystruct/__init__.py
diff --git a/csp/tests/test_examples.py b/csp/tests/test_examples.py
@@ -0,0 +1,26 @@
+
+import importlib
+import os.path
+import pytest
+import sys
+
+EXAMPLES_ROOT = os.path.abspath(os.path.join(os.path.dirname(__file__), "..", "..", "examples"))
+
+# make examples importable without keeping in source tree
+sys.path.append(EXAMPLES_ROOT)
+
+def _get_module(folder, filename):
+    # Don't fail during test gathering
+    try:
+        return importlib.import_module(f"{folder}.{filename.replace('.py', '')}")
+    except BaseException:
+        return None
+
+def _get_modules_to_test(folder):
+    return [(file, _get_module(folder, file)) for file in os.listdir(os.path.join(EXAMPLES_ROOT, "1_basics")) if file.endswith(".py")]
+
+class TestExamples:
+    @pytest.mark.parametrize("filename,module", _get_modules_to_test("1_basics"))
+    def test_1_basics(self, filename, module):
+        assert module.main
+        module.main()
diff --git a/csp/examples/e_01_trade_pnl.py → examples/1_basics/e_01_trade_pnl.py b/csp/examples/e_01_trade_pnl.py → examples/1_basics/e_01_trade_pnl.py
@@ -93,11 +93,7 @@ def my_graph():
 
 def main():
     start = datetime(2020, 1, 1)
-    show_graph = False
-    if show_graph:
-        csp.showgraph.show_graph(my_graph)
-    else:
-        csp.run(my_graph, starttime=start)
+    csp.run(my_graph, starttime=start)
 
 
 if __name__ == "__main__":

diff --git a/csp/examples/e_02_show_graph.py → examples/1_basics/e_02_show_graph.py b/csp/examples/e_02_show_graph.py → examples/1_basics/e_02_show_graph.py
@@ -25,10 +25,12 @@ def my_graph():
     csp.print("spread2", s2)
 
 
+def main():
+    # open in graphviz viewer
+    # csp.show_graph(my_graph)
+    # or output to file
+    csp.show_graph(my_graph, graph_filename="tmp.png")
+    csp.run(my_graph, starttime=datetime(2020, 3, 1), endtime=timedelta(seconds=10))
+
 if __name__ == "__main__":
-    csp.show_graph(my_graph)
-    realtime = True
-    if realtime:
-        csp.run(my_graph, starttime=datetime.utcnow(), endtime=timedelta(seconds=10), realtime=True)
-    else:
-        csp.run(my_graph, starttime=datetime(2020, 3, 1), endtime=timedelta(seconds=10))
+    main()
diff --git a/csp/examples/e_13_feedback.py → examples/2_intermediate/e_13_feedback.py b/csp/examples/e_13_feedback.py → examples/2_intermediate/e_13_feedback.py
diff --git a/csp/examples/e_15_dynamic.py → examples/2_intermediate/e_15_dynamic.py b/csp/examples/e_15_dynamic.py → examples/2_intermediate/e_15_dynamic.py
diff --git a/csp/examples/e_19_exprtk_example.py → ...les/2_intermediate/e_19_exprtk_example.py b/csp/examples/e_19_exprtk_example.py → ...les/2_intermediate/e_19_exprtk_example.py
diff --git a/csp/examples/e_20_stats.py → examples/2_intermediate/e_20_stats.py b/csp/examples/e_20_stats.py → examples/2_intermediate/e_20_stats.py
diff --git a/csp/examples/e_21_numpy_stats.py → examples/2_intermediate/e_21_numpy_stats.py b/csp/examples/e_21_numpy_stats.py → examples/2_intermediate/e_21_numpy_stats.py
diff --git a/csp/examples/e_06_parquet_writer_example.py → ...g_adapters/e_06_parquet_writer_example.py b/csp/examples/e_06_parquet_writer_example.py → ...g_adapters/e_06_parquet_writer_example.py
diff --git a/csp/examples/e_08_kafka.py → examples/3_using_adapters/e_08_kafka.py b/csp/examples/e_08_kafka.py → examples/3_using_adapters/e_08_kafka.py
diff --git a/csp/examples/e_11_websocket_output.py → ...3_using_adapters/e_11_websocket_output.py b/csp/examples/e_11_websocket_output.py → ...3_using_adapters/e_11_websocket_output.py
diff --git a/csp/examples/e_14_generic_push_adapter.py → ...ing_adapters/e_14_generic_push_adapter.py b/csp/examples/e_14_generic_push_adapter.py → ...ing_adapters/e_14_generic_push_adapter.py
diff --git a/...amples/e_14_user_adapters_01_pullinput.py → ...apters/e_14_user_adapters_01_pullinput.py b/...amples/e_14_user_adapters_01_pullinput.py → ...apters/e_14_user_adapters_01_pullinput.py
diff --git a/...er_adapters_02_adaptermanager_siminput.py → ...er_adapters_02_adaptermanager_siminput.py b/...er_adapters_02_adaptermanager_siminput.py → ...er_adapters_02_adaptermanager_siminput.py
diff --git a/...amples/e_14_user_adapters_03_pushinput.py → ...apters/e_14_user_adapters_03_pushinput.py b/...amples/e_14_user_adapters_03_pushinput.py → ...apters/e_14_user_adapters_03_pushinput.py
diff --git a/...r_adapters_04_adaptermanager_pushinput.py → ...r_adapters_04_adaptermanager_pushinput.py b/...r_adapters_04_adaptermanager_pushinput.py → ...r_adapters_04_adaptermanager_pushinput.py
diff --git a/...es/e_14_user_adapters_05_outputadapter.py → ...rs/e_14_user_adapters_05_outputadapter.py b/...es/e_14_user_adapters_05_outputadapter.py → ...rs/e_14_user_adapters_05_outputadapter.py
diff --git a/...adapters_06_adaptermanager_inputoutput.py → ...adapters_06_adaptermanager_inputoutput.py b/...adapters_06_adaptermanager_inputoutput.py → ...adapters_06_adaptermanager_inputoutput.py
diff --git a/csp/examples/e_23_cpp_example/CMakeLists.txt → examples/5_cpp/1_cpp_node/CMakeLists.txt b/csp/examples/e_23_cpp_example/CMakeLists.txt → examples/5_cpp/1_cpp_node/CMakeLists.txt
diff --git a/csp/examples/e_23_cpp_example/README.md → examples/5_cpp/1_cpp_node/README.md b/csp/examples/e_23_cpp_example/README.md → examples/5_cpp/1_cpp_node/README.md
diff --git a/csp/examples/e_23_cpp_example/piglatin.cpp → examples/5_cpp/1_cpp_node/piglatin.cpp b/csp/examples/e_23_cpp_example/piglatin.cpp → examples/5_cpp/1_cpp_node/piglatin.cpp
diff --git a/...les/e_23_cpp_example/piglatin/__init__.py → ...les/5_cpp/1_cpp_node/piglatin/__init__.py b/...les/e_23_cpp_example/piglatin/__init__.py → ...les/5_cpp/1_cpp_node/piglatin/__init__.py
diff --git a/...les/e_23_cpp_example/piglatin/__main__.py → ...les/5_cpp/1_cpp_node/piglatin/__main__.py b/...les/e_23_cpp_example/piglatin/__main__.py → ...les/5_cpp/1_cpp_node/piglatin/__main__.py
diff --git a/csp/examples/e_23_cpp_example/pyproject.toml → examples/5_cpp/1_cpp_node/pyproject.toml b/csp/examples/e_23_cpp_example/pyproject.toml → examples/5_cpp/1_cpp_node/pyproject.toml
diff --git a/csp/examples/e_23_cpp_example/setup.py → examples/5_cpp/1_cpp_node/setup.py b/csp/examples/e_23_cpp_example/setup.py → examples/5_cpp/1_cpp_node/setup.py
diff --git a/...amples/e_24_cpp_struct_example/.gitignore → ...s/5_cpp/2_cpp_node_with_struct/.gitignore b/...amples/e_24_cpp_struct_example/.gitignore → ...s/5_cpp/2_cpp_node_with_struct/.gitignore
diff --git a/...es/e_24_cpp_struct_example/CMakeLists.txt → ...cpp/2_cpp_node_with_struct/CMakeLists.txt b/...es/e_24_cpp_struct_example/CMakeLists.txt → ...cpp/2_cpp_node_with_struct/CMakeLists.txt
diff --git a/...xamples/e_24_cpp_struct_example/README.md → ...es/5_cpp/2_cpp_node_with_struct/README.md b/...xamples/e_24_cpp_struct_example/README.md → ...es/5_cpp/2_cpp_node_with_struct/README.md
diff --git a/csp/examples/__init__.py → ...cpp_node_with_struct/mystruct/__init__.py b/csp/examples/__init__.py → ...cpp_node_with_struct/mystruct/__init__.py
diff --git a/...4_cpp_struct_example/mystruct/__main__.py → ...cpp_node_with_struct/mystruct/__main__.py b/...4_cpp_struct_example/mystruct/__main__.py → ...cpp_node_with_struct/mystruct/__main__.py
diff --git a/.../e_24_cpp_struct_example/mystruct/node.py → ...p/2_cpp_node_with_struct/mystruct/node.py b/.../e_24_cpp_struct_example/mystruct/node.py → ...p/2_cpp_node_with_struct/mystruct/node.py
diff --git a/..._24_cpp_struct_example/mystruct/struct.py → ...2_cpp_node_with_struct/mystruct/struct.py b/..._24_cpp_struct_example/mystruct/struct.py → ...2_cpp_node_with_struct/mystruct/struct.py
diff --git a/...es/e_24_cpp_struct_example/pyproject.toml → ...cpp/2_cpp_node_with_struct/pyproject.toml b/...es/e_24_cpp_struct_example/pyproject.toml → ...cpp/2_cpp_node_with_struct/pyproject.toml
diff --git a/...examples/e_24_cpp_struct_example/setup.py → ...les/5_cpp/2_cpp_node_with_struct/setup.py b/...examples/e_24_cpp_struct_example/setup.py → ...les/5_cpp/2_cpp_node_with_struct/setup.py
diff --git a/...amples/e_24_cpp_struct_example/struct.cpp → ...s/5_cpp/2_cpp_node_with_struct/struct.cpp b/...amples/e_24_cpp_struct_example/struct.cpp → ...s/5_cpp/2_cpp_node_with_struct/struct.cpp
diff --git a/csp/examples/e_12_caching_example.py → examples/6_advanced/e_12_caching_example.py b/csp/examples/e_12_caching_example.py → examples/6_advanced/e_12_caching_example.py
diff --git a/csp/examples/e_99_csp_nand_computer.py → ...98_just_for_fun/e_99_csp_nand_computer.py b/csp/examples/e_99_csp_nand_computer.py → ...98_just_for_fun/e_99_csp_nand_computer.py
diff --git a/csp/examples/e_22_profiling.py → ...ples/99_developer_tools/e_22_profiling.py b/csp/examples/e_22_profiling.py → ...ples/99_developer_tools/e_22_profiling.py
diff --git a/examples/README.md b/examples/README.md
@@ -0,0 +1,3 @@
+# `csp` examples
+
+