fix(ooniauth-py): make extension module optional.

Today, the README gives some information for how to link the python interpreter and expects the user to find their way.
This commit only enables PyO3 extension-module for maturin builds, but disable it for plain cargo builds.
This way, Rust test binaries link libpython correctly.
Along the way, we remove some unused configuration flags in build.rs, and add wheels/ to .gitignore.

Author: mmaker

.gitignore

@@ -4,3 +4,4 @@ ios/**/.DS_Store
 ios/**/*.xcuserstate
 ios/**/xcuserdata/
 ios/OoniAuthBindings/OoniAuthFFI.xcframework/
+ooniauth-py/wheels/

ooniauth-py/Cargo.toml

@@ -8,10 +8,14 @@ edition = "2021"
 name = "ooniauth_py"
 crate-type = ["cdylib", "rlib"]
 
+[features]
+default = []
+extension-module = ["pyo3/extension-module"]
+
 [dependencies]
 cmz = { workspace = true }
 ooniauth-core = {path = "../ooniauth-core"}
-pyo3 = {version = "0.26.0", features = ["extension-module", "abi3-py310"]}
+pyo3 = {version = "0.26.0", features = ["abi3-py310"]}
 pyo3-stub-gen = "0.14.1"
 rand = {workspace = true}
 bincode = {workspace = true}

ooniauth-py/README.md

@@ -25,41 +25,16 @@ the resulting Python package during development, see more details
 
 ### Testing installation
 
-If you try to run the tests as you usually would with `cargo test`, you will get linking errors. This
-happens because Maturin provides a build configuration with all the linking flags required to build
-the library. However, it does not provide a `maturing test` command that could help you with this.
-
-A possible solution is to manually specify the linking flags to the compiler, but in order to do this
-you will probably need to download the specific Python version (3.10). A good way to do this
-is using [Pyenv](https://github.com/pyenv/pyenv):
-
-1. [Install Pyenv](https://github.com/pyenv/pyenv?tab=readme-ov-file#installation)
-2. Install Python 3.10.0 with pyenv: `pyenv install 3.10.0`
-
-With the Python version installed, you can create a `.cargo/config.toml`
-with the linking flags. Create the file in `userauth/.cargo/config.toml`
-and fill the following template:
-
-```toml
-[target.'cfg(all())']
-rustflags = [
-    "-C", "link-arg=-Wl,-rpath,<YOUR PYENV PATH HERE>/.pyenv/versions/3.10.0/lib",
-    "-C", "link-arg=-L<YOUR PYENV PATH HERE>/.pyenv/versions/3.10.0/lib",
-    "-C", "link-arg=-lpython3.10",
-]
-```
+Run the Rust tests with:
 
-Example result:
-```toml
-[target.'cfg(all())']
-rustflags = [
-    "-C", "link-arg=-Wl,-rpath,/home/ooni/.pyenv/versions/3.10.0/lib",
-    "-C", "link-arg=-L/home/ooni/.pyenv/versions/3.10.0/lib",
-    "-C", "link-arg=-lpython3.10",
-]
+```bash
+cargo test
 ```
 
-**Note**: Make sure to create this file in `userauth/.cargo/config.toml` and not in `userauth/ooniauth-py/.cargo.toml`
+The Python extension-module linker mode is enabled only for Maturin builds.
+If you need to test against a specific Python interpreter, activate a virtualenv
+or set `PYO3_PYTHON` before running the tests. The virtualenv must point to a
+base Python installation which provides an embeddable shared library.
 
 ### Usage
 

ooniauth-py/build.rs

@@ -10,10 +10,4 @@ fn main() {
     println!("cargo:rerun-if-env-changed=CFLAGS");
     println!("cargo:rerun-if-env-changed=LDFLAGS");
     println!("cargo:rerun-if-env-changed=RUSTFLAGS");
-    println!("cargo:rustc-check-cfg=cfg(Py_3_10)");
-    println!("cargo:rustc-check-cfg=cfg(Py_3_11)");
-    println!("cargo:rustc-check-cfg=cfg(Py_3_12)");
-    println!("cargo:rustc-check-cfg=cfg(Py_3_13)");
-    println!("cargo:rustc-check-cfg=cfg(Py_3_14)");
-    println!("cargo:rustc-check-cfg=cfg(Py_3_15)");
 }

ooniauth-py/ooniauth_py.pyi

@@ -5,55 +5,40 @@ import builtins
 import typing
 
 __version__: builtins.str
-
 class CredentialError(builtins.Exception):
     r"""
     An authentication error
     """
-
     ...
 
 class DeserializationFailed(builtins.Exception):
     r"""
     An error trying to deserialize a base64-encoded payload
     """
-
     ...
 
 class ProtocolError(builtins.Exception):
     r"""
     An error performing the protocol
     """
-
     ...
 
 class ServerState:
     def __new__(cls) -> ServerState: ...
     @staticmethod
-    def from_creds(public_parameters: str, secret_key: str) -> ServerState:
+    def from_creds(public_parameters:str, secret_key:str) -> ServerState:
         r"""
         Create a new server state from base64-encoded keys
         This is meant to be used by the server, so it can store the keys somewhere and recreate the
         state when needed
         """
-
     def get_secret_key(self) -> str: ...
     def get_public_parameters(self) -> str: ...
-    def handle_registration_request(self, registration_request: str) -> str: ...
+    def handle_registration_request(self, registration_request:str) -> str: ...
     @staticmethod
     def today() -> builtins.int: ...
-    def handle_submit_request(
-        self,
-        nym: str,
-        request: str,
-        probe_cc: str,
-        probe_asn: str,
-        age_range: tuple[builtins.int, builtins.int],
-        min_measurement_count: builtins.int,
-    ) -> str: ...
-    def handle_update_request(
-        self, req: str, old_public_params: str, old_secret_key: str
-    ) -> str: ...
+    def handle_submit_request(self, nym:str, request:str, probe_cc:str, probe_asn:str, age_range:tuple[builtins.int, builtins.int], min_measurement_count:builtins.int) -> str: ...
+    def handle_update_request(self, req:str, old_public_params:str, old_secret_key:str) -> str: ...
 
 class SubmitRequest:
     @property
@@ -62,46 +47,38 @@ class SubmitRequest:
     def request(self) -> str: ...
 
 class UserState:
-    def __new__(cls, public_params: str) -> UserState: ...
+    def __new__(cls, public_params:str) -> UserState: ...
     def get_credential(self) -> typing.Optional[str]: ...
-    def set_public_params(self, new_public_params: str) -> None: ...
+    def set_public_params(self, new_public_params:str) -> None: ...
     def make_registration_request(self) -> str: ...
-    def handle_registration_response(self, resp: str) -> None:
+    def handle_registration_response(self, resp:str) -> None:
         r"""
         Handle a registration response sent by the server, updating your credentials
-
+        
         Note that this function will only work if you previously called
         `make_registration_request`
         """
-
-    def make_submit_request(
-        self,
-        probe_cc: str,
-        probe_asn: str,
-        age_range: tuple[builtins.int, builtins.int],
-        min_measurement_count: builtins.int,
-    ) -> SubmitRequest: ...
-    def handle_submit_response(self, response: str) -> None:
+    def make_submit_request(self, probe_cc:str, probe_asn:str, age_range:tuple[builtins.int, builtins.int], min_measurement_count:builtins.int) -> SubmitRequest: ...
+    def handle_submit_response(self, response:str) -> None:
         r"""
         Handle a submit response sent by the server, updating your credentials
-
+        
         Note that this function will only work if you previously called
         `make_submit_request`
         """
-
     def make_credential_update_request(self) -> str:
         r"""
         Creates a credential update request to be sent to the server.
         """
-
-    def handle_credential_update_response(self, resp: str) -> None:
+    def handle_credential_update_response(self, resp:str) -> None:
         r"""
         Handles the credential update response sent by the server, updating your credentials.
-
+        
         This function only works if you previosly called `make_credential_update_request`
         """
 
 def get_protocol_version() -> builtins.str:
     r"""
     Returns the version of the `ooniauth-core`, the actual protocol implementation.
     """
+

ooniauth-py/pyproject.toml

@@ -21,4 +21,4 @@ Homepage = "https://github.com/ooni/userauth"
 Issues = "https://github.com/ooni/userauth/issues"
 
 [tool.maturin]
-features = ["pyo3/extension-module"]
+features = ["extension-module"]