Merge pull request #174 from Point72/tkp/slacktut

Start organizing examples, increase test coverage of examples

Author: timkpaine

Makefile

@@ -44,8 +44,8 @@ lint-cpp:
 	echo "C++ linting disabled for now"
 
 lint-docs:
-	python -m mdformat --check docs/wiki/ README.md examples/README.md
-	python -m codespell_lib docs/wiki/ README.md examples/README.md
+	python -m mdformat --check docs/wiki/ README.md examples/
+	python -m codespell_lib docs/wiki/ README.md examples/ --skip "*.cpp,*.h"
 
 # lint: lint-py lint-cpp  ## run lints
 lint: lint-py lint-docs ## run lints
@@ -62,8 +62,8 @@ fix-cpp:
 	echo "C++ autoformatting disabled for now"
 
 fix-docs:
-	python -m mdformat docs/wiki/ README.md examples/README.md
-	python -m codespell_lib --write docs/wiki/ README.md examples/README.md
+	python -m mdformat docs/wiki/ README.md examples/
+	python -m codespell_lib --write docs/wiki/ README.md examples/ --skip "*.cpp,*.h"
 
 fix: fix-py fix-cpp fix-docs ## run autofixers
 

conda/dev-environment-unix.yml

@@ -5,17 +5,19 @@ channels:
 dependencies:
  - bison
  - brotli
+ - build
  - bump2version>=1
  - cmake
  - codespell
  - compilers
  - cyrus-sasl
  - exprtk
  - flex
+ - graphviz
  - python-graphviz
  - gtest
- - httpx
- - isort
+ - httpx>=0.20,<1
+ - isort>=5,<6
  - libarrow=15
  - librdkafka
  - libboost-headers
@@ -24,16 +26,18 @@ dependencies:
  - mdformat
  - ninja
  - numpy
+ - pillow
  - psutil
  - pyarrow=15
  - pandas
  - pillow
  - polars
+ - psutil
  - pytz
  - pytest
+ - pytest-asyncio
  - pytest-cov
  - pytest-sugar
- - pytest-asyncio
  - python<3.12
  - python-rapidjson
  - rapidjson
@@ -44,6 +48,7 @@ dependencies:
  - slack-sdk
  - sqlalchemy
  - tar
+ - threadpoolctl
  - tornado
  - twine
  - unzip

csp/tests/test_examples.py

@@ -17,10 +17,11 @@ def _get_module(folder, filename):
         return None
 
 
-def _get_modules_to_test(folder):
+def _get_modules_to_test(*folders):
+    folder = ".".join(folders) if len(folders) > 0 else folders[0]
     return [
         (file, _get_module(folder, file))
-        for file in os.listdir(os.path.join(EXAMPLES_ROOT, folder))
+        for file in os.listdir(os.path.join(EXAMPLES_ROOT, *folders))
         if file.endswith(".py")
     ]
 
@@ -31,12 +32,37 @@ def _no_examples_folder_or_running_sdist_tests():
 
 @pytest.mark.skipif(_no_examples_folder_or_running_sdist_tests(), reason="no examples present or manually skipping")
 class TestExamples:
-    @pytest.mark.parametrize("filename,module", _get_modules_to_test("1_basics"))
+    @pytest.mark.parametrize("filename,module", _get_modules_to_test("01_basics"))
     def test_1_basics(self, filename, module):
         assert module.main
         module.main()
 
-    @pytest.mark.parametrize("filename,module", _get_modules_to_test("2_intermediate"))
+    @pytest.mark.parametrize("filename,module", _get_modules_to_test("02_intermediate"))
     def test_2_intermediate(self, filename, module):
         assert module.main
         module.main()
+
+    @pytest.mark.parametrize("filename,module", _get_modules_to_test("03_using_adapters", "parquet"))
+    def test_3_adapters_parquet(self, filename, module):
+        assert module.main
+        module.main()
+
+    @pytest.mark.parametrize("filename,module", _get_modules_to_test("04_writing_adapters"))
+    def test_4_writing_adapters(self, filename, module):
+        assert module.main
+        module.main()
+
+    @pytest.mark.parametrize("filename,module", _get_modules_to_test("06_advanced"))
+    def test_6_advanced(self, filename, module):
+        assert module.main
+        module.main()
+
+    @pytest.mark.parametrize("filename,module", _get_modules_to_test("98_just_for_fun"))
+    def test_98_just_for_fun(self, filename, module):
+        assert module.main
+        module.main()
+
+    @pytest.mark.parametrize("filename,module", _get_modules_to_test("99_developer_tools"))
+    def test_99_developer_tools(self, filename, module):
+        assert module.main
+        module.main()

examples/01_basics/README.md

@@ -0,0 +1,6 @@
+# Basics
+
+- [Simplest Possible Graph](./e1_basic.py)
+- [Ticking Graphs](./e2_ticking.py)
+- [Complete Example (Trading)](./e3_trade_pnl.py)
+- [Visualizing a Graph](./e4_show_graph.py)

examples/01_basics/e1_basic.py

@@ -0,0 +1,29 @@
+from datetime import datetime
+
+import csp
+from csp import ts
+
+
+@csp.node
+def add(x: ts[int], y: ts[int]) -> ts[int]:
+    return x + y
+
+
+@csp.graph
+def my_graph():
+    x = csp.const(1)
+    y = csp.const(2)
+
+    sum = add(x, y)
+
+    csp.print("x", x)
+    csp.print("y", y)
+    csp.print("sum", sum)
+
+
+def main():
+    csp.run(my_graph, starttime=datetime.now())
+
+
+if __name__ == "__main__":
+    main()

examples/01_basics/e2_ticking.py

@@ -0,0 +1,49 @@
+from datetime import datetime, timedelta
+
+import csp
+from csp import ts
+
+
+@csp.node
+def add(x: ts[int], y: ts[int]) -> ts[int]:
+    return x + y
+
+
+@csp.node
+def accum(val: ts[int]) -> ts[int]:
+    with csp.state():
+        s_sum = 0
+    if csp.ticked(val):
+        s_sum += val
+        return val
+
+
+@csp.graph
+def my_graph():
+    st = datetime(2020, 1, 1)
+
+    # Dummy x values
+    x = csp.curve(int, [(st + timedelta(1), 1), (st + timedelta(2), 2), (st + timedelta(3), 3)])
+
+    # Dummy y values
+    y = csp.curve(int, [(st + timedelta(1), -1), (st + timedelta(3), -1), (st + timedelta(4), -1)])
+
+    # Add the time series
+    sum = add(x, y)
+
+    # Accumulate the result
+    acc = accum(sum)
+
+    csp.print("x", x)
+    csp.print("y", y)
+    csp.print("sum", sum)
+    csp.print("accum", acc)
+
+
+def main():
+    start = datetime(2020, 1, 1)
+    csp.run(my_graph, starttime=start)
+
+
+if __name__ == "__main__":
+    main()

examples/1_basics/e_02_show_graph.py renamed to examples/01_basics/e3_show_graph.py

@@ -0,0 +1,6 @@
+# Intermediate
+
+- [Graph Loops (`csp.feedback`)](./e1_feedback.py)
+- [Statistics Nodes](./e2_stats.py)
+- [Statistics Nodes with Numpy](./e3_numpy_stats.py)
+- [Expression Nodes with `exprtk`](./e4_exprtk.py)

examples/1_basics/e_01_trade_pnl.py renamed to examples/01_basics/e4_trade_pnl.py

@@ -80,7 +80,7 @@ def main():
     if show_graph:
         csp.showgraph.show_graph(my_graph)
     else:
-        csp.run(my_graph, starttime=datetime.utcnow(), endtime=timedelta(seconds=60), realtime=True)
+        csp.run(my_graph, starttime=datetime.utcnow(), endtime=timedelta(seconds=5), realtime=False)
 
 
 if __name__ == "__main__":