Merge pull request #139 from nucypher/fix-typings

.github/workflows/workspace.yml

@@ -175,13 +175,17 @@ jobs:
         run: python examples/server_api_simple.py
         working-directory: ferveo-python
 
-      - name: Install pytest
-        run: pip install pytest
+      - name: Install pip dependencies
+        run: pip install pytest mypy
 
       - name: Run pytest
         run: pytest
         working-directory: ferveo-python
 
+      - name: Run mypy.stubtest
+        run: python -m mypy.stubtest ferveo
+        working-directory: ferveo-python
+
   codecov:
     runs-on: ubuntu-latest
     needs: [ test ]

Pipfile

@@ -0,0 +1,11 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+
+[dev-packages]
+
+[requires]
+python_version = "3.10"

ferveo-python/Cargo.toml

@@ -8,7 +8,6 @@ publish = false
 
 [lib]
 crate-type = ["cdylib"]
-name = "ferveo_py"
 
 [features]
 extension-module = ["pyo3/extension-module"]
@@ -18,12 +17,5 @@ default = ["extension-module"]
 ferveo = { package = "ferveo-pre-release", path = "../ferveo", features = ["bindings-python"] }
 pyo3 = "0.18.2"
 
-# We avoid declaring "pyo3/extension-module" in `dependencies` since it causes compile-time issues:
-# https://github.com/PyO3/pyo3/issues/340
-# Instead, we expose it in certain cases:
-# https://github.com/PyO3/maturin/issues/325
-[tool.maturin]
-features = ["pyo3/extension-module"]
-
 [build-dependencies]
 pyo3-build-config = "*"

ferveo-python/Pipfile

@@ -0,0 +1,11 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+
+[dev-packages]
+
+[requires]
+python_version = "3.10"

ferveo-python/README.md

@@ -3,10 +3,3 @@
 ## Build
 
 You will need to have `setuptools-rust` installed. Then, for development, you can just do `pip install -e .` as usual.
-
-## Publish
-
-```bash
-maturin build --release
-maturin publish
-```

ferveo-python/examples/exception.py

@@ -1,4 +1,4 @@
-from ferveo_py import (
+from ferveo import (
     Keypair,
     Validator,
     Dkg,

ferveo-python/examples/server_api_precomputed.py

@@ -1,4 +1,4 @@
-from ferveo_py import (
+from ferveo import (
     encrypt,
     combine_decryption_shares_precomputed,
     decrypt_with_shared_secret,

ferveo-python/examples/server_api_simple.py

@@ -1,4 +1,4 @@
-from ferveo_py import (
+from ferveo import (
     encrypt,
     combine_decryption_shares_simple,
     decrypt_with_shared_secret,

ferveo-python/ferveo/__init__.py

@@ -1,4 +1,4 @@
-from .ferveo_py import (
+from ._ferveo import (
     encrypt,
     combine_decryption_shares_simple,
     combine_decryption_shares_precomputed,

ferveo-python/ferveo/__init__.pyi

@@ -1,17 +1,18 @@
-from typing import Sequence
+from typing import Sequence, final
 
 
+@final
 class Keypair:
     @staticmethod
     def random() -> Keypair:
         ...
 
     @staticmethod
-    def from_secure_randomness(data: bytes) -> Keypair:
+    def from_secure_randomness(secure_randomness: bytes) -> Keypair:
         ...
 
     @staticmethod
-    def secure_randomness_size(data: bytes) -> int:
+    def secure_randomness_size() -> int:
         ...
 
     @staticmethod
@@ -25,6 +26,7 @@ class Keypair:
         ...
 
 
+@final
 class FerveoPublicKey:
     @staticmethod
     def from_bytes(data: bytes) -> FerveoPublicKey:
@@ -36,10 +38,15 @@ class FerveoPublicKey:
     def __hash__(self) -> int:
         ...
 
-    def __richcmp__(self, other: FerveoPublicKey, op: int) -> bool:
+    @staticmethod
+    def serialized_size() -> int:
+        ...
+
+    def __eq__(self, other: object) -> bool:
         ...
 
 
+@final
 class Validator:
 
     def __init__(self, address: str, public_key: FerveoPublicKey):
@@ -50,6 +57,7 @@ class Validator:
     public_key: FerveoPublicKey
 
 
+@final
 class Transcript:
     @staticmethod
     def from_bytes(data: bytes) -> Transcript:
@@ -59,6 +67,7 @@ class Transcript:
         ...
 
 
+@final
 class DkgPublicKey:
     @staticmethod
     def from_bytes(data: bytes) -> DkgPublicKey:
@@ -67,7 +76,12 @@ class DkgPublicKey:
     def __bytes__(self) -> bytes:
         ...
 
+    @staticmethod
+    def serialized_size() -> int:
+        ...
+
 
+@final
 class ValidatorMessage:
 
     def __init__(
@@ -81,6 +95,7 @@ class ValidatorMessage:
     transcript: Transcript
 
 
+@final
 class Dkg:
 
     def __init__(
@@ -102,6 +117,7 @@ class Dkg:
         ...
 
 
+@final
 class Ciphertext:
     @staticmethod
     def from_bytes(data: bytes) -> Ciphertext:
@@ -111,6 +127,7 @@ class Ciphertext:
         ...
 
 
+@final
 class DecryptionShareSimple:
     @staticmethod
     def from_bytes(data: bytes) -> DecryptionShareSimple:
@@ -120,6 +137,7 @@ class DecryptionShareSimple:
         ...
 
 
+@final
 class DecryptionSharePrecomputed:
     @staticmethod
     def from_bytes(data: bytes) -> DecryptionSharePrecomputed:
@@ -129,6 +147,7 @@ class DecryptionSharePrecomputed:
         ...
 
 
+@final
 class AggregatedTranscript:
 
     def __init__(self, messages: Sequence[ValidatorMessage]):
@@ -163,6 +182,7 @@ class AggregatedTranscript:
         ...
 
 
+@final
 class SharedSecret:
 
     @staticmethod
@@ -173,15 +193,19 @@ class SharedSecret:
         ...
 
 
+@final
 class FerveoVariant:
-    @staticmethod
-    def simple() -> str: ...
+    Simple: FerveoVariant
+    Precomputed: FerveoVariant
 
-    @staticmethod
-    def precomputed() -> str: ...
+    def __eq__(self, other: object) -> bool:
+        ...
+
+    def __hash__(self) -> int:
+        ...
 
 
-def encrypt(message: bytes, add: bytes, dkg_public_key: DkgPublicKey) -> Ciphertext:
+def encrypt(message: bytes, aad: bytes, dkg_public_key: DkgPublicKey) -> Ciphertext:
     ...
 
 
@@ -267,7 +291,3 @@ class ValidatorPublicKeyMismatch(Exception):
 
 class SerializationError(Exception):
     pass
-
-
-class InvalidVariant(Exception):
-    pass

ferveo-python/pyproject.toml

@@ -1,14 +1,4 @@
 [build-system]
-requires = ["maturin>=0.14,<0.15"]
-build-backend = "maturin"
-
-[project]
-name = "ferveo"
-requires-python = ">=3.7"
-classifiers = [
-    "Programming Language :: Rust",
-    "Programming Language :: Python :: Implementation :: CPython",
-    "Programming Language :: Python :: Implementation :: PyPy",
-]
+requires = ["setuptools", "wheel", "setuptools-rust"]
 
 

ferveo-python/src/lib.rs

@@ -2,6 +2,6 @@ use ferveo::bindings_python::*;
 use pyo3::prelude::*;
 
 #[pymodule]
-fn ferveo_py(py: Python, m: &PyModule) -> PyResult<()> {
+fn _ferveo(py: Python, m: &PyModule) -> PyResult<()> {
     make_ferveo_py_module(py, m)
 }