Automated Protos Update (#527)

Co-authored-by: viambot <[email protected]>
Co-authored-by: Naveed Jooma <[email protected]>

Author: 3 people

.vscode/settings.json

@@ -1,37 +1,36 @@
 {
-    "[python]": {
-        "editor.defaultFormatter": "ms-python.black-formatter",
-        "editor.formatOnSave": true,
-    },
-    "python.linting.flake8Enabled": true,
-    "editor.formatOnSave": true,
-    "python.analysis.typeCheckingMode": "basic",
-    "python.linting.ignorePatterns": [
-        "**/site-packages/**/*.py",
-        ".vscode/*.py",
-        "gen/**/*",
-        "viam/proto/**/*"
-    ],
-    "files.trimTrailingWhitespace": true,
-    "files.insertFinalNewline": true,
-    "editor.rulers": [
-        {
-            "column": 140,
-            "color": "#777777"
-        }
-    ],
-    "python.formatting.provider": "black",
-    "cSpell.words": [
-        "frombytes",
-        "grpclib",
-        "klass",
-        "pointcloud",
-        "segmenters",
-        "TFLITE",
-        "tobytes",
-        "viam"
-    ],
-    "isort.args": [
-        "-l 140 --profile black"
-    ],
+  "[python]": {
+    "editor.defaultFormatter": "ms-python.black-formatter",
+    "editor.formatOnSave": true
+  },
+  "python.linting.flake8Enabled": true,
+  "editor.formatOnSave": true,
+  "python.analysis.typeCheckingMode": "basic",
+  "python.linting.ignorePatterns": [
+    "**/site-packages/**/*.py",
+    ".vscode/*.py",
+    "gen/**/*",
+    "viam/proto/**/*"
+  ],
+  "files.trimTrailingWhitespace": true,
+  "files.insertFinalNewline": true,
+  "editor.rulers": [
+    {
+      "column": 140,
+      "color": "#777777"
+    }
+  ],
+  "python.formatting.provider": "black",
+  "cSpell.words": [
+    "frombytes",
+    "grpclib",
+    "klass",
+    "pointcloud",
+    "RSDK",
+    "segmenters",
+    "TFLITE",
+    "tobytes",
+    "viam"
+  ],
+  "isort.args": ["-l 140 --profile black"]
 }

docs/examples/_server.py

@@ -110,9 +110,6 @@
     Location,
     LocationAuthRequest,
     LocationAuthResponse,
-)
-from viam.proto.app import LogEntry as LogEntryPB
-from viam.proto.app import (
     MarkPartAsMainRequest,
     MarkPartAsMainResponse,
     MarkPartForRestartRequest,
@@ -208,6 +205,7 @@
     StreamingDataCaptureUploadRequest,
     StreamingDataCaptureUploadResponse,
 )
+from viam.proto.common import LogEntry as LogEntryPB
 from viam.utils import datetime_to_timestamp, dict_to_struct, value_to_primitive
 
 

poetry.lock

@@ -14,9 +14,6 @@ class _LogsStream(Protocol[LogsType]):
     async def next(self) -> LogsType:
         ...
 
-    async def close(self):
-        ...
-
     def __aiter__(self) -> AsyncIterator:
         ...
 
@@ -38,6 +35,3 @@ def __aiter__(self):
 
     async def __anext__(self) -> LogsType:
         return await self._stream.__anext__()
-
-    async def close(self):
-        return await super().close()

src/viam/app/_logs.py

@@ -84,9 +84,6 @@
     LocationAuth,
     LocationAuthRequest,
     LocationAuthResponse,
-)
-from viam.proto.app import LogEntry as LogEntryPB
-from viam.proto.app import (
     MarkPartAsMainRequest,
     MarkPartForRestartRequest,
     Model,
@@ -129,6 +126,7 @@
     UploadModuleFileRequest,
     Visibility,
 )
+from viam.proto.common import LogEntry as LogEntryPB
 from viam.utils import datetime_to_timestamp, dict_to_struct, struct_to_dict
 
 LOGGER = logging.getLogger(__name__)
@@ -319,7 +317,7 @@ def from_proto(cls, robot_part_history_entry: RobotPartHistoryEntryPB) -> Self:
         """Create a `RobotPartHistoryEntry` from the .proto defined `RobotPartHistoryEntry`.
 
         Args:
-            robo_part_history_entry (viam.proto.app.RobotPartHistoryEntry): The object to copy from.
+            robot_part_history_entry (viam.proto.app.RobotPartHistoryEntry): The object to copy from.
 
         Returns:
             RobotPartHistoryEntry: The `RobotPartHistoryEntry`.
@@ -615,7 +613,7 @@ async def delete_organization_invite(self, email: str) -> None:
         await self._app_client.DeleteOrganizationInvite(request, metadata=self._metadata)
 
     async def resend_organization_invite(self, email: str) -> OrganizationInvite:
-        """Resends a pending organization invite email.
+        """Re-sends a pending organization invite email.
 
         Args:
             email (str): The email address associated with the invite.
@@ -906,16 +904,16 @@ async def _get_robot_part_logs(self, robot_part_id: str, filter: str, errors_onl
     async def tail_robot_part_logs(
         self, robot_part_id: str, errors_only: bool = True, filter: Optional[str] = None
     ) -> _LogsStream[List[LogEntry]]:
-        """Get an asynchronous iterator that recieves live robot part logs.
+        """Get an asynchronous iterator that receives live robot part logs.
 
         Args:
-            robot_part_id (str): ID of the robot part to retrieve lgos from.
+            robot_part_id (str): ID of the robot part to retrieve logs from.
             errors_only (bool): Boolean specifying whether or not to only include error logs. Defaults to True.
             filter (Optional[str]): Only include logs with messages that contain the string `filter`. Defaults to empty string "" (i.e., no
                 filter).
 
         Returns:
-            _LogsStream[List[LogEntry]]: The asynchronous iterator recieving live robot part logs.
+            _LogsStream[List[LogEntry]]: The asynchronous iterator receiving live robot part logs.
         """
 
         async def read() -> AsyncIterator[List[LogEntry]]:
@@ -1124,7 +1122,7 @@ async def list_fragments(self, show_public: bool = True) -> List[Fragment]:
         """Get a list of fragments under the currently authed-to organization.
 
         Args:
-            show_public: Optional boolean specifiying whether or not to only show public fragments. If True, only public fragments will
+            show_public: Optional boolean specifying whether or not to only show public fragments. If True, only public fragments will
                 return. If False, only private fragments will return. Defaults to True.
 
         Returns:

src/viam/app/app_client.py

@@ -51,7 +51,7 @@ async def Properties(self, stream: Stream[PropertiesRequest, PropertiesResponse]
         response = (await audio_input.get_properties(timeout=timeout, metadata=stream.metadata)).proto
         await stream.send_message(response)
 
-    async def Record(self, stream: Stream[RecordRequest, HttpBody]) -> None:  # pyright: ignore [reportGeneralTypeIssues]
+    async def Record(self, stream: Stream[RecordRequest, HttpBody]) -> None:  # pyright: ignore [reportInvalidTypeForm]
         raise NotSupportedError("Recording audio input is not supported").grpc_error
 
         # TODO: Eventually implement recording

src/viam/components/audio_input/service.py

@@ -80,7 +80,7 @@ async def GetImages(self, stream: Stream[GetImagesRequest, GetImagesResponse]) -
         response = GetImagesResponse(images=img_bytes_lst, response_metadata=metadata)
         await stream.send_message(response)
 
-    async def RenderFrame(self, stream: Stream[RenderFrameRequest, HttpBody]) -> None:
+    async def RenderFrame(self, stream: Stream[RenderFrameRequest, HttpBody]) -> None:  # pyright: ignore [reportInvalidTypeForm]
         request = await stream.recv_message()
         assert request is not None
         name = request.name