Skip to content

RSDK-13355: remove reconfigure #1167

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
aldenh-viam wants to merge 1 commit into
base: main
Choose a base branch
from
Open

RSDK-13355: remove reconfigure #1167

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions examples/complex_module/src/base/my_base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@

from viam.components.base import Base
from viam.components.motor import Motor
from viam.module.types import Reconfigurable
from viam.proto.app.robot import ComponentConfig
from viam.resource.base import ResourceBase
from viam.proto.common import Geometry, Vector3, ResourceName
Expand All @@ -13,7 +12,7 @@
from viam.utils import struct_to_dict


class MyBase(Base, Reconfigurable):
class MyBase(Base):
"""
MyBase implements a base that only supports set_power (basic forward/back/turn controls), is_moving (check if in motion), and stop (stop
all motion).
Expand Down
3 changes: 1 addition & 2 deletions examples/complex_module/src/gizmo/my_gizmo.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
from typing_extensions import Self

from viam.logging import getLogger
from viam.module.types import Reconfigurable
from viam.proto.app.robot import ComponentConfig
from viam.proto.common import ResourceName
from viam.resource.base import ResourceBase
Expand All @@ -15,7 +14,7 @@
LOGGER = getLogger(__name__)


class MyGizmo(Gizmo, Reconfigurable):
class MyGizmo(Gizmo):
"""This is the specific implementation of a ``Gizmo`` (defined in api.py).

It inherits from Gizmo, as well conforms to the ``Reconfigurable`` protocol, which signifies that this component can be reconfigured.
Expand Down
3 changes: 1 addition & 2 deletions examples/complex_module/src/summation/my_summation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

from typing_extensions import Self

from viam.module.types import Reconfigurable
from viam.proto.app.robot import ComponentConfig
from viam.proto.common import ResourceName
from viam.resource.base import ResourceBase
Expand All @@ -12,7 +11,7 @@
from ..summation.api import SummationService


class MySummationService(SummationService, Reconfigurable):
class MySummationService(SummationService):
"""This is the specific implementation of a ``SummationService`` (defined in api.py)

It inherits from SummationService, as well as conforms to the ``Reconfigurable`` protocol, which signifies that this component can be
Expand Down
3 changes: 1 addition & 2 deletions examples/optionaldepsmodule/module.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@

from viam.components.generic import Generic
from viam.components.motor import Motor
from viam.module.types import Reconfigurable
from viam.proto.app.robot import ComponentConfig
from viam.resource.base import ResourceBase
from viam.proto.common import ResourceName
Expand All @@ -15,7 +14,7 @@
import asyncio


class Foo(Generic, Reconfigurable):
class Foo(Generic):
MODEL: ClassVar[Model] = Model(ModelFamily("acme", "demo"), "foo")

def __init__(self, name: str):
Expand Down
22 changes: 9 additions & 13 deletions src/viam/module/module.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
from viam.rpc.server import Server

from .service import ModuleRPCService
from .types import Reconfigurable, Stoppable
from .types import Stoppable


def _parse_module_args() -> argparse.Namespace:
Expand Down Expand Up @@ -198,23 +198,19 @@ async def add_resource(self, request: AddResourceRequest, *, deadline: Optional[
self.server.register(resource)

async def reconfigure_resource(self, request: ReconfigureResourceRequest):
dependencies = await self._get_dependencies(request.dependencies)
config: ComponentConfig = request.config
api = API.from_string(config.api)
name = config.name
rn = ResourceName(namespace=api.namespace, type=api.resource_type, subtype=api.resource_subtype, name=name)
resource = self.server.get_resource(ResourceBase, rn)
if isinstance(resource, Reconfigurable):
resource.reconfigure(config, dependencies)
else:
if isinstance(resource, Stoppable):
if iscoroutinefunction(resource.stop):
await resource.stop()
else:
resource.stop()
add_request = AddResourceRequest(config=request.config, dependencies=request.dependencies)
await self.server.remove_resource(rn)
await self.add_resource(add_request)
if isinstance(resource, Stoppable):
if iscoroutinefunction(resource.stop):
await resource.stop()
else:
resource.stop()
add_request = AddResourceRequest(config=request.config, dependencies=request.dependencies)
await self.server.remove_resource(rn)
await self.add_resource(add_request)

async def remove_resource(self, request: RemoveResourceRequest):
rn = resource_name_from_string(request.name)
Expand Down
6 changes: 0 additions & 6 deletions src/viam/module/types.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,10 @@
from typing import Any, Mapping, Optional, Protocol, runtime_checkable

from viam.proto.app.robot import ComponentConfig
from viam.proto.common import ResourceName
from viam.resource.base import ResourceBase


@runtime_checkable
class Reconfigurable(Protocol):
Copy link
Contributor Author

@aldenh-viam aldenh-viam Mar 18, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we remove this class completely? Or not, because it would crash at runtime for users who bump the SDK version but forget to remove it from their code?

Copy link
Member

@njooma njooma Mar 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's keep it for now, but can you add a deprecated warning to it please?

"""The Reconfigurable protocol defines the requirements for making a resource Reconfigurable"""

def reconfigure(self, config: ComponentConfig, dependencies: Mapping[ResourceName, ResourceBase]): ...


@runtime_checkable
class Stoppable(Protocol):
Expand Down
3 changes: 1 addition & 2 deletions tests/mocks/module/gizmo/my_gizmo.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
from typing_extensions import Self

from viam.components.component_base import ComponentBase
from viam.module.types import Reconfigurable
from viam.proto.app.robot import ComponentConfig
from viam.proto.common import ResourceName
from viam.resource.base import ResourceBase
Expand All @@ -12,7 +11,7 @@
from ..gizmo.api import Gizmo


class MyGizmo(Gizmo, Reconfigurable):
class MyGizmo(Gizmo):
MODEL: ClassVar[Model] = Model(ModelFamily("acme", "demo"), "mygizmo")
my_arg: str
closed: bool = False
Expand Down
3 changes: 1 addition & 2 deletions tests/mocks/module/summation/my_summation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

from typing_extensions import Self

from viam.module.types import Reconfigurable
from viam.proto.app.robot import ComponentConfig
from viam.proto.common import ResourceName
from viam.resource.base import ResourceBase
Expand All @@ -11,7 +10,7 @@
from ..summation.api import SummationService


class MySummationService(SummationService, Reconfigurable):
class MySummationService(SummationService):
MODEL: ClassVar[Model] = Model.from_string("acme:demo:mysum")
subtract: bool

Expand Down
34 changes: 0 additions & 34 deletions tests/test_module.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@
from .mocks.module.gizmo.api import Gizmo
from .mocks.module.gizmo.my_gizmo import MyGizmo
from .mocks.module.summation.api import SummationService
from .mocks.module.summation.my_summation import MySummationService
from .test_robot import service as robot_service # noqa: F401


Expand Down Expand Up @@ -74,39 +73,6 @@ async def test_add_resource(self, module: Module):
await module.add_resource(req)
assert SummationService.get_resource_name("mysum1") in module.server.resources

async def test_reconfigure_resource(self, module: Module):
await self.test_add_resource(module)

gizmo = module.server.get_resource(MyGizmo, Gizmo.get_resource_name("gizmo1"))
assert gizmo.my_arg == "arg1"
req = ReconfigureResourceRequest(
config=ComponentConfig(
name="gizmo1",
namespace="acme",
type="gizmo",
model="acme:demo:mygizmo",
attributes=dict_to_struct({"arg1": "arg2", "motor": "motor1"}),
api="acme:component:gizmo",
)
)
await module.reconfigure_resource(req)
assert gizmo.my_arg == "arg2"

summer = module.server.get_resource(MySummationService, SummationService.get_resource_name("mysum1"))
assert summer.subtract is False
req = ReconfigureResourceRequest(
config=ComponentConfig(
name="mysum1",
namespace="acme",
type="summation",
model="acme:demo:mysum",
attributes=dict_to_struct({"subtract": True}),
api="acme:service:summation",
)
)
await module.reconfigure_resource(req)
assert summer.subtract is True

async def test_add_resource_with_deps(self, robot_service: RobotService, module: Module): # noqa: F811
async with ChannelFor([robot_service]) as channel:
_ = mock.patch("viam.module.module.Module._connect_to_parent")
Expand Down
Loading