Stubs need to be checked in (#171)

Check-in stub files and add option to check that existing stubs match
checked in
versions.

As a result of isolated builds running any kind of python script with
the module
dependencies requires a lot of customisation that goes against python
build
tools

.github/workflows/ci.yml

@@ -64,6 +64,8 @@ jobs:
         run: poetry run black .
       - name: Pytest
         run: poetry run pytest
+      - name: Check generated stubs
+        run: poetry run python -m ziglang build --build-file pytest.build.zig generate-stubs -Dcheck-stubs=true
 
       - name: Zig Docs Build
         run: poetry run python -m ziglang build docs

example/buffers.pyi

@@ -0,0 +1,7 @@
+from __future__ import annotations
+
+def sum(buf, /): ...
+
+class ConstantBuffer:
+    def __init__(elem, length, /):
+        pass

example/classes.pyi

@@ -0,0 +1,50 @@
+from __future__ import annotations
+
+class Animal:
+    def species(self, /): ...
+
+class ConstructableClass:
+    def __init__(count, /):
+        pass
+
+class Counter:
+    def __init__():
+        pass
+    def increment(self, /): ...
+
+    count: ...
+
+class Hash:
+    def __init__(x, /):
+        pass
+    def __hash__(self, /):
+        """
+        Return hash(self).
+        """
+        ...
+
+class Math:
+    def add(x, y, /): ...
+
+class SomeClass:
+    """
+    Some class defined in Zig accessible from Python
+    """
+
+class User:
+    def __init__(name, /):
+        pass
+    @property
+    def email(self): ...
+    @property
+    def greeting(self): ...
+
+class ZigOnlyMethod:
+    def __init__(x, /):
+        pass
+    def reexposed(self, /): ...
+
+class Dog(Animal):
+    def __init__(breed, /):
+        pass
+    def breed(self, /): ...

example/exceptions.pyi

@@ -0,0 +1,4 @@
+from __future__ import annotations
+
+def raise_custom_error(): ...
+def raise_value_error(message, /): ...

example/functions.pyi

@@ -0,0 +1,4 @@
+from __future__ import annotations
+
+def double(x, /): ...
+def with_kwargs(x, /, *, y=42.0): ...

example/hello.pyi

@@ -0,0 +1,3 @@
+from __future__ import annotations
+
+def hello(): ...

example/iterators.pyi

@@ -0,0 +1,19 @@
+from __future__ import annotations
+
+class Range:
+    def __init__(lower, upper, step, /):
+        pass
+    def __iter__(self, /):
+        """
+        Implement iter(self).
+        """
+        ...
+
+class RangeIterator:
+    def __init__(next, stop, step, /):
+        pass
+    def __next__(self, /):
+        """
+        Implement next(self).
+        """
+        ...

example/memory.pyi

@@ -0,0 +1,4 @@
+from __future__ import annotations
+
+def append(left, /): ...
+def concat(left, /): ...

example/modules.pyi

@@ -0,0 +1,16 @@
+"""
+Zig multi-line strings make it easy to define a docstring...
+
+..with lots of lines!
+
+P.S. I'm sure one day we'll hook into Zig's AST and read the Zig doc comments ;)
+"""
+from __future__ import annotations
+
+def count(): ...
+def hello(name, /): ...
+def increment(): ...
+def whoami(): ...
+
+class submod:
+    def world(): ...