Fix stubs, add stub test (#309)

Author: javiermtorres

Makefile

@@ -13,6 +13,11 @@ setup:
 build-py:
 	maturin develop -m encoderfile-py/Cargo.toml
 
+.PHONY: stubtest
+stubtest:
+	@echo "Running stubtest..."
+	@uv run --dev stubtest --allowlist=allowlist.txt encoderfile.encoderfile
+
 .PHONY: format
 format:
 	@echo "Formatting python..."

allowlist.txt

@@ -0,0 +1,2 @@
+# ignore missing __all__ in encoderfile
+encoderfile.encoderfile.__all__

encoderfile-py/python/encoderfile/__init__.py

@@ -1,4 +1,5 @@
-from .encoderfile import *  # noqa
+# type: ignore
+from .encoderfile import *  # noqa # type: ignore
 
 
 __doc__ = encoderfile.__doc__  # noqa # type: ignore

encoderfile-py/python/encoderfile/encoderfile.pyi

@@ -1,15 +1,37 @@
-from typing import Optional
+from typing import Optional, final
 
+@final
 class EncoderfileBuilder:
     @classmethod
     def from_config(
         cls,
         config: str,
-        output_path: Optional[str] = None,
-        base_binary_path: Optional[str] = None,
-        platform: Optional[str] = None,
+    ) -> "EncoderfileBuilder": ...
+    def build(
+        self,
+        working_dir: Optional[str] = None,
         version: Optional[str] = None,
         no_download: bool = False,
-        directory: Optional[str] = None,
-    ) -> "EncoderfileBuilder": ...
-    def build(self, cache_dir: Optional[str] = None): ...
+    ): ...
+
+@final
+class ModelConfig:
+    model_type: str
+    num_labels: Optional[int]
+    id2label: Optional[dict[int, str]]
+    label2id: Optional[dict[str, int]]
+
+@final
+class EncoderfileConfig:
+    name: str
+    version: str
+    model_type: str
+    transform: Optional[str]
+    lua_libs: Optional[list[str]]
+
+@final
+class InspectInfo:
+    model_config: ModelConfig
+    encoderfile_config: EncoderfileConfig
+
+def inspect(path: str) -> InspectInfo: ...

encoderfile-py/src/lib.rs

@@ -10,4 +10,13 @@ mod encoderfile {
 
     #[pymodule_export]
     use super::builder::inspect;
+
+    #[pymodule_export]
+    use super::builder::PyEncoderfileConfig;
+
+    #[pymodule_export]
+    use super::builder::PyModelConfig;
+
+    #[pymodule_export]
+    use super::builder::PyInspectInfo;
 }

pyproject.toml

@@ -7,7 +7,7 @@ requires-python = ">=3.13"
 dependencies = [ "pip>=25.2", "protobuf>=6.33.0"]
 
 [dependency-groups]
-dev = [ "pre-commit>=4.3.0", "ruff>=0.14.2",]
+dev = [ "pre-commit>=4.3.0", "ruff>=0.14.2", "mypy>=1.19"]
 docs = [ "mkdocs>=1.6.1", "mkdocs-include-markdown-plugin>=7.2.0", "mkdocs-material>=9.7.0",]
 setup = [ "onnxruntime>=1.23.1", "optimum[onnxruntime]>=2.0.0", "transformers>=4.55.0",]
 models = [ "torch>=2.9.0", "click", {include-group = "setup"} ]