viam-sdk 0.45.2__py3-none-linux_armv6l.whl → 0.47.0__py3-none-linux_armv6l.whl

viam/gen/app/v1/app_pb2.pyi

@@ -622,16 +622,10 @@ class UpdateOrganizationNamespaceRequest(google.protobuf.message.Message):
     organization_id: builtins.str
     new_public_namespace: builtins.str
 
-    def __init__(self, *, organization_id: builtins.str=..., new_public_namespace: builtins.str | None=...) -> None:
+    def __init__(self, *, organization_id: builtins.str=..., new_public_namespace: builtins.str=...) -> None:
         ...
 
-    def HasField(self, field_name: typing.Literal['_new_public_namespace', b'_new_public_namespace', 'new_public_namespace', b'new_public_namespace']) -> builtins.bool:
-        ...
-
-    def ClearField(self, field_name: typing.Literal['_new_public_namespace', b'_new_public_namespace', 'new_public_namespace', b'new_public_namespace', 'organization_id', b'organization_id']) -> None:
-        ...
-
-    def WhichOneof(self, oneof_group: typing.Literal['_new_public_namespace', b'_new_public_namespace']) -> typing.Literal['new_public_namespace'] | None:
+    def ClearField(self, field_name: typing.Literal['new_public_namespace', b'new_public_namespace', 'organization_id', b'organization_id']) -> None:
         ...
 global___UpdateOrganizationNamespaceRequest = UpdateOrganizationNamespaceRequest
 
@@ -3597,6 +3591,7 @@ class ModuleVersion(google.protobuf.message.Message):
     ENTRYPOINT_FIELD_NUMBER: builtins.int
     FIRST_RUN_FIELD_NUMBER: builtins.int
     MARKDOWN_DESCRIPTION_FIELD_NUMBER: builtins.int
+    APPS_FIELD_NUMBER: builtins.int
     version: builtins.str
     'The semver string that represents the major/minor/patch version of the module'
     entrypoint: builtins.str
@@ -3614,13 +3609,17 @@ class ModuleVersion(google.protobuf.message.Message):
     def models(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Model]:
         """The models that this verion of the module provides"""
 
-    def __init__(self, *, version: builtins.str=..., files: collections.abc.Iterable[global___Uploads] | None=..., models: collections.abc.Iterable[global___Model] | None=..., entrypoint: builtins.str=..., first_run: builtins.str | None=..., markdown_description: builtins.str | None=...) -> None:
+    @property
+    def apps(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___App]:
+        """A list of applications associated with the module"""
+
+    def __init__(self, *, version: builtins.str=..., files: collections.abc.Iterable[global___Uploads] | None=..., models: collections.abc.Iterable[global___Model] | None=..., entrypoint: builtins.str=..., first_run: builtins.str | None=..., markdown_description: builtins.str | None=..., apps: collections.abc.Iterable[global___App] | None=...) -> None:
         ...
 
     def HasField(self, field_name: typing.Literal['_first_run', b'_first_run', '_markdown_description', b'_markdown_description', 'first_run', b'first_run', 'markdown_description', b'markdown_description']) -> builtins.bool:
         ...
 
-    def ClearField(self, field_name: typing.Literal['_first_run', b'_first_run', '_markdown_description', b'_markdown_description', 'entrypoint', b'entrypoint', 'files', b'files', 'first_run', b'first_run', 'markdown_description', b'markdown_description', 'models', b'models', 'version', b'version']) -> None:
+    def ClearField(self, field_name: typing.Literal['_first_run', b'_first_run', '_markdown_description', b'_markdown_description', 'apps', b'apps', 'entrypoint', b'entrypoint', 'files', b'files', 'first_run', b'first_run', 'markdown_description', b'markdown_description', 'models', b'models', 'version', b'version']) -> None:
         ...
 
     @typing.overload
@@ -3640,6 +3639,7 @@ class ModuleMetadata(google.protobuf.message.Message):
     ENTRYPOINT_FIELD_NUMBER: builtins.int
     FIRST_RUN_FIELD_NUMBER: builtins.int
     MARKDOWN_DESCRIPTION_FIELD_NUMBER: builtins.int
+    APPS_FIELD_NUMBER: builtins.int
     entrypoint: builtins.str
     'The executable to run to start the module program'
     first_run: builtins.str
@@ -3657,13 +3657,17 @@ class ModuleMetadata(google.protobuf.message.Message):
         When this is returned from the backend, the versions are sorted in ascending order by the semver version
         """
 
-    def __init__(self, *, models: collections.abc.Iterable[global___Model] | None=..., versions: collections.abc.Iterable[global___ModuleVersion] | None=..., entrypoint: builtins.str=..., first_run: builtins.str | None=..., markdown_description: builtins.str | None=...) -> None:
+    @property
+    def apps(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___App]:
+        """A list of applications associated with the module"""
+
+    def __init__(self, *, models: collections.abc.Iterable[global___Model] | None=..., versions: collections.abc.Iterable[global___ModuleVersion] | None=..., entrypoint: builtins.str=..., first_run: builtins.str | None=..., markdown_description: builtins.str | None=..., apps: collections.abc.Iterable[global___App] | None=...) -> None:
         ...
 
     def HasField(self, field_name: typing.Literal['_first_run', b'_first_run', '_markdown_description', b'_markdown_description', 'first_run', b'first_run', 'markdown_description', b'markdown_description']) -> builtins.bool:
         ...
 
-    def ClearField(self, field_name: typing.Literal['_first_run', b'_first_run', '_markdown_description', b'_markdown_description', 'entrypoint', b'entrypoint', 'first_run', b'first_run', 'markdown_description', b'markdown_description', 'models', b'models', 'versions', b'versions']) -> None:
+    def ClearField(self, field_name: typing.Literal['_first_run', b'_first_run', '_markdown_description', b'_markdown_description', 'apps', b'apps', 'entrypoint', b'entrypoint', 'first_run', b'first_run', 'markdown_description', b'markdown_description', 'models', b'models', 'versions', b'versions']) -> None:
         ...
 
     @typing.overload
@@ -4231,6 +4235,7 @@ class UpdateModuleMetadata(google.protobuf.message.Message):
     DESCRIPTOR: google.protobuf.descriptor.Descriptor
     MODELS_FIELD_NUMBER: builtins.int
     ENTRYPOINT_FIELD_NUMBER: builtins.int
+    APPS_FIELD_NUMBER: builtins.int
     entrypoint: builtins.str
     'The executable to run to start the module program'
 
@@ -4238,10 +4243,14 @@ class UpdateModuleMetadata(google.protobuf.message.Message):
     def models(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Model]:
         """A list of models that are available in the module"""
 
-    def __init__(self, *, models: collections.abc.Iterable[global___Model] | None=..., entrypoint: builtins.str=...) -> None:
+    @property
+    def apps(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___App]:
+        """A list of applications associated with the module"""
+
+    def __init__(self, *, models: collections.abc.Iterable[global___Model] | None=..., entrypoint: builtins.str=..., apps: collections.abc.Iterable[global___App] | None=...) -> None:
         ...
 
-    def ClearField(self, field_name: typing.Literal['entrypoint', b'entrypoint', 'models', b'models']) -> None:
+    def ClearField(self, field_name: typing.Literal['apps', b'apps', 'entrypoint', b'entrypoint', 'models', b'models']) -> None:
         ...
 global___UpdateModuleMetadata = UpdateModuleMetadata
 
@@ -4441,6 +4450,7 @@ class Module(google.protobuf.message.Message):
     PUBLIC_NAMESPACE_FIELD_NUMBER: builtins.int
     FIRST_RUN_FIELD_NUMBER: builtins.int
     MARKDOWN_DESCRIPTION_FIELD_NUMBER: builtins.int
+    APPS_FIELD_NUMBER: builtins.int
     module_id: builtins.str
     "The id of the module (formatted as prefix:name where prefix is the module owner's orgid or namespace)"
     name: builtins.str
@@ -4476,13 +4486,17 @@ class Module(google.protobuf.message.Message):
     def models(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Model]:
         """A list of models that are available in the module"""
 
-    def __init__(self, *, module_id: builtins.str=..., name: builtins.str=..., visibility: global___Visibility.ValueType=..., versions: collections.abc.Iterable[global___VersionHistory] | None=..., url: builtins.str=..., description: builtins.str=..., models: collections.abc.Iterable[global___Model] | None=..., total_robot_usage: builtins.int=..., total_organization_usage: builtins.int=..., organization_id: builtins.str=..., entrypoint: builtins.str=..., public_namespace: builtins.str=..., first_run: builtins.str | None=..., markdown_description: builtins.str | None=...) -> None:
+    @property
+    def apps(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___App]:
+        """A list of applications associated with the module"""
+
+    def __init__(self, *, module_id: builtins.str=..., name: builtins.str=..., visibility: global___Visibility.ValueType=..., versions: collections.abc.Iterable[global___VersionHistory] | None=..., url: builtins.str=..., description: builtins.str=..., models: collections.abc.Iterable[global___Model] | None=..., total_robot_usage: builtins.int=..., total_organization_usage: builtins.int=..., organization_id: builtins.str=..., entrypoint: builtins.str=..., public_namespace: builtins.str=..., first_run: builtins.str | None=..., markdown_description: builtins.str | None=..., apps: collections.abc.Iterable[global___App] | None=...) -> None:
         ...
 
     def HasField(self, field_name: typing.Literal['_first_run', b'_first_run', '_markdown_description', b'_markdown_description', 'first_run', b'first_run', 'markdown_description', b'markdown_description']) -> builtins.bool:
         ...
 
-    def ClearField(self, field_name: typing.Literal['_first_run', b'_first_run', '_markdown_description', b'_markdown_description', 'description', b'description', 'entrypoint', b'entrypoint', 'first_run', b'first_run', 'markdown_description', b'markdown_description', 'models', b'models', 'module_id', b'module_id', 'name', b'name', 'organization_id', b'organization_id', 'public_namespace', b'public_namespace', 'total_organization_usage', b'total_organization_usage', 'total_robot_usage', b'total_robot_usage', 'url', b'url', 'versions', b'versions', 'visibility', b'visibility']) -> None:
+    def ClearField(self, field_name: typing.Literal['_first_run', b'_first_run', '_markdown_description', b'_markdown_description', 'apps', b'apps', 'description', b'description', 'entrypoint', b'entrypoint', 'first_run', b'first_run', 'markdown_description', b'markdown_description', 'models', b'models', 'module_id', b'module_id', 'name', b'name', 'organization_id', b'organization_id', 'public_namespace', b'public_namespace', 'total_organization_usage', b'total_organization_usage', 'total_robot_usage', b'total_robot_usage', 'url', b'url', 'versions', b'versions', 'visibility', b'visibility']) -> None:
         ...
 
     @typing.overload
@@ -4503,6 +4517,7 @@ class VersionHistory(google.protobuf.message.Message):
     ENTRYPOINT_FIELD_NUMBER: builtins.int
     FIRST_RUN_FIELD_NUMBER: builtins.int
     MARKDOWN_DESCRIPTION_FIELD_NUMBER: builtins.int
+    APPS_FIELD_NUMBER: builtins.int
     version: builtins.str
     'The semver string that represents the major/minor/patch version of the module'
     entrypoint: builtins.str
@@ -4520,13 +4535,17 @@ class VersionHistory(google.protobuf.message.Message):
     def models(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Model]:
         """The models that this verion of the module provides"""
 
-    def __init__(self, *, version: builtins.str=..., files: collections.abc.Iterable[global___Uploads] | None=..., models: collections.abc.Iterable[global___Model] | None=..., entrypoint: builtins.str=..., first_run: builtins.str | None=..., markdown_description: builtins.str | None=...) -> None:
+    @property
+    def apps(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___App]:
+        """A list of applications associated with the module"""
+
+    def __init__(self, *, version: builtins.str=..., files: collections.abc.Iterable[global___Uploads] | None=..., models: collections.abc.Iterable[global___Model] | None=..., entrypoint: builtins.str=..., first_run: builtins.str | None=..., markdown_description: builtins.str | None=..., apps: collections.abc.Iterable[global___App] | None=...) -> None:
         ...
 
     def HasField(self, field_name: typing.Literal['_first_run', b'_first_run', '_markdown_description', b'_markdown_description', 'first_run', b'first_run', 'markdown_description', b'markdown_description']) -> builtins.bool:
         ...
 
-    def ClearField(self, field_name: typing.Literal['_first_run', b'_first_run', '_markdown_description', b'_markdown_description', 'entrypoint', b'entrypoint', 'files', b'files', 'first_run', b'first_run', 'markdown_description', b'markdown_description', 'models', b'models', 'version', b'version']) -> None:
+    def ClearField(self, field_name: typing.Literal['_first_run', b'_first_run', '_markdown_description', b'_markdown_description', 'apps', b'apps', 'entrypoint', b'entrypoint', 'files', b'files', 'first_run', b'first_run', 'markdown_description', b'markdown_description', 'models', b'models', 'version', b'version']) -> None:
         ...
 
     @typing.overload

viam/gen/module/v1/module_pb2.py

@@ -8,7 +8,7 @@ _runtime_version.ValidateProtobufRuntimeVersion(_runtime_version.Domain.PUBLIC,
 _sym_db = _symbol_database.Default()
 from ...app.v1 import robot_pb2 as app_dot_v1_dot_robot__pb2
 from ...robot.v1 import robot_pb2 as robot_dot_v1_dot_robot__pb2
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x16module/v1/module.proto\x12\x0eviam.module.v1\x1a\x12app/v1/robot.proto\x1a\x14robot/v1/robot.proto"n\n\x12AddResourceRequest\x124\n\x06config\x18\x01 \x01(\x0b2\x1c.viam.app.v1.ComponentConfigR\x06config\x12"\n\x0cdependencies\x18\x02 \x03(\tR\x0cdependencies"\x15\n\x13AddResourceResponse"v\n\x1aReconfigureResourceRequest\x124\n\x06config\x18\x01 \x01(\x0b2\x1c.viam.app.v1.ComponentConfigR\x06config\x12"\n\x0cdependencies\x18\x02 \x03(\tR\x0cdependencies"\x1d\n\x1bReconfigureResourceResponse"+\n\x15RemoveResourceRequest\x12\x12\n\x04name\x18\x01 \x01(\tR\x04name"\x18\n\x16RemoveResourceResponse"h\n\x11HandlerDefinition\x12;\n\x07subtype\x18\x01 \x01(\x0b2!.viam.robot.v1.ResourceRPCSubtypeR\x07subtype\x12\x16\n\x06models\x18\x02 \x03(\tR\x06models"K\n\nHandlerMap\x12=\n\x08handlers\x18\x01 \x03(\x0b2!.viam.module.v1.HandlerDefinitionR\x08handlers"X\n\x0cReadyRequest\x12%\n\x0eparent_address\x18\x01 \x01(\tR\rparentAddress\x12!\n\x0cwebrtc_offer\x18\x02 \x01(\tR\x0bwebrtcOffer"\x86\x01\n\rReadyResponse\x12\x14\n\x05ready\x18\x01 \x01(\x08R\x05ready\x12:\n\nhandlermap\x18\x02 \x01(\x0b2\x1a.viam.module.v1.HandlerMapR\nhandlermap\x12#\n\rwebrtc_answer\x18\x03 \x01(\tR\x0cwebrtcAnswer"M\n\x15ValidateConfigRequest\x124\n\x06config\x18\x01 \x01(\x0b2\x1c.viam.app.v1.ComponentConfigR\x06config"<\n\x16ValidateConfigResponse\x12"\n\x0cdependencies\x18\x01 \x03(\tR\x0cdependencies2\xdf\x03\n\rModuleService\x12V\n\x0bAddResource\x12".viam.module.v1.AddResourceRequest\x1a#.viam.module.v1.AddResourceResponse\x12n\n\x13ReconfigureResource\x12*.viam.module.v1.ReconfigureResourceRequest\x1a+.viam.module.v1.ReconfigureResourceResponse\x12_\n\x0eRemoveResource\x12%.viam.module.v1.RemoveResourceRequest\x1a&.viam.module.v1.RemoveResourceResponse\x12D\n\x05Ready\x12\x1c.viam.module.v1.ReadyRequest\x1a\x1d.viam.module.v1.ReadyResponse\x12_\n\x0eValidateConfig\x12%.viam.module.v1.ValidateConfigRequest\x1a&.viam.module.v1.ValidateConfigResponseB\x1bZ\x19go.viam.com/api/module/v1b\x06proto3')
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x16module/v1/module.proto\x12\x0eviam.module.v1\x1a\x12app/v1/robot.proto\x1a\x14robot/v1/robot.proto"n\n\x12AddResourceRequest\x124\n\x06config\x18\x01 \x01(\x0b2\x1c.viam.app.v1.ComponentConfigR\x06config\x12"\n\x0cdependencies\x18\x02 \x03(\tR\x0cdependencies"\x15\n\x13AddResourceResponse"v\n\x1aReconfigureResourceRequest\x124\n\x06config\x18\x01 \x01(\x0b2\x1c.viam.app.v1.ComponentConfigR\x06config\x12"\n\x0cdependencies\x18\x02 \x03(\tR\x0cdependencies"\x1d\n\x1bReconfigureResourceResponse"+\n\x15RemoveResourceRequest\x12\x12\n\x04name\x18\x01 \x01(\tR\x04name"\x18\n\x16RemoveResourceResponse"h\n\x11HandlerDefinition\x12;\n\x07subtype\x18\x01 \x01(\x0b2!.viam.robot.v1.ResourceRPCSubtypeR\x07subtype\x12\x16\n\x06models\x18\x02 \x03(\tR\x06models"K\n\nHandlerMap\x12=\n\x08handlers\x18\x01 \x03(\x0b2!.viam.module.v1.HandlerDefinitionR\x08handlers"X\n\x0cReadyRequest\x12%\n\x0eparent_address\x18\x01 \x01(\tR\rparentAddress\x12!\n\x0cwebrtc_offer\x18\x02 \x01(\tR\x0bwebrtcOffer"\x86\x01\n\rReadyResponse\x12\x14\n\x05ready\x18\x01 \x01(\x08R\x05ready\x12:\n\nhandlermap\x18\x02 \x01(\x0b2\x1a.viam.module.v1.HandlerMapR\nhandlermap\x12#\n\rwebrtc_answer\x18\x03 \x01(\tR\x0cwebrtcAnswer"M\n\x15ValidateConfigRequest\x124\n\x06config\x18\x01 \x01(\x0b2\x1c.viam.app.v1.ComponentConfigR\x06config"q\n\x16ValidateConfigResponse\x12"\n\x0cdependencies\x18\x01 \x03(\tR\x0cdependencies\x123\n\x15optional_dependencies\x18\x02 \x03(\tR\x14optionalDependencies2\xdf\x03\n\rModuleService\x12V\n\x0bAddResource\x12".viam.module.v1.AddResourceRequest\x1a#.viam.module.v1.AddResourceResponse\x12n\n\x13ReconfigureResource\x12*.viam.module.v1.ReconfigureResourceRequest\x1a+.viam.module.v1.ReconfigureResourceResponse\x12_\n\x0eRemoveResource\x12%.viam.module.v1.RemoveResourceRequest\x1a&.viam.module.v1.RemoveResourceResponse\x12D\n\x05Ready\x12\x1c.viam.module.v1.ReadyRequest\x1a\x1d.viam.module.v1.ReadyResponse\x12_\n\x0eValidateConfig\x12%.viam.module.v1.ValidateConfigRequest\x1a&.viam.module.v1.ValidateConfigResponseB\x1bZ\x19go.viam.com/api/module/v1b\x06proto3')
 _globals = globals()
 _builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
 _builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'module.v1.module_pb2', _globals)
@@ -38,6 +38,6 @@ if not _descriptor._USE_C_DESCRIPTORS:
     _globals['_VALIDATECONFIGREQUEST']._serialized_start = 851
     _globals['_VALIDATECONFIGREQUEST']._serialized_end = 928
     _globals['_VALIDATECONFIGRESPONSE']._serialized_start = 930
-    _globals['_VALIDATECONFIGRESPONSE']._serialized_end = 990
-    _globals['_MODULESERVICE']._serialized_start = 993
-    _globals['_MODULESERVICE']._serialized_end = 1472
+    _globals['_VALIDATECONFIGRESPONSE']._serialized_end = 1043
+    _globals['_MODULESERVICE']._serialized_start = 1046
+    _globals['_MODULESERVICE']._serialized_end = 1525

viam/gen/module/v1/module_pb2.pyi

@@ -198,14 +198,19 @@ global___ValidateConfigRequest = ValidateConfigRequest
 class ValidateConfigResponse(google.protobuf.message.Message):
     DESCRIPTOR: google.protobuf.descriptor.Descriptor
     DEPENDENCIES_FIELD_NUMBER: builtins.int
+    OPTIONAL_DEPENDENCIES_FIELD_NUMBER: builtins.int
 
     @property
     def dependencies(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.str]:
         ...
 
-    def __init__(self, *, dependencies: collections.abc.Iterable[builtins.str] | None=...) -> None:
+    @property
+    def optional_dependencies(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.str]:
+        ...
+
+    def __init__(self, *, dependencies: collections.abc.Iterable[builtins.str] | None=..., optional_dependencies: collections.abc.Iterable[builtins.str] | None=...) -> None:
         ...
 
-    def ClearField(self, field_name: typing.Literal['dependencies', b'dependencies']) -> None:
+    def ClearField(self, field_name: typing.Literal['dependencies', b'dependencies', 'optional_dependencies', b'optional_dependencies']) -> None:
         ...
 global___ValidateConfigResponse = ValidateConfigResponse

viam/gen/robot/v1/robot_pb2.pyi

@@ -225,7 +225,7 @@ class TransformPCDRequest(google.protobuf.message.Message):
     SOURCE_FIELD_NUMBER: builtins.int
     DESTINATION_FIELD_NUMBER: builtins.int
     point_cloud_pcd: builtins.bytes
-    'the point clouds to transform. This should be in the PCD format\n    encoded into bytes: https://pointclouds.org/documentation/tutorials/pcd_file_format.html\n    '
+    'the point clouds to transform. This should be in the PCD format,\n    [encoded into bytes](https://pointclouds.org/documentation/tutorials/pcd_file_format.html).\n    '
     source: builtins.str
     'the reference frame of the point cloud.'
     destination: builtins.str

viam/gen/service/slam/v1/slam_pb2.pyi

@@ -117,7 +117,7 @@ class GetPointCloudMapResponse(google.protobuf.message.Message):
     DESCRIPTOR: google.protobuf.descriptor.Descriptor
     POINT_CLOUD_PCD_CHUNK_FIELD_NUMBER: builtins.int
     point_cloud_pcd_chunk: builtins.bytes
-    'One chunk of the PointCloud.\n    For a given GetPointCloudMap request, concatenating all\n    GetPointCloudMapResponse.point_cloud_pcd_chunk values in the\n    order received result in the complete pointcloud in standard PCD\n    format where XY is the ground plane and positive Z is up, following\n    the Right Hand Rule.\n\n    Read more about the pointcloud format here:\n    https://pointclouds.org/documentation/tutorials/pcd_file_format.html\n\n    Viam expects pointcloud data with fields "x y z" or "x y z rgb", and for\n    this to be specified in the pointcloud header in the FIELDS entry. If color\n    data is included in the pointcloud, Viam\'s services assume that the color\n    value encodes a confidence score for that data point. Viam expects the\n    confidence score to be encoded in the blue parameter of the RGB value, on a\n    scale from 1-100.\n\n    Pointclouds are little endian encoded.\n    '
+    'One chunk of the PointCloud.\n    For a given GetPointCloudMap request, concatenating all\n    GetPointCloudMapResponse.point_cloud_pcd_chunk values in the\n    order received result in the complete pointcloud in standard PCD\n    format where XY is the ground plane and positive Z is up, following\n    the Right Hand Rule.\n\n    Read more about the pointcloud format\n    [in the docs](https://pointclouds.org/documentation/tutorials/pcd_file_format.html)\n\n    Viam expects pointcloud data with fields "x y z" or "x y z rgb", and for\n    this to be specified in the pointcloud header in the FIELDS entry. If color\n    data is included in the pointcloud, Viam\'s services assume that the color\n    value encodes a confidence score for that data point. Viam expects the\n    confidence score to be encoded in the blue parameter of the RGB value, on a\n    scale from 1-100.\n\n    Pointclouds are little endian encoded.\n    '
 
     def __init__(self, *, point_cloud_pcd_chunk: builtins.bytes=...) -> None:
         ...

viam/module/module.py

@@ -3,6 +3,7 @@ import io
 import logging as pylogging
 import os
 import sys
+from collections.abc import Iterable
 from inspect import iscoroutinefunction
 from threading import Lock
 from typing import List, Mapping, Optional, Sequence, Tuple
@@ -275,7 +276,28 @@ class Module:
         model = Model.from_string(config.model)
         validator = Registry.lookup_validator(api, model)
         try:
-            dependencies = validator(config)
-            return ValidateConfigResponse(dependencies=dependencies)
+            # backwards compatibility. Support both ([], []) or [] with deprecation warning.
+            # If user's validate returns [str], it will be treated as required dependencies only.
+            # Incorect formats, e.g. int, will raise ValidationError.
+            _validator_return_test = validator(config)
+            if not (isinstance(_validator_return_test, tuple) and len(_validator_return_test) == 2):
+                msg = f"Your validate function {validator.__name__} did not return \
+                        type tuple[Sequence[str], Sequence[str]]. Got {_validator_return_test}."
+                self.logger.warning(msg)
+                if (isinstance(_validator_return_test, Iterable) and not isinstance(_validator_return_test, str)) and all(
+                    isinstance(e, str)
+                    for e in _validator_return_test  # type: ignore
+                ):
+                    self.logger.warning(
+                        f"Detected deprecated validate function signature. \
+                                        Treating all dependencies {_validator_return_test} as required dependencies. \
+                                        Please update to new signature Tuple[Sequence[str], Sequence[str]] soon."
+                    )
+                    return ValidateConfigResponse(dependencies=_validator_return_test)
+                else:
+                    raise ValidationError(msg)
+
+            dependencies, optional_dependencies = _validator_return_test
+            return ValidateConfigResponse(dependencies=dependencies, optional_dependencies=optional_dependencies)
         except Exception as e:
             raise ValidationError(f"{type(Exception)}: {e}").grpc_error

viam/resource/easy_resource.py

@@ -1,7 +1,7 @@
 import inspect
 import re
 from abc import ABCMeta
-from typing import Callable, ClassVar, Mapping, Sequence, Union
+from typing import Callable, ClassVar, Mapping, Sequence, Tuple, Union
 
 from viam.proto.app.robot import ComponentConfig
 from viam.proto.common import ResourceName
@@ -122,7 +122,7 @@ class EasyResource:
         return self
 
     @classmethod
-    def validate_config(cls, config: ComponentConfig) -> Sequence[str]:
+    def validate_config(cls, config: ComponentConfig) -> Tuple[Sequence[str], Sequence[str]]:
         """This method allows you to validate the configuration object received from the machine,
         as well as to return any implicit dependencies based on that `config`.
 
@@ -130,9 +130,9 @@ class EasyResource:
             config (ComponentConfig): The configuration for this resource
 
         Returns:
-            Sequence[str]: A list of implicit dependencies
+            Tuple[Sequence[str], Sequence[str]]: One list of required implicit dependencies and one of optional deps.
         """
-        return []
+        return [], []
 
     @classmethod
     def register(cls):

viam/resource/registry.py

@@ -27,7 +27,7 @@ class ResourceCreatorRegistration:
     """A function that can create a resource given a mapping of dependencies (``ResourceName`` to ``ResourceBase``
     """
 
-    validator: "Validator" = lambda x: []
+    validator: "Validator" = lambda x: ([], [])
     """A function that can validate a resource and return implicit dependencies.
 
     If called without a validator function, default to a function returning an empty Sequence
@@ -170,7 +170,7 @@ class Registry:
         try:
             return cls._RESOURCES[f"{api}/{model}"].validator
         except AttributeError:
-            return lambda x: []
+            return lambda x: ([], [])
         except KeyError:
             raise ResourceNotFoundError(api.resource_type, api.resource_subtype)
 

viam/resource/types.py

@@ -1,6 +1,6 @@
 import re
 import sys
-from typing import TYPE_CHECKING, Callable, ClassVar, Mapping, Optional, Protocol, Sequence, runtime_checkable
+from typing import TYPE_CHECKING, Callable, ClassVar, Mapping, Optional, Protocol, Sequence, Tuple, runtime_checkable
 
 if sys.version_info >= (3, 10):
     from typing import TypeAlias
@@ -203,7 +203,7 @@ def resource_name_from_string(string: str) -> ResourceName:
 
 
 ResourceCreator: TypeAlias = Callable[[ComponentConfig, Mapping[ResourceName, "ResourceBase"]], "ResourceBase"]
-Validator: TypeAlias = Callable[[ComponentConfig], Sequence[str]]
+Validator: TypeAlias = Callable[[ComponentConfig], Tuple[Sequence[str], Sequence[str]]]
 
 
 @runtime_checkable

viam/version_metadata.py

@@ -1,4 +1,4 @@
-__version__ = "0.45.2"
+__version__ = "0.47.0"
 
-API_VERSION = "v0.1.432"
+API_VERSION = "v0.1.437"
 SDK_VERSION = __version__

{viam_sdk-0.45.2.dist-info → viam_sdk-0.47.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: viam-sdk
-Version: 0.45.2
+Version: 0.47.0
 Summary: Viam Robotics Python SDK
 Project-URL: Homepage, https://www.viam.com
 Project-URL: Documentation, https://python.viam.dev

{viam_sdk-0.45.2.dist-info → viam_sdk-0.47.0.dist-info}/RECORD

@@ -6,12 +6,12 @@ viam/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 viam/sessions_client.py,sha256=E4ThFCK1HCX_iAvEymvCdJ-H0ZlouzgoIwIE_nywfqc,9414
 viam/streams.py,sha256=VoM8FSMuGZmv4RPDHQy4FfHvJq36r4NY--gkQoaFkzs,1042
 viam/utils.py,sha256=xz7qb6bM-2qzOSQSsYHBheBidMbUAlQ2dHCi_GyPFnk,13579
-viam/version_metadata.py,sha256=aRoXDWKw43HwJpHldU4RUh3MQvSMLhqzXEJXL5S7A7Y,75
+viam/version_metadata.py,sha256=eukUREKq_2FPu6RinvsfKUpNmEuHXG_eSHPj7ptyrhM,75
 viam/app/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 viam/app/_logs.py,sha256=hWxRELRJCux-fQIQtDwztD3odjkBm7Vo8HUQ7XGICek,806
-viam/app/app_client.py,sha256=bD_qU_kU0jAPR7qt5iBe6KzcbPrHU_CWHVFzzMhFXQY,106279
+viam/app/app_client.py,sha256=kTQOyrN1LTRDEcozTcwAK-IDzmZ_YL0cCfbmVWKLiJ0,114986
 viam/app/billing_client.py,sha256=eZ0KOpKOVEcqPxzAhUfn3XXJdhwAPVv_jPbIg1sc0uk,5767
-viam/app/data_client.py,sha256=mmqXw5xtGLNHm0zSZmEPNUf7eDSVM9VfUJMQUzLLA7U,75418
+viam/app/data_client.py,sha256=f2kcr9bLWWbobwfjV4VzbNowPn9Io--n3Xfh5TM98sE,87278
 viam/app/ml_training_client.py,sha256=qcnVrYETdIRusfHLpIOG8Q-QmqDIU43dKmv0pTJ5mA8,9269
 viam/app/provisioning_client.py,sha256=Irh3waRpggZe-pPyrgk4D9fAQ48JjDE5spYyIFOJc3Y,3536
 viam/app/viam_client.py,sha256=fJYa79_WwHFRKcDBzJWzV7Hgo0U1CBwoaDuW8vhkWLU,10820
@@ -129,8 +129,8 @@ viam/gen/app/mlinference/v1/ml_inference_pb2.pyi,sha256=F7Rd9y3rZoM3KZ114xxF8Klb
 viam/gen/app/mltraining/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 viam/gen/app/mltraining/v1/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 viam/gen/app/mltraining/v1/ml_training_grpc.py,sha256=pNG71h3FqXQBHsfEgRA8GOm_MxKjN-4lAjkDJINjrJU,8047
-viam/gen/app/mltraining/v1/ml_training_pb2.py,sha256=8_rk9-JamJUfEAhS64AG1_vp8yUxu6PoC0jwk1LdIno,19627
-viam/gen/app/mltraining/v1/ml_training_pb2.pyi,sha256=1boVJgPntKoEof4FqfWoqL8DrtigYfUQFl1BM-oOZgQ,17754
+viam/gen/app/mltraining/v1/ml_training_pb2.py,sha256=blCC52-wPG9SaJBfkBSTf5hr7NIKdw6PT5yJKYjJF2M,20456
+viam/gen/app/mltraining/v1/ml_training_pb2.pyi,sha256=hCmnEVRJvQIATIguh--GC4-xjv2gGVE_bUoarM3QHxc,18517
 viam/gen/app/packages/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 viam/gen/app/packages/v1/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 viam/gen/app/packages/v1/packages_grpc.py,sha256=r_wO6tv0MEzVhRIA2R6ryJWCRkxzW6IUatpr8tkMJgI,4260
@@ -138,8 +138,8 @@ viam/gen/app/packages/v1/packages_pb2.py,sha256=U8kM0VeKTU-H-amKifi2Tl3QcgAegik4
 viam/gen/app/packages/v1/packages_pb2.pyi,sha256=PAjZSC90Qips9F-Q674SUFRreXXeAKqzK9fi2GVRs7g,12510
 viam/gen/app/v1/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 viam/gen/app/v1/app_grpc.py,sha256=qlrZrjwz3Mg-j-EHA02pC8j5uWswfoA0066UwY1LX0s,91027
-viam/gen/app/v1/app_pb2.py,sha256=BmSiEB0OmlblLHIYnZ2Wtvnd8an1Rn_mS9i752qqt3U,107766
-viam/gen/app/v1/app_pb2.pyi,sha256=kz-PTXjei6KnyMljecX367ARjl3FT12T56-mvlvJkdo,221445
+viam/gen/app/v1/app_pb2.py,sha256=HMNMMXKsy5aQ1E7fBQ3iWQoU7nr_EAO3d0TkL31bpFA,108033
+viam/gen/app/v1/app_pb2.pyi,sha256=kNajS0Gva8a4QAHWfZjbH2U0aAUY5TGt_KqMnA725z0,222507
 viam/gen/app/v1/billing_grpc.py,sha256=pbyQssF9YmzQnk_dPGwjIef0_SUs63GURCCSwd6T7wI,7241
 viam/gen/app/v1/billing_pb2.py,sha256=HRLlgGrDAPSzVlj-Va92KcMHipFqPNpnTPziqAHOyXg,14364
 viam/gen/app/v1/billing_pb2.pyi,sha256=KzMVKP1_f8BSFlem-jPZfWidtM5dHz_LRUPS0aZaKF0,21387
@@ -253,8 +253,8 @@ viam/gen/component/testecho/v1/testecho_pb2.pyi,sha256=TQIFfPEDgV4yNSoQ4kE2vcUYO
 viam/gen/module/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 viam/gen/module/v1/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 viam/gen/module/v1/module_grpc.py,sha256=X4EetljMX9UQqF0wNB-wGqT9MyQFC1uIIvmAYSrmuXA,4773
-viam/gen/module/v1/module_pb2.py,sha256=WU47C0_HavD7JuxtDSHCiMOOi5WfGhgYxxKPW88WhX8,4580
-viam/gen/module/v1/module_pb2.pyi,sha256=iSKimKkTzUKqdkJhXJ0LJa7wfLSTZn8bR_Q1deXGhIY,7271
+viam/gen/module/v1/module_pb2.py,sha256=TA-iXzHjzAwjz1NqQ2Vh-pxVsATXasMkLx1QenbU9ug,4655
+viam/gen/module/v1/module_pb2.pyi,sha256=Mt6j2yNdhrm2Go_JbbhIlUBaMy31Zt-eLwQvGcwjvsM,7595
 viam/gen/proto/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 viam/gen/proto/rpc/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 viam/gen/proto/rpc/examples/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -289,7 +289,7 @@ viam/gen/robot/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 viam/gen/robot/v1/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 viam/gen/robot/v1/robot_grpc.py,sha256=upE5425Mw2vNLtkVOuHabsJFbBH_SZGeDV24Dq-tl_g,19932
 viam/gen/robot/v1/robot_pb2.py,sha256=C5yCSwx_I715RQZvaY0QFph7r3OxgPSxmqYAalsluC4,25919
-viam/gen/robot/v1/robot_pb2.pyi,sha256=X_KWnxFBAHsId4OAROE_qV1ClZ0eWndYUc2bGNIjwvU,40196
+viam/gen/robot/v1/robot_pb2.pyi,sha256=0X9N8-Nu9qaHCcfXesUklzpBYV5EJa19z7d6PzsHnxQ,40200
 viam/gen/service/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 viam/gen/service/datamanager/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 viam/gen/service/datamanager/v1/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -335,7 +335,7 @@ viam/gen/service/slam/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3h
 viam/gen/service/slam/v1/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 viam/gen/service/slam/v1/slam_grpc.py,sha256=mklOC5tao9FAl6vO9ytc_DKaBBX3N7aCh_9ld444e9M,4983
 viam/gen/service/slam/v1/slam_pb2.py,sha256=q0cWCGHeOUEDNpBYM1aoXDTrOHFUotcupRkjE9rFyA0,6540
-viam/gen/service/slam/v1/slam_pb2.pyi,sha256=vJk6kDVnWgOkmi_f5lFz2-BdXqNIxnjc4c7vKmVnFJE,9604
+viam/gen/service/slam/v1/slam_pb2.pyi,sha256=0Rc6UFOv0lSgRIG7Vlv9m9QVT_zJT_WCeKzkEN_9MGo,9613
 viam/gen/service/vision/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 viam/gen/service/vision/v1/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 viam/gen/service/vision/v1/vision_grpc.py,sha256=-VsVHersXOyHq-OB0BC4AeM9Ij2JHczxFoRU85w8FcQ,8608
@@ -359,7 +359,7 @@ viam/media/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,
 viam/media/utils/pil/__init__.py,sha256=b8jSuxOzm1o9CMaJ186V5dMufw4_jXZG5g2U_EJ3bKQ,1466
 viam/media/utils/pil/viam_rgba_plugin.py,sha256=3vIevKK4pnB9EJV_n7bho3XEAzFyuMb3uRTedsvizxI,2563
 viam/module/__init__.py,sha256=BV5kJ-qjlGJzlHdTyR2fZGblymflEcuJU2bFVqPjyeU,56
-viam/module/module.py,sha256=p2uR5uSdRn8Wl5WoSouwYzxsO4zZ0D4IjG5sbRi4CLc,11907
+viam/module/module.py,sha256=u1o-wRO-HSmEfCDFGpVCTXu13jqED4XhQsEwKm_uPfs,13436
 viam/module/service.py,sha256=QdMVFXWI1aylZOdnSeDUu-LuZ8qIWEs9QihMDyCqnjg,2383
 viam/module/types.py,sha256=SLcSFN99lon-9q0eqXt5vTELS1HaAyROh27XIzX2LlU,793
 viam/proto/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -423,18 +423,18 @@ viam/proto/stream/__init__.py,sha256=ZTjtPqIsjEiH5AkXj2yqgJesAkTx2Z4iJzKRZKZg7Bs
 viam/proto/tagger/__init__.py,sha256=8qjke19IIdi8HlxjlE9ntAS7GTPzR2SVla8lhslZNTs,64
 viam/resource/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 viam/resource/base.py,sha256=3HGO5KQ6kgEeFlsyJWYr2Nlem7BYERPrYXyNyvydP2w,3694
-viam/resource/easy_resource.py,sha256=8xQ_ZHfGflgszX9yf9rsiK1dEUo4F0VL14g7I20B1_U,5529
+viam/resource/easy_resource.py,sha256=S8gVJi1FB0XiTrNpmGJC8O8CQLMM9ycBBrOyqz1rLWw,5621
 viam/resource/manager.py,sha256=aCJs-a0fHqvV-suiYkIn3CKUnvj-qgsI2FHK5CKj3M0,4913
-viam/resource/registry.py,sha256=Xsu8fTbnNdL0lPX0dTfwtnrK_cRWG-5SUIIwhF4k7so,7355
+viam/resource/registry.py,sha256=XAiJsf3y0C5VnJl-Iy77CqMzFdq1RBLOXqSiFXZ7QmE,7367
 viam/resource/rpc_client_base.py,sha256=2OqcRHZLShuJqcmKimzU4Wr3VuHGNc8fzV4HbtIOAXU,2054
 viam/resource/rpc_service_base.py,sha256=f2vGY4mfcdOPCgBVk7EVFKDIwGAPxu66e0XJ55VIen8,1612
-viam/resource/types.py,sha256=E1eqzJR8HzkDWW6-lM2fAT86wOUe6akD_FBAJ21Mg7M,6710
+viam/resource/types.py,sha256=8r2RjTQN9hOg6Po9XHMgj7xfR5kTsFr9_KNNn_62qGk,6739
 viam/robot/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 viam/robot/client.py,sha256=eLxP_lpiQq7t8bRZCIzWFWMr83nCfqrA3Lf8H7CtzIo,33590
 viam/robot/service.py,sha256=4kn2px4YRkM7083CNgs01FO7xPRe7nhtuDst3IMXjo8,2764
 viam/rpc/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 viam/rpc/dial.py,sha256=vUqwjHwrV13RM8WrxhA0MU4upan8_aQhS2PtJnA9A6A,15025
-viam/rpc/libviam_rust_utils.so,sha256=wkedBlQUVuaJBezX1sxzYJNYn4GurviPVWPZ0l3V10g,21289708
+viam/rpc/libviam_rust_utils.so,sha256=J67vbfn8b-DRFSVUuhF3jak0jDhUIBybZx2KeQ0_GNk,21276256
 viam/rpc/server.py,sha256=AqV-cFkis4LahpSKWxqtk-Io5c9JwS-Xhut3ucqNfzg,7165
 viam/rpc/signaling.py,sha256=Bo5F9ReRGYXH4CJI-YYUSA33aOvU5gnFcdwaPqQFQ9E,1134
 viam/rpc/types.py,sha256=b7cOkq8C8lOccKNeZBmMqUICz2sTKo2qli4FthdJLK0,654
@@ -470,7 +470,7 @@ viam/services/vision/__init__.py,sha256=g4Dnz6BFgVZpvE6j6sNwxAc2baZfAKLA6XS2GaGg
 viam/services/vision/client.py,sha256=uaFMlYwKE5N_Qp803aFGfk8k6KCWPKNwUxyV_fnlBp4,7776
 viam/services/vision/service.py,sha256=NWV3yY1ZyEbl4rrp28CtX9n-uIgyxSQbbKJTeoIVjCg,6942
 viam/services/vision/vision.py,sha256=MrQsTarahwGMEmqWX4ODCJT5wLOGHXNEuEyTQgOvsg4,12527
-viam_sdk-0.45.2.dist-info/METADATA,sha256=kPAd6Uor-igdzISBPm4521z06fIjbyuz1Gjmvz7XvA0,10310
-viam_sdk-0.45.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-viam_sdk-0.45.2.dist-info/licenses/LICENSE,sha256=yVuuHRzgI17MzTVgt3LsHvuX80innw--CmNPDCzO_iw,11358
-viam_sdk-0.45.2.dist-info/RECORD,,
+viam_sdk-0.47.0.dist-info/METADATA,sha256=t1rIDXHknEldULZV8OjlcVSeG1IRqk5vEDrgpcqmzIs,10310
+viam_sdk-0.47.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+viam_sdk-0.47.0.dist-info/licenses/LICENSE,sha256=yVuuHRzgI17MzTVgt3LsHvuX80innw--CmNPDCzO_iw,11358
+viam_sdk-0.47.0.dist-info/RECORD,,