dora-rs 0.3.10rc3__cp37-abi3-musllinux_1_2_aarch64.whl → 0.3.11rc1__cp37-abi3-musllinux_1_2_aarch64.whl

dora/__init__.py

@@ -1,10 +1,11 @@
 """ 
-# dora-rs
+# dora-rs.
+
 This is the dora python client for interacting with dora dataflow.
 You can install it via:
 ```bash
 pip install dora-rs
-```
+```.
 """
 
 from enum import Enum
@@ -28,8 +29,7 @@ from .dora import (
 
 
 class DoraStatus(Enum):
-    """Dora status to indicate if operator `on_input` loop
-     should be stopped.
+    """Dora status to indicate if operator `on_input` loop should be stopped.
 
     Args:
         Enum (u8): Status signaling to dora operator to

dora/__init__.pyi

@@ -1,86 +1,100 @@
-import dora
-import pyarrow
 import typing
 
+import pyarrow
+
+import dora
+
 @typing.final
 class Enum:
     """Generic enumeration.
 
-Derive from this class to define new enumerations."""
+    Derive from this class to define new enumerations.
+    """
+
     __members__: mappingproxy = ...
 
 @typing.final
 class Node:
     """The custom node API lets you integrate `dora` into your application.
-It allows you to retrieve input and send output in any fashion you want.
+    
+    It allows you to retrieve input and send output in any fashion you want.
 
-Use with:
+    Use with:
 
-```python
-from dora import Node
+    ```python
+    from dora import Node
 
-node = Node()
-```"""
+    node = Node()
+    ```
+    """
 
     def __init__(self, node_id: str=None) -> None:
-        """The custom node API lets you integrate `dora` into your application.
-It allows you to retrieve input and send output in any fashion you want.
+        """Use the custom node API to embed `dora` into your application.
 
-Use with:
+        It allows you to retrieve input and send output in any fashion you want.
 
-```python
-from dora import Node
+        Use with:
 
-node = Node()
-```"""
+        ```python
+        from dora import Node
+
+        node = Node()
+        ```
+        """
 
     def dataflow_descriptor(self) -> dict:
-        """Returns the full dataflow descriptor that this node is part of.
+        """Return the full dataflow descriptor that this node is part of.
 
-This method returns the parsed dataflow YAML file."""
+        This method returns the parsed dataflow YAML file.
+        """
 
     def dataflow_id(self) -> str:
-        """Returns the dataflow id."""
+        """Return the dataflow id."""
 
     def merge_external_events(self, subscription: dora.Ros2Subscription) -> None:
         """Merge an external event stream with dora main loop.
-This currently only work with ROS2."""
+
+        This currently only work with ROS2.
+        """
 
     def next(self, timeout: float=None) -> dict:
         """`.next()` gives you the next input that the node has received.
-It blocks until the next event becomes available.
-You can use timeout in seconds to return if no input is available.
-It will return `None` when all senders has been dropped.
 
-```python
-event = node.next()
-```
+        It blocks until the next event becomes available.
+        You can use timeout in seconds to return if no input is available.
+        It will return `None` when all senders has been dropped.
+
+        ```python
+        event = node.next()
+        ```
 
-You can also iterate over the event stream with a loop
+        You can also iterate over the event stream with a loop
 
-```python
-for event in node:
-match event["type"]:
-case "INPUT":
-match event["id"]:
-case "image":
-```"""
+        ```python
+        for event in node:
+        match event["type"]:
+        case "INPUT":
+        match event["id"]:
+        case "image":
+        ```
+        """
 
     def send_output(self, output_id: str, data: pyarrow.Array, metadata: dict=None) -> None:
         """`send_output` send data from the node.
 
-```python
-Args:
-output_id: str,
-data: pyarrow.Array,
-metadata: Option[Dict],
-```
+        ```python
+        Args:
+        output_id: str,
+        data: pyarrow.Array,
+        metadata: Option[Dict],
+        ```
 
-ex:
+        ex:
 
-```python
-node.send_output("string", b"string", {"open_telemetry_context": "7632e76"})
-```"""
+        ```python
+        node.send_output("string", b"string", {"open_telemetry_context": "7632e76"})
+        ```
+        """
 
     def __iter__(self) -> typing.Any:
         """Implement iter(self)."""
@@ -92,63 +106,66 @@ node.send_output("string", b"string", {"open_telemetry_context": "7632e76"})
 class Ros2Context:
     """ROS2 Context holding all messages definition for receiving and sending messages to ROS2.
 
-By default, Ros2Context will use env `AMENT_PREFIX_PATH` to search for message definition.
+    By default, Ros2Context will use env `AMENT_PREFIX_PATH` to search for message definition.
 
-AMENT_PREFIX_PATH folder structure should be the following:
+    AMENT_PREFIX_PATH folder structure should be the following:
 
-- For messages: <namespace>/msg/<name>.msg
-- For services: <namespace>/srv/<name>.srv
+    - For messages: <namespace>/msg/<name>.msg
+    - For services: <namespace>/srv/<name>.srv
 
-You can also use `ros_paths` if you don't want to use env variable.
+    You can also use `ros_paths` if you don't want to use env variable.
 
-warning::
-dora Ros2 bridge functionality is considered **unstable**. It may be changed
-at any point without it being considered a breaking change.
+    warning::
+    dora Ros2 bridge functionality is considered **unstable**. It may be changed
+    at any point without it being considered a breaking change.
 
-```python
-context = Ros2Context()
-```"""
+    ```python
+    context = Ros2Context()
+    ```
+    """
 
-    def __init__(self, ros_paths: typing.List[str]=None) -> None:
+    def __init__(self, ros_paths: list[str]=None) -> None:
         """ROS2 Context holding all messages definition for receiving and sending messages to ROS2.
 
-By default, Ros2Context will use env `AMENT_PREFIX_PATH` to search for message definition.
+        By default, Ros2Context will use env `AMENT_PREFIX_PATH` to search for message definition.
 
-AMENT_PREFIX_PATH folder structure should be the following:
+        AMENT_PREFIX_PATH folder structure should be the following:
 
-- For messages: <namespace>/msg/<name>.msg
-- For services: <namespace>/srv/<name>.srv
+        - For messages: <namespace>/msg/<name>.msg
+        - For services: <namespace>/srv/<name>.srv
 
-You can also use `ros_paths` if you don't want to use env variable.
+        You can also use `ros_paths` if you don't want to use env variable.
 
-warning::
-dora Ros2 bridge functionality is considered **unstable**. It may be changed
-at any point without it being considered a breaking change.
+        warning::
+        dora Ros2 bridge functionality is considered **unstable**. It may be changed
+        at any point without it being considered a breaking change.
 
-```python
-context = Ros2Context()
-```"""
+        ```python
+        context = Ros2Context()
+        ```
+        """
 
     def new_node(self, name: str, namespace: str, options: dora.Ros2NodeOptions) -> dora.Ros2Node:
-        """Create a new ROS2 node
+        """Create a new ROS2 node.
 
-```python
-ros2_node = ros2_context.new_node(
-"turtle_teleop",
-"/ros2_demo",
-Ros2NodeOptions(rosout=True),
-)
-```
+        ```python
+        ros2_node = ros2_context.new_node(
+        "turtle_teleop",
+        "/ros2_demo",
+        Ros2NodeOptions(rosout=True),
+        )
+        ```
 
-warning::
-dora Ros2 bridge functionality is considered **unstable**. It may be changed
-at any point without it being considered a breaking change."""
+        warning::
+        dora Ros2 bridge functionality is considered **unstable**. It may be changed
+        at any point without it being considered a breaking change.
+        """
 
 @typing.final
 class Ros2Durability:
-    """DDS 2.2.3.4 DURABILITY"""
+    """DDS 2.2.3.4 DURABILITY."""
 
-    def __eq__(self, value: typing.Any) -> bool:
+    def __eq__(self, value: object) -> bool:
         """Return self==value."""
 
     def __ge__(self, value: typing.Any) -> bool:
@@ -158,7 +175,7 @@ class Ros2Durability:
         """Return self>value."""
 
     def __int__(self) -> None:
-        """int(self)"""
+        """int(self)."""
 
     def __le__(self, value: typing.Any) -> bool:
         """Return self<=value."""
@@ -166,11 +183,9 @@ class Ros2Durability:
     def __lt__(self, value: typing.Any) -> bool:
         """Return self<value."""
 
-    def __ne__(self, value: typing.Any) -> bool:
+    def __ne__(self, value: object) -> bool:
         """Return self!=value."""
 
-    def __repr__(self) -> str:
-        """Return repr(self)."""
     Persistent: Ros2Durability = ...
     Transient: Ros2Durability = ...
     TransientLocal: Ros2Durability = ...
@@ -178,9 +193,9 @@ class Ros2Durability:
 
 @typing.final
 class Ros2Liveliness:
-    """DDS 2.2.3.11 LIVELINESS"""
+    """DDS 2.2.3.11 LIVELINESS."""
 
-    def __eq__(self, value: typing.Any) -> bool:
+    def __eq__(self, value: object) -> bool:
         """Return self==value."""
 
     def __ge__(self, value: typing.Any) -> bool:
@@ -190,7 +205,7 @@ class Ros2Liveliness:
         """Return self>value."""
 
     def __int__(self) -> None:
-        """int(self)"""
+        """int(self)."""
 
     def __le__(self, value: typing.Any) -> bool:
         """Return self<=value."""
@@ -198,114 +213,123 @@ class Ros2Liveliness:
     def __lt__(self, value: typing.Any) -> bool:
         """Return self<value."""
 
-    def __ne__(self, value: typing.Any) -> bool:
+    def __ne__(self, value: object) -> bool:
         """Return self!=value."""
 
-    def __repr__(self) -> str:
-        """Return repr(self)."""
     Automatic: Ros2Liveliness = ...
     ManualByParticipant: Ros2Liveliness = ...
     ManualByTopic: Ros2Liveliness = ...
 
 @typing.final
 class Ros2Node:
-    """ROS2 Node
+    """ROS2 Node.
 
-warnings::
-- dora Ros2 bridge functionality is considered **unstable**. It may be changed
-at any point without it being considered a breaking change.
-- There's a known issue about ROS2 nodes not being discoverable by ROS2
-See: https://github.com/jhelovuo/ros2-client/issues/4"""
+    warnings::
+    - dora Ros2 bridge functionality is considered **unstable**. It may be changed
+    at any point without it being considered a breaking change.
+    - There's a known issue about ROS2 nodes not being discoverable by ROS2
+    See: https://github.com/jhelovuo/ros2-client/issues/4
+    """
 
     def create_publisher(self, topic: dora.Ros2Topic, qos: dora.Ros2QosPolicies=None) -> dora.Ros2Publisher:
-        """Create a ROS2 publisher
+        """Create a ROS2 publisher.
 
-```python
-pose_publisher = ros2_node.create_publisher(turtle_pose_topic)
-```
-warnings:
-- dora Ros2 bridge functionality is considered **unstable**. It may be changed
-at any point without it being considered a breaking change."""
+        ```python
+        pose_publisher = ros2_node.create_publisher(turtle_pose_topic)
+        ```
+        warnings:
+        - dora Ros2 bridge functionality is considered **unstable**. It may be changed
+        at any point without it being considered a breaking change.
+        """
 
     def create_subscription(self, topic: dora.Ros2Topic, qos: dora.Ros2QosPolicies=None) -> dora.Ros2Subscription:
-        """Create a ROS2 subscription
+        """Create a ROS2 subscription.
 
-```python
-pose_reader = ros2_node.create_subscription(turtle_pose_topic)
-```
+        ```python
+        pose_reader = ros2_node.create_subscription(turtle_pose_topic)
+        ```
 
-warnings:
-- dora Ros2 bridge functionality is considered **unstable**. It may be changed
-at any point without it being considered a breaking change."""
+        Warnings:
+        - dora Ros2 bridge functionality is considered **unstable**. It may be changed
+        at any point without it being considered a breaking change.
+
+        """
 
     def create_topic(self, name: str, message_type: str, qos: dora.Ros2QosPolicies) -> dora.Ros2Topic:
         """Create a ROS2 topic to connect to.
 
-```python
-turtle_twist_topic = ros2_node.create_topic(
-"/turtle1/cmd_vel", "geometry_msgs/Twist", topic_qos
-)
-```"""
+        ```python
+        turtle_twist_topic = ros2_node.create_topic(
+        "/turtle1/cmd_vel", "geometry_msgs/Twist", topic_qos
+        )
+        ```
+        """
 
 @typing.final
 class Ros2NodeOptions:
-    """ROS2 Node Options"""
+    """ROS2 Node Options."""
 
     def __init__(self, rosout: bool=None) -> None:
-        """ROS2 Node Options"""
+        """ROS2 Node Options."""
 
 @typing.final
 class Ros2Publisher:
-    """ROS2 Publisher
+    """ROS2 Publisher.
+
+    Warnings:
+    - dora Ros2 bridge functionality is considered **unstable**. It may be changed
+    at any point without it being considered a breaking change.
 
-warnings:
-- dora Ros2 bridge functionality is considered **unstable**. It may be changed
-at any point without it being considered a breaking change."""
+    """
 
     def publish(self, data: pyarrow.Array) -> None:
         """Publish a message into ROS2 topic.
 
-Remember that the data format should respect the structure of the ROS2 message using an arrow Structure.
-
-ex:
-```python
-gripper_command.publish(
-pa.array(
-[
-{
-"name": "gripper",
-"cmd": np.float32(5),
-}
-]
-),
-)
-```"""
+        Remember that the data format should respect the structure of the ROS2 message using an arrow Structure.
+
+        ex:
+        ```python
+        gripper_command.publish(
+        pa.array(
+        [
+        {
+        "name": "gripper",
+        "cmd": np.float32(5),
+        }
+        ]
+        ),
+        )
+        ```
+        """
 
 @typing.final
 class Ros2QosPolicies:
-    """ROS2 QoS Policy"""
+    """ROS2 QoS Policy."""
 
     def __init__(self, durability: dora.Ros2Durability=None, liveliness: dora.Ros2Liveliness=None, reliable: bool=None, keep_all: bool=None, lease_duration: float=None, max_blocking_time: float=None, keep_last: int=None) -> dora.Ros2QoSPolicies:
-        """ROS2 QoS Policy"""
+        """ROS2 QoS Policy."""
 
 @typing.final
 class Ros2Subscription:
-    """ROS2 Subscription
+    """ROS2 Subscription.
 
+    Warnings:
+    - dora Ros2 bridge functionality is considered **unstable**. It may be changed
+    at any point without it being considered a breaking change.
 
-warnings:
-- dora Ros2 bridge functionality is considered **unstable**. It may be changed
-at any point without it being considered a breaking change."""
+    """
 
     def next(self):...
 
 @typing.final
 class Ros2Topic:
-    """ROS2 Topic
+    """ROS2 Topic.
+
+    Warnings:
+    - dora Ros2 bridge functionality is considered **unstable**. It may be changed
+    at any point without it being considered a breaking change.
 
-warnings:
-- dora Ros2 bridge functionality is considered **unstable**. It may be changed
-at any point without it being considered a breaking change."""
+    """
 
 def start_runtime() -> None:
-    """Start a runtime for Operators"""
+    """Start a runtime for Operators."""

dora/cuda.py

@@ -1,3 +1,5 @@
+"""TODO: Add docstring."""
+
 import pyarrow as pa
 
 # Make sure to install torch with cuda
@@ -12,7 +14,7 @@ from pyarrow import cuda
 
 
 def torch_to_ipc_buffer(tensor: torch.TensorType) -> tuple[pa.array, dict]:
-    """Converts a Pytorch tensor into a pyarrow buffer containing the IPC handle and its metadata.
+    """Convert a Pytorch tensor into a pyarrow buffer containing the IPC handle and its metadata.
 
     Example Use:
     ```python
@@ -33,7 +35,7 @@ def torch_to_ipc_buffer(tensor: torch.TensorType) -> tuple[pa.array, dict]:
 
 
 def ipc_buffer_to_ipc_handle(handle_buffer: pa.array) -> cuda.IpcMemHandle:
-    """Converts a buffer containing a serialized handler into cuda IPC MemHandle.
+    """Convert a buffer containing a serialized handler into cuda IPC MemHandle.
 
     example use:
     ```python
@@ -50,12 +52,11 @@ def ipc_buffer_to_ipc_handle(handle_buffer: pa.array) -> cuda.IpcMemHandle:
     ```
     """
     handle_buffer = handle_buffer.buffers()[1]
-    ipc_handle = pa.cuda.IpcMemHandle.from_buffer(handle_buffer)
-    return ipc_handle
+    return pa.cuda.IpcMemHandle.from_buffer(handle_buffer)
 
 
 def cudabuffer_to_numba(buffer: cuda.CudaBuffer, metadata: dict) -> DeviceNDArray:
-    """Converts a pyarrow CUDA buffer to numba.
+    """Convert a pyarrow CUDA buffer to numba.
 
     example use:
     ```python
@@ -74,12 +75,11 @@ def cudabuffer_to_numba(buffer: cuda.CudaBuffer, metadata: dict) -> DeviceNDArra
     shape = metadata["shape"]
     strides = metadata["strides"]
     dtype = metadata["dtype"]
-    device_arr = DeviceNDArray(shape, strides, dtype, gpu_data=buffer.to_numba())
-    return device_arr
+    return DeviceNDArray(shape, strides, dtype, gpu_data=buffer.to_numba())
 
 
 def cudabuffer_to_torch(buffer: cuda.CudaBuffer, metadata: dict) -> torch.Tensor:
-    """Converts a pyarrow CUDA buffer to a torch tensor.
+    """Convert a pyarrow CUDA buffer to a torch tensor.
 
     example use:
     ```python
@@ -95,6 +95,4 @@ def cudabuffer_to_torch(buffer: cuda.CudaBuffer, metadata: dict) -> torch.Tensor
     torch_tensor = cudabuffer_to_torch(cudabuffer, event["metadata"])  # on cuda
     ```
     """
-    device_arr = cudabuffer_to_numba(buffer, metadata)
-    torch_tensor = torch.as_tensor(device_arr, device="cuda")
-    return torch_tensor
+    return torch.as_tensor(cudabuffer_to_numba(buffer, metadata), device="cuda")

{dora_rs-0.3.10rc3.dist-info → dora_rs-0.3.11rc1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dora-rs
-Version: 0.3.10rc3
+Version: 0.3.11rc1
 Requires-Dist: pyarrow
 Summary: `dora` goal is to be a low latency, composable, and distributed data flow.
 License: MIT

dora_rs-0.3.11rc1.dist-info/RECORD

@@ -0,0 +1,8 @@
+dora_rs-0.3.11rc1.dist-info/METADATA,sha256=pMogX_WlUTfayv-JsbHbblQxJdFnazJBhkvYZLqzp_c,628
+dora_rs-0.3.11rc1.dist-info/WHEEL,sha256=WrGUR7ngwVFrVacMsT0_VXRBz8qXxr-guHvJS0C03OA,106
+dora.libs/libgcc_s-e52197c3.so.1,sha256=vkPW1Auw6CH9Bjk7frmX3hry_1H9c0tRI0Ncyg71WUI,724137
+dora/__init__.py,sha256=mogA09uYFBIwnBnnMfeQtD52ZJbVbWmWo1h70GZj2aU,709
+dora/cuda.py,sha256=qpFjenSdwFFtUGX9zWypkPrxe094BnWpdevTvkCCj0k,3069
+dora/__init__.pyi,sha256=-jnLcWmFIi8ygYv44-VeYmq4e4I9a5zBHdz5q2Kae-E,9148
+dora/dora.abi3.so,sha256=xtEyUzqKDrYK4OoTh5hG7DXwjUiHLIlKZkZn6XRPyUE,43455265
+dora_rs-0.3.11rc1.dist-info/RECORD,,

{dora_rs-0.3.10rc3.dist-info → dora_rs-0.3.11rc1.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: maturin (1.8.2)
+Generator: maturin (1.8.3)
 Root-Is-Purelib: false
 Tag: cp37-abi3-musllinux_1_2_aarch64

dora_rs-0.3.10rc3.dist-info/RECORD

@@ -1,8 +0,0 @@
-dora_rs-0.3.10rc3.dist-info/METADATA,sha256=A8nVcWAUsXfcbrQAMxAYLTHwqwaIAr0fQH7Objbtk8I,628
-dora_rs-0.3.10rc3.dist-info/WHEEL,sha256=aHv5HX65QENlLW9e5L7TyxnWH-yvyCXdUtHfahe7pDg,106
-dora.libs/libgcc_s-e52197c3.so.1,sha256=vkPW1Auw6CH9Bjk7frmX3hry_1H9c0tRI0Ncyg71WUI,724137
-dora/__init__.pyi,sha256=MZfafEGo1F_Al2RLrD36_cGRfFgOYY8Qa1_14bFYcf0,8342
-dora/__init__.py,sha256=x3SdgwncpcHNnvLdsSc8Jrj1BBEC2uZVOCMYULyTrvo,711
-dora/cuda.py,sha256=KuB-J8cykDkcbLjeSYWt4oz5lbkrKOUycUh3o1hfJRA,3161
-dora/dora.abi3.so,sha256=3SsZx4AA2GW3Z0W6i0_x214vBG_piPRwfD1cx9q_fbY,23531713
-dora_rs-0.3.10rc3.dist-info/RECORD,,