Add up_rust_py package with documentation and examples by sachinkum0009 · Pull Request #1 · eclipse-uprotocol/up-rust-py

sachinkum0009 · 2026-02-18T22:45:22Z

Introduce the up_rust_py package, providing Python bindings for uProtocol. Include necessary modules, documentation, and example scripts for usage. This addition enhances the project's functionality and usability.

sophokles73

I have provided a few hints and proposals for improvement. My Python knowledge is very limited so I the review of the python code might not be as thorough as you would expect.

I do like the clear structuring and that you already thought about including proper documentation 👍

In general, the Eclipse license header is missing in all files. You may want to take a look a the up-rust repository for the format of the header and where to add it.

sophokles73 · 2026-02-26T08:11:23Z

+requires-python = ">=3.8"
+description = "Python bindings for Eclipse uProtocol Rust implementation"
+readme = "README.md"
+license = { text = "Apache-2.0" }


From what I see at https://packaging.python.org/en/latest/guides/writing-pyproject-toml/#license-and-license-files this should probably be

license = "Apache-2.0"

or am I mistaken?

Thanks, you're right. I will fix it.

sophokles73 · 2026-02-26T08:16:16Z

+mqtt = []   # MQTT transport (future)
+someip = [] # SOME/IP automotive protocol (future)


IMHO we should omit these until there actually is support for them ...

sophokles73 · 2026-02-26T08:17:43Z

+discovery = []     # Service discovery (udiscovery feature)
+subscription = []  # Advanced subscription management (usubscription feature)
+twin = []          # Digital twin support (utwin feature)
+cloudevents = []   # CloudEvents format support


same here, FMPOV it is totally ok to only start with what is really supported. Once you add more bindings, e.g. for the uSubscription service interface, you can add a corresponding feature extension ..

sophokles73 · 2026-02-26T08:26:07Z

+
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/sachinkum0009/up-rust-py.git


I guess this should become https://github.com/eclipse-uprotocol/up-rust-py.git, right?

sophokles73 · 2026-02-26T08:26:56Z

+- Python 3.8 or higher
+- pip (Python package installer)
+
+## Install from PyPI


IMHO we should add a section recommending to use a virtual environment?

sophokles73 · 2026-02-26T08:28:24Z

+
+Here's a simple example that demonstrates publishing and receiving messages:
+
+```python


instead of pasting the code in here (where we will have a hard time keeping it in sync with the code base), we should probably simply refer to a file in the examples folder?

sophokles73 · 2026-02-26T08:30:31Z

+    entity ID, and version to create unique identifiers.
+    """
+
+    def __init__(self, authority: str, entity_id: int, version: int) -> None:


what happens if I provide a version value that is out of range?

I found out that the PyO3 automatically converts Python types to Rust Types with validation.

If the value is out of range, it will return a OverflowError.

sophokles73 · 2026-02-26T08:32:04Z

+                        Will be called when messages arrive.
+
+        Raises:
+            Exception: If registration fails.


I am not too familiar with error handling in Python but Exception looks very generic to me. Isn't there a concept for having more specific errors being reported?

Thanks, I created a custom Expection class to handle and map the error from the rust e.g, UStatusError.

sachinkum0009 · 2026-03-04T19:10:07Z

… quickstart

…nippets

…rity and organization

sophokles73 · 2026-03-30T07:46:11Z

+- 🐍 **Pythonic API**: Easy-to-use interfaces that feel natural in Python
+- ⚡ **Async Ready**: Built on Tokio async runtime for efficient I/O operations
+
+## Installation (Comming Soon)


If the package is not (yet) available from PyPi, then FMPOV we should not describe this as the (primary) way of installing the library, but add it once the package has been published for the first time. Otherwise, you will get questions why installation does not work as described ...

Agree. I will update the Readme instructions.

sophokles73 · 2026-03-30T07:47:24Z

+1. **Build from source using virtualenv**:
+
+```bash
+# activate virtualenv


I am not sure what this comment is supposed do mean. Do I need to manually activate virtualenv before, or does pip install maturing activate virtualenv?

Yes, when using virtualenv. You have to manually activate virtualenv and then run the pip install command.

sophokles73 · 2026-03-30T07:48:50Z

+- **PyO3 Bindings**: Zero-cost abstractions between Python and Rust
+- **Python API**: Pythonic interfaces with full type hints
+
+Each async operation maintains its own Tokio runtime for thread-safe execution across the Python/Rust boundary.


This sounds very expensive. Is this the recommended/established way to do this?

You're right. I will search for different way.

sophokles73 · 2026-03-30T07:50:52Z

+
+    # Wait a bit more for messages to be received
+    print("\n3. Waiting for message delivery...")
+    time.sleep(2)


IMHO we should not sleep here but instead use some channel to signal that the receiver has actually received the message that had been sent.

sophokles73 · 2026-03-30T07:54:57Z

+    ///     >>> text = message.extract_string()
+    ///     >>> if text:
+    ///     ...     print(f"Received: {text}")
+    fn extract_string(&self) -> PyResult<Option<String>> {


this function seems to completely contradict the error handling logic from up_rust. Is this by intention? Unless there is a compelling reason to do so, I would propose to simply stick with the API provided by UMessage, e.g. extracting the payload as a byte array or deserializing ProtoBuf messages ...

sachinkum0009 added 3 commits February 18, 2026 23:44

up_rust_py package added

8f83319

github repo links updated

9e4e0cc

minor changes

0680ccf

sophokles73 reviewed Feb 26, 2026

View reviewed changes

sachinkum0009 added 19 commits March 4, 2026 20:20

update repository links to point to the Eclipse uProtocol organization

f96f1a2

fix: update license format in pyproject.toml

19653da

fix: add license-files entry in pyproject.toml

a515a6f

removed 3.8 and 3.9 support to use pytest 9.0.2

5c7d072

description updated regarding what it is and use for

ee6eb36

removed the features of which bindings are not created yet

3ee928e

clean readme to include the example files instead of example code for…

b6b1a3d

… quickstart

mkdocs plugin updated to generated api docs from code

7c4c7f2

commented the features until implemented

e91fb25

update usage guide to simplify examples and remove unnecessary code s…

5af044e

…nippets

clean the code

c002aa8

Add UStatusError exception handling to local transport module

416d709

Registration Error Exception added

5756378

examples updated to use UStatusError and RegistrationError

ea0c611

Add SPDX license headers to all source and example files

382fea2

Refactor feature definitions in Cargo.toml and pyproject.toml for cla…

36e77cb

…rity and organization

removed the description of each script and format the code

8397cb3

Major refactoring of code

eeaad87

readme updated and refactored

1232b21

sachinkum0009 marked this pull request as ready for review March 29, 2026 21:02

pre commit config added and files formatted

e198582

sophokles73 reviewed Mar 30, 2026

View reviewed changes

sachinkum0009 added 2 commits March 31, 2026 16:38

PyPi installation instructions removed as not released to PyPi yet

fa66fdf

Instructions updated to create virtualenv to build

93a7b41

		mqtt = [] # MQTT transport (future)
		someip = [] # SOME/IP automotive protocol (future)


		Here's a simple example that demonstrates publishing and receiving messages:

		```python

Conversation

sachinkum0009 commented Feb 18, 2026

Uh oh!

sophokles73 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

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!

sachinkum0009 commented Mar 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

To Do

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!

2 participants

sachinkum0009 commented Mar 4, 2026 •

edited

Loading