Add binding by phillip-wenig-frequenz · Pull Request #17 · frequenz-floss/frequenz-resampling-python

phillip-wenig-frequenz · 2026-04-23T09:14:19Z

Summary

This PR introduces Rust-backed Python bindings for frequenz-resampling and migrates the Python package to the frequenz.resampling namespace.

It adds a PyO3 extension module built with maturin, moves/exposes the Python API in the new package path, expands tests for the bindings, and updates docs/CI/tooling paths to align with the compiled-package architecture.

Changes

Add Rust wrapper crate and PyO3 extension module (src/lib.rs, Cargo.toml, Cargo.lock)
Add Python binding package at frequenz/resampling
Add extension stubs (frequenz/resampling/_rust_backend.pyi)
Remove old top-level resampling/__init__.py
Add binding-focused tests and API behavior checks
Update docs generation paths from src to frequenz
Update CI/package workflow for compiled distributions across environments
Refresh project docs (README.md, AGENTS.md)

Upgrade Notes

Import path changed:
- from resampling
- to frequenz.resampling
The Python API is now backed by a Rust extension module (frequenz.resampling._rust_backend).

Validation

Added and updated tests for Python bindings and enum/API behavior
Adjusted docs/tooling config to target the Python source tree correctly

shsms · 2026-04-23T13:10:24Z

@@ -0,0 +1,455 @@
+use chrono::{DateTime, TimeDelta, Utc};


Looks like we're missing the header lines. For example: https://github.com/frequenz-floss/frequenz-microgrid-component-graph-python/blob/v0.x.x/src/lib.rs#L1-L4

shsms · 2026-04-23T13:26:40Z

+      fail-fast: false
+      matrix:
+        include:
+          - platform: ubuntu-24.04


PyPI would only accept wheels that are built on the manylinux containers. Easiest to copy from here: https://github.com/frequenz-floss/frequenz-microgrid-component-graph-python/blob/v0.x.x/.github/workflows/ci.yaml

And ci-pr.yaml from the same dir for basic PR checks.

Signed-off-by: Phillip Wenig <phillip.wenig@frequenz.com>

shsms

🎉

llucax

Hello 👋

I see a lot of the latest fixed I made to GitHub workflows are being reverted in this PR. A lot of effort was put to improve our workflow/actions hygiene to be as secure as possible. Please be more careful when updating actions/workflows from now on, do not just blindly revert code, and as general rules:

Make sure to always pin actions using hashes to prevent supply chain attacks
Always call python with -I to prevent arbitrary code execution
Be careful about shell expansion issues

To be sure, I would revert to the original template files and re-apply only the necessary changes.

Also, as we grow the number of projects we have in rust with python bindings, I think it would be very useful to add a new repo type to repo-config. Maybe you can create an issue in repo-config listing all currently known differences between a "normal" python lib and a rust binding python lib?

I created an issue so this doesn't get lost:

#27

llucax · 2026-05-05T07:34:56Z

-        uses: frequenz-floss/gh-action-nox@80a9845a59ffc71d27b9c41099eb6cb55bc7b671 # v1.1.1
+        uses: frequenz-floss/gh-action-nox@v1.0.1


Why this? This is not good, we should always pin dependencies (it was also downgraded, but that will be taken care of by dependabot). Can you please revert to use hashes? Same for all the others.

llucax · 2026-05-05T07:37:04Z

-permissions:
-  # Read repository contents for checkout and dependency resolution only.
-  contents: read
-


Not good. You are reverting the latest fixes I did in repo-config to improve security. Without declaring permissions explicitly, actions will have write permission. Please revert.

I asked Phillip to copy the existing stuff from component-graph-py, where we have verified that this config works for maturin based rust binding builds, and didn't want to research. And at least those two repos haven't diverged from each other.

It would be nice to get repo-config support for rust bindings, because we're likely to get more soon(tm).

This particular item I remember removing very clearly because we talked about it: frequenz-floss/frequenz-microgrid-component-graph-python#16 (comment)

I asked Phillip to copy the existing stuff from component-graph-py, where we have verified that this config works for maturin based rust binding builds, and didn't want to research. And at least those two repos haven't diverged from each other.

Understood. Still, please be careful about reverting changes related to security, I think the priority should be security, if we need to align, we need to bring the less secure workflow to be like the most secure workflow, not the other way around. And I totally get that this changes are new and you might have been unaware. It is just a heads-up for the future.

It would be nice to get repo-config support for rust bindings, because we're likely to get more soon(tm).

100% agreed, I suggested that too. If you could create an issue it would be helpful (and a PR would be amazing 😆 )

llucax · 2026-05-05T07:38:45Z

-        platform:
+        target:


If possible revert this too, so it is as aligned with repo-config templates as possible, so we have higher chances that migration scripts work on this repo. Eventually we should probably create a new project type rust-binding (or something like that) in repo-config.

llucax · 2026-05-05T07:39:58Z

-    runs-on: ubuntu-slim
-    # Drop token permissions: this job only checks matrix status from `needs`.
-    permissions: {}
+    runs-on: ubuntu-24.04


Please revert this too. Permissions for sure, but the runner too, unless the step needs docker or some tool that is not included in ubuntu-slim.

These are built using the manylinux containers, the ubuntu-slim here isn't relevant.

llucax · 2026-05-05T07:43:02Z

-        run: python -Im pip freeze
+        run: python -m pip freeze


More security fixes that are being regressed. Please also revert.

llucax · 2026-05-05T07:43:18Z

-          # Collect aliases into an array to avoid accidental (or malicious)
-          # shell injection when passing them to mike.
-          aliases=()
-          if test -n "$ALIASES"; then
-            read -r -a aliases <<<"$ALIASES"
-          fi
-          # mike is installed as a console script, not a runnable module.
-          # Run the installed script under isolated mode to avoid importing from
-          # the workspace when building docs from checked-out code.
-          python -I "$(command -v mike)" \
-            deploy --update-aliases --title "$TITLE" "$VERSION" "${aliases[@]}"
+          mike deploy --update-aliases --title "$TITLE" "$VERSION" $ALIASES


Please revert this too.

llucax · 2026-05-05T07:43:37Z

-          extra_opts=()
-          if echo "$REF_NAME" | grep -- -; then extra_opts+=(--prerelease); fi
+          extra_opts=
+          if echo "$REF_NAME" | grep -- -; then extra_opts=" --prerelease"; fi
          gh release create \
            -R "$REPOSITORY" \
            --notes-file RELEASE_NOTES.md \
            --generate-notes \
-            "${extra_opts[@]}" \
-            "$REF_NAME" \
-            dist/*
+            $extra_opts \
+            $REF_NAME \
+            dist/wheels-*/*.whl dist/wheels-sdist/*.tar.gz


llucax · 2026-05-05T07:43:48Z

-      # Create GitHub releases and upload distribution artifacts.
+      # We need write permissions on contents to create GitHub releases and on
+      # discussions to create the release announcement in the discussion forums
      contents: write
-    runs-on: ubuntu-slim
+      discussions: write
+    runs-on: ubuntu-24.04


phillip-wenig-frequenz requested review from leandro-lucarella-frequenz, llucax, malteschaaf and shsms April 23, 2026 09:14

phillip-wenig-frequenz requested a review from a team as a code owner April 23, 2026 09:14

github-actions Bot added part:docs Affects the documentation part:tests Affects the unit, integration and performance (benchmarks) tests part:tooling Affects the development tooling (CI, deployment, dependency management, etc.) labels Apr 23, 2026

phillip-wenig-frequenz force-pushed the add-binding branch from 7e45f78 to 6b15351 Compare April 23, 2026 09:17

phillip-wenig-frequenz mentioned this pull request Apr 23, 2026

Remove python package and pyo3 frequenz-floss/frequenz-resampling-rs#87

Merged

phillip-wenig-frequenz requested a review from cwasicki April 23, 2026 11:00

shsms reviewed Apr 23, 2026

View reviewed changes

phillip-wenig-frequenz requested a review from shsms April 23, 2026 14:51

phillip-wenig-frequenz added 3 commits April 27, 2026 11:39

Add Rust-backed resampling extension

3e4d82d

Signed-off-by: Phillip Wenig <phillip.wenig@frequenz.com>

Expose bindings under frequenz.resampling

4fe71a9

Signed-off-by: Phillip Wenig <phillip.wenig@frequenz.com>

Add Python binding tests

cc05121

Signed-off-by: Phillip Wenig <phillip.wenig@frequenz.com>

phillip-wenig-frequenz force-pushed the add-binding branch 2 times, most recently from 2885cfb to 1461740 Compare April 28, 2026 12:28

phillip-wenig-frequenz added 2 commits April 28, 2026 14:45

Update docs for the new package layout

5e896bc

Signed-off-by: Phillip Wenig <phillip.wenig@frequenz.com>

Build and test maturin wheels in CI

167feed

Signed-off-by: Phillip Wenig <phillip.wenig@frequenz.com>

phillip-wenig-frequenz force-pushed the add-binding branch from 1461740 to 167feed Compare April 28, 2026 12:45

shsms approved these changes Apr 28, 2026

View reviewed changes

phillip-wenig-frequenz merged commit 19930e0 into frequenz-floss:v0.x.x Apr 28, 2026
8 checks passed

phillip-wenig-frequenz deleted the add-binding branch April 28, 2026 13:02

llucax mentioned this pull request May 5, 2026

Revert worsened workflow security #27

Open

llucax reviewed May 5, 2026

View reviewed changes

llucax removed the request for review from leandro-lucarella-frequenz May 5, 2026 07:52

phillip-wenig-frequenz mentioned this pull request May 7, 2026

ci: restore security hardening to GitHub Actions workflows #29

Open

		uses: frequenz-floss/gh-action-nox@80a9845a59ffc71d27b9c41099eb6cb55bc7b671 # v1.1.1
		uses: frequenz-floss/gh-action-nox@v1.0.1

Conversation

phillip-wenig-frequenz commented Apr 23, 2026

Summary

Changes

Upgrade Notes

Validation

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

shsms left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

llucax left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants