RSDK-2870: use api instead of subtype (#824)

Author: purplenicole730

README.md

@@ -122,7 +122,7 @@ The SDK provides a number of abstract base components and services (collectively
    1. Define all requirements of the resource in `{RESOURCE_NAME}.py`
    1. Implement the gRPC service for the new resource in `service.py`
    1. Create a gRPC client for the new resource in `client.py`
-   1. Register the subtype and define package exports in `__init__.py`
+   1. Register the API and define package exports in `__init__.py`
 1. Write tests for the new resource and add the resource to `tests.mocks.{components|services}`
 1. If the resource is a component, add the component to `examples.server.v1.components` and its corresponding concrete type in `examples.server.v1.server`
 

docs/examples/module_step2.py

@@ -35,7 +35,7 @@ async def close(self):
 
 
 async def main():
-    Registry.register_resource_creator(Sensor.SUBTYPE, MySensor.MODEL, ResourceCreatorRegistration(MySensor.new))
+    Registry.register_resource_creator(Sensor.API, MySensor.MODEL, ResourceCreatorRegistration(MySensor.new))
 
 
 if __name__ == "__main__":

docs/examples/module_step2_optional.py

@@ -57,7 +57,7 @@ async def close(self):
 
 
 async def main():
-    Registry.register_resource_creator(Sensor.SUBTYPE, MySensor.MODEL, ResourceCreatorRegistration(MySensor.new, MySensor.validate_config))
+    Registry.register_resource_creator(Sensor.API, MySensor.MODEL, ResourceCreatorRegistration(MySensor.new, MySensor.validate_config))
 
 
 if __name__ == "__main__":

docs/examples/module_step3.py

@@ -40,10 +40,10 @@ async def main():
     This function creates and starts a new module, after adding all desired resource model.
     Resource creators must be registered to the resource registry before the module adds the resource model.
     """
-    Registry.register_resource_creator(Sensor.SUBTYPE, MySensor.MODEL, ResourceCreatorRegistration(MySensor.new))
+    Registry.register_resource_creator(Sensor.API, MySensor.MODEL, ResourceCreatorRegistration(MySensor.new))
 
     module = Module.from_args()
-    module.add_model_from_registry(Sensor.SUBTYPE, MySensor.MODEL)
+    module.add_model_from_registry(Sensor.API, MySensor.MODEL)
     await module.start()
 
 

examples/complex_module/src/arm/my_arm.py

@@ -115,4 +115,4 @@ async def close(self):
         LOGGER.info(f"{self.name} is closed.")
 
 
-Registry.register_resource_creator(Arm.SUBTYPE, MyArm.MODEL, ResourceCreatorRegistration(MyArm.new))
+Registry.register_resource_creator(Arm.API, MyArm.MODEL, ResourceCreatorRegistration(MyArm.new))

examples/complex_module/src/base/my_base.py

@@ -147,4 +147,4 @@ async def get_geometries(self) -> List[Geometry]:
         raise NotImplementedError()
 
 
-Registry.register_resource_creator(Base.SUBTYPE, MyBase.MODEL, ResourceCreatorRegistration(MyBase.new, MyBase.validate_config))
+Registry.register_resource_creator(Base.API, MyBase.MODEL, ResourceCreatorRegistration(MyBase.new, MyBase.validate_config))

examples/complex_module/src/gizmo/__init__.py

@@ -1,10 +1,10 @@
 """
-This file registers the Gizmo subtype with the Viam Registry, as well as the specific MyGizmo model.
+This file registers the Gizmo API with the Viam Registry, as well as the specific MyGizmo model.
 """
 
 from viam.components.motor import *  # noqa: F403 Need to import motor so the component registers itself
 from viam.resource.registry import Registry, ResourceRegistration
 
 from .api import Gizmo, GizmoClient, GizmoService
 
-Registry.register_subtype(ResourceRegistration(Gizmo, GizmoService, lambda name, channel: GizmoClient(name, channel)))
+Registry.register_api(ResourceRegistration(Gizmo, GizmoService, lambda name, channel: GizmoClient(name, channel)))

examples/complex_module/src/gizmo/api.py

@@ -6,7 +6,7 @@
 and the gRPC client that will be able to make calls to this component.
 
 In this example, the ``Gizmo`` abstract class defines what functionality is required for all Gizmos. It extends ``ComponentBase``,
-as all component types must. It also defines its specific ``SUBTYPE``, which is used internally to keep track of supported types.
+as all component types must. It also defines its specific ``API``, which is used internally to keep track of supported types.
 
 The ``GizmoService`` implements the gRPC service for the Gizmo. This will allow other robots and clients to make requests of the Gizmo.
 It extends both from ``GizmoServiceBase`` and ``ResourceRPCServiceBase``. The former is the gRPC service as defined by the proto,
@@ -28,7 +28,7 @@
 from viam.components.component_base import ComponentBase
 from viam.components.generic.client import do_command
 from viam.resource.rpc_service_base import ResourceRPCServiceBase
-from viam.resource.types import RESOURCE_TYPE_COMPONENT, Subtype
+from viam.resource.types import RESOURCE_TYPE_COMPONENT, API
 from viam.utils import ValueTypes
 
 from ..proto.gizmo_grpc import GizmoServiceBase, GizmoServiceStub
@@ -49,7 +49,7 @@
 class Gizmo(ComponentBase):
     """Example component to use with the example module."""
 
-    SUBTYPE: Final = Subtype("acme", RESOURCE_TYPE_COMPONENT, "gizmo")
+    API: Final = API("acme", RESOURCE_TYPE_COMPONENT, "gizmo")
 
     @abc.abstractmethod
     async def do_one(self, arg1: str, **kwargs) -> bool:

examples/complex_module/src/gizmo/my_gizmo.py

@@ -38,7 +38,7 @@ def validate_config(cls, config: ComponentConfig) -> Sequence[str]:
         # can raise errors that will be returned to the parent through gRPC. Validate functions can
         # also return a sequence of strings representing the implicit dependencies of the resource.
         if "invalid" in config.attributes.fields:
-            raise Exception(f"'invalid' attribute not allowed for model {cls.SUBTYPE}:{cls.MODEL}")
+            raise Exception(f"'invalid' attribute not allowed for model {cls.API}:{cls.MODEL}")
         arg1 = config.attributes.fields["arg1"].string_value
         if arg1 == "":
             raise Exception("A arg1 attribute is required for Gizmo component.")
@@ -79,4 +79,4 @@ async def close(self):
         LOGGER.info(f"{self.name} is closed.")
 
 
-Registry.register_resource_creator(Gizmo.SUBTYPE, MyGizmo.MODEL, ResourceCreatorRegistration(MyGizmo.new, MyGizmo.validate_config))
+Registry.register_resource_creator(Gizmo.API, MyGizmo.MODEL, ResourceCreatorRegistration(MyGizmo.new, MyGizmo.validate_config))

examples/complex_module/src/main.py

@@ -15,10 +15,10 @@ async def main():
     Resource models must be pre-registered. For an example, see the `gizmo.__init__.py` file.
     """
     module = Module.from_args()
-    module.add_model_from_registry(Gizmo.SUBTYPE, MyGizmo.MODEL)
-    module.add_model_from_registry(SummationService.SUBTYPE, MySummationService.MODEL)
-    module.add_model_from_registry(Arm.SUBTYPE, MyArm.MODEL)
-    module.add_model_from_registry(Base.SUBTYPE, MyBase.MODEL)
+    module.add_model_from_registry(Gizmo.API, MyGizmo.MODEL)
+    module.add_model_from_registry(SummationService.API, MySummationService.MODEL)
+    module.add_model_from_registry(Arm.API, MyArm.MODEL)
+    module.add_model_from_registry(Base.API, MyBase.MODEL)
     await module.start()