Add stubtests

Author: saulshanabrook

.flake8

@@ -1,4 +1,4 @@
 ; https://black.readthedocs.io/en/stable/guides/using_black_with_other_tools.html#flake8
 [flake8]
 max-line-length = 88
-extend-ignore = E203,E501,F405,F403
+extend-ignore = E203,E501,F405,F403,E302

.github/workflows/CI.yml

@@ -30,6 +30,15 @@ jobs:
       - uses: actions/checkout@v2
       - run: pip install -e .[test]
       - run: pytest
+  stubtest:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/setup-python@v2
+        with:
+          python-version: "3.10"
+      - uses: actions/checkout@v2
+      - run: pip install -e . mypy
+      - run: python -m mypy.stubtest egg_smol.bindings
   docs:
     runs-on: ubuntu-latest
     steps:

docs/how-to-guides.md

@@ -24,3 +24,4 @@ To get started developing on this package:
 3. Run the tests: `pytest`
 4. Run the pre-commit hooks: `pre-commit run --all-files`
 5. Build the docs: `sphinx-build -nW -b html docs docs/_build/html`
+6. Check the stubts: `python -m mypy.stubtest egg_smol.bindings`

python/egg_smol/bindings.pyi

@@ -6,13 +6,12 @@ from .bindings_py import Expr, FunctionDecl, Variant
 
 @final
 class EGraph:
-    def ___init__(self) -> None: ...
-    def parse_and_run_program(self, program: str) -> list[str]: ...
+    def parse_and_run_program(self, input: str) -> list[str]: ...
     def declare_constructor(self, variant: Variant, sort: str) -> None: ...
     def declare_sort(self, name: str) -> None: ...
-    def declare_function(self, function: FunctionDecl) -> None: ...
+    def declare_function(self, decl: FunctionDecl) -> None: ...
     def define(self, name: str, expr: Expr, cost: Optional[int] = None) -> None: ...
 
 @final
 class EggSmolError(Exception):
-    pass
+    context: str

src/lib.rs

@@ -22,49 +22,41 @@ impl EGraph {
         }
     }
 
-    /// define($self, expr, name, cost)
-    /// --
-    ///
     /// Define a new named value.
-    #[args(cost = "None")]
+    #[pyo3(
+        text_signature = "($self, name, expr, cost=None)",
+        signature = "(name, expr, cost=None)"
+    )]
     fn define(&mut self, name: String, expr: WrappedExpr, cost: Option<usize>) -> EggResult<()> {
         self.egraph.define(name.into(), expr.into(), cost)?;
         Ok(())
     }
 
-    /// declare_function($self, decl)
-    /// --
-    ///
     /// Declare a new function definition.
+    #[pyo3(text_signature = "($self, decl)")]
     fn declare_function(&mut self, decl: WrappedFunctionDecl) -> EggResult<()> {
         self.egraph.declare_function(&decl.into())?;
         Ok(())
     }
 
-    /// declare_sort($self, name)
-    /// --
-    ///
     /// Declare a new sort with the given name.
+    #[pyo3(text_signature = "($self, name)")]
     fn declare_sort(&mut self, name: &str) -> EggResult<()> {
         self.egraph.declare_sort(name)?;
         Ok({})
     }
 
-    /// declare_constructor($self, variant, sort)
-    /// --
-    ///
     /// Declare a new datatype constructor.
+    #[pyo3(text_signature = "($self, variant, sort)")]
     fn declare_constructor(&mut self, variant: WrappedVariant, sort: &str) -> EggResult<()> {
         self.egraph.declare_constructor(variant.into(), sort)?;
         Ok({})
     }
 
-    /// parse_and_run_program($self, input)
-    /// --
-    ///
     /// Parse the input string as a program and run it on the EGraph.
     /// Returns a list of strings representing the output.
     /// An EggSmolError is raised if there is problem parsing or executing.
+    #[pyo3(text_signature = "($self, input)")]
     fn parse_and_run_program(&mut self, input: &str) -> EggResult<Vec<String>> {
         let res = self.egraph.parse_and_run_program(input)?;
         Ok(res)