clean up type stubs and expose the is_valid function to the user

Author: shaggysa

lib_sudoku.pyi

@@ -51,7 +51,7 @@ if TYPE_CHECKING:
             """
             ...
 
-    def print_puzz(puzzle: list) -> None:
+    def print_puzz(puzzle: bytearray) -> None:
         """
         Prints a puzzle in the correct format.
         :param puzzle:
@@ -77,7 +77,7 @@ if TYPE_CHECKING:
         """
         ...
 
-    def solve(puzzle: list) -> bytearray:
+    def solve(puzzle: bytearray) -> bytearray:
         """
         Takes in a puzzle in the form of a row-major list and returns a solved version.
 
@@ -97,6 +97,18 @@ if TYPE_CHECKING:
             num_hints (int): The number of hints the final puzzle will have. Must be between 23 and 40.
 
         returns:
-        bytearray: The puzzle with the specified number of hints.
+            bytearray: The puzzle with the specified number of hints.
         """
         ...
+
+    def is_valid(puzzle:bytearray) -> bool:
+        """
+        Checks if a puzzle is legal.
+
+        Args:
+            puzzle (bytearray): The puzzle you want to check.
+
+        returns:
+            bool: True if the puzzle is valid, false otherwise.
+        """
+        ...

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "maturin"
 
 [project]
 name = "lib_sudoku"
-version = "2.0.0"
+version = "2.1.0"
 requires-python = ">=3.8"
 description = "A blazing fast sudoku library buit in rust"
 readme = "README.md"

src/lib.rs

@@ -12,6 +12,7 @@ fn lib_sudoku(m: &Bound<'_, PyModule>) -> PyResult<()> {
     m.add_function(wrap_pyfunction!(libraries::speedtest::async_speedtest, m)?)?;
     m.add_function(wrap_pyfunction!(libraries::puzzle_solver::solve, m)?)?;
     m.add_function(wrap_pyfunction!(libraries::puzzle_generator::gen_unsolved, m)?)?;
+    m.add_function(wrap_pyfunction!(libraries::puzzle_solver::is_valid, m)?)?;
     Ok(())
 
 }

src/libraries/puzzle_solver.rs

@@ -23,7 +23,7 @@ fn no_repeats(items: Vec<u8>) -> bool {
 }
 
 #[pyfunction]
-fn is_valid(puzzle: Vec<u8>) -> PyResult<bool> {
+pub(crate) fn is_valid(puzzle: Vec<u8>) -> PyResult<bool> {
     if puzzle.len() != 81 {
         return Err(pyo3::exceptions::PyValueError::new_err("A puzzle must have a length of 81!"));
     }