From 27e8730f65e3c1d97e18eefea30cd83da2d2d130 Mon Sep 17 00:00:00 2001
From: martha-johnston <106617924+martha-johnston@users.noreply.github.com>
Date: Tue, 31 Dec 2024 09:45:56 -0500
Subject: [PATCH] RSDK-9560: remove `AnalogNames` and `DigitalInterruptNames`
from python sdk (#808)
---
examples/server/v1/components.py | 6 -----
src/viam/components/board/board.py | 38 -----------------------------
src/viam/components/board/client.py | 10 --------
tests/mocks/components.py | 6 -----
tests/test_board.py | 28 ---------------------
5 files changed, 88 deletions(-)
diff --git a/examples/server/v1/components.py b/examples/server/v1/components.py
index 5a71c5586..281d83947 100644
--- a/examples/server/v1/components.py
+++ b/examples/server/v1/components.py
@@ -306,12 +306,6 @@ async def gpio_pin_by_name(self, name: str) -> Board.GPIOPin:
except KeyError:
raise ResourceNotFoundError("Board.GPIOPin", name)
- async def analog_names(self) -> List[str]:
- return [key for key in self.analogs.keys()]
-
- async def digital_interrupt_names(self) -> List[str]:
- return [key for key in self.digital_interrupts.keys()]
-
async def set_power_mode(self, **kwargs):
raise NotImplementedError()
diff --git a/src/viam/components/board/board.py b/src/viam/components/board/board.py
index f6979e644..a237456e2 100644
--- a/src/viam/components/board/board.py
+++ b/src/viam/components/board/board.py
@@ -364,44 +364,6 @@ async def gpio_pin_by_name(self, name: str) -> GPIOPin:
"""
...
- @abc.abstractmethod
- async def analog_names(self) -> List[str]:
- """
- Get the names of all known analog readers and/or writers.
-
- ::
-
- my_board = Board.from_robot(robot=machine, name="my_board")
-
- # Get the name of every Analog configured on the board.
- names = await my_board.analog_names()
-
- Returns:
- List[str]: The list of names of all known analog readers/writers.
-
- For more information, see `Board component `_.
- """
- ...
-
- @abc.abstractmethod
- async def digital_interrupt_names(self) -> List[str]:
- """
- Get the names of all known digital interrupts.
-
- ::
-
- my_board = Board.from_robot(robot=machine, name="my_board")
-
- # Get the name of every DigitalInterrupt configured on the board.
- names = await my_board.digital_interrupt_names()
-
- Returns:
- List[str]: The names of the digital interrupts.
-
- For more information, see `Board component `_.
- """
- ...
-
@abc.abstractmethod
async def set_power_mode(
self, mode: PowerMode.ValueType, duration: Optional[timedelta] = None, *, timeout: Optional[float] = None, **kwargs
diff --git a/src/viam/components/board/client.py b/src/viam/components/board/client.py
index f9742ac4f..5377225da 100644
--- a/src/viam/components/board/client.py
+++ b/src/viam/components/board/client.py
@@ -184,16 +184,6 @@ async def digital_interrupt_by_name(self, name: str) -> Board.DigitalInterrupt:
async def gpio_pin_by_name(self, name: str) -> Board.GPIOPin:
return GPIOPinClient(name, self)
- async def analog_names(self) -> List[str]:
- if self._analog_names is None:
- return []
- return self._analog_names
-
- async def digital_interrupt_names(self) -> List[str]:
- if self._digital_interrupt_names is None:
- return []
- return self._digital_interrupt_names
-
async def do_command(
self,
command: Mapping[str, ValueTypes],
diff --git a/tests/mocks/components.py b/tests/mocks/components.py
index 1c7f5c11c..dfc7bf426 100644
--- a/tests/mocks/components.py
+++ b/tests/mocks/components.py
@@ -327,12 +327,6 @@ async def gpio_pin_by_name(self, name: str) -> Board.GPIOPin:
except KeyError:
raise ResourceNotFoundError("Board.GPIOPin", name)
- async def analog_names(self) -> List[str]:
- return [key for key in self.analogs.keys()]
-
- async def digital_interrupt_names(self) -> List[str]:
- return [key for key in self.digital_interrupts.keys()]
-
async def get_geometries(self, *, extra: Optional[Dict[str, Any]] = None, timeout: Optional[float] = None) -> List[Geometry]:
self.extra = extra
self.timeout = timeout
diff --git a/tests/test_board.py b/tests/test_board.py
index e32678a58..175eb8a12 100644
--- a/tests/test_board.py
+++ b/tests/test_board.py
@@ -113,14 +113,6 @@ async def test_gpio_pin_by_name(self, board: MockBoard):
pin = await board.gpio_pin_by_name("pin1")
assert pin.name == "pin1"
- async def test_analog_names(self, board: MockBoard):
- names = await board.analog_names()
- assert names == ["analog1"]
-
- async def test_digital_interrupt_names(self, board: MockBoard):
- names = await board.digital_interrupt_names()
- assert names == ["interrupt1"]
-
async def test_do(self, board: MockBoard):
command = {"command": "args"}
resp = await board.do_command(command)
@@ -357,26 +349,6 @@ async def test_gpio_pin_by_name(self, board: MockBoard, service: BoardRPCService
pin = await client.gpio_pin_by_name("pin1")
assert pin.name == "pin1"
- async def test_analog_names(self, board: MockBoard, service: BoardRPCService):
- async with ChannelFor([service]) as channel:
- client = BoardClient(name=board.name, channel=channel)
-
- reader = await client.analog_by_name("analog1")
- assert reader.name == "analog1"
-
- names = await client.analog_names()
- assert names == ["analog1"]
-
- async def test_digital_interrupt_names(self, board: MockBoard, service: BoardRPCService):
- async with ChannelFor([service]) as channel:
- client = BoardClient(name=board.name, channel=channel)
-
- interrupt = await client.digital_interrupt_by_name("interrupt1")
- assert interrupt.name == "interrupt1"
-
- names = await client.digital_interrupt_names()
- assert names == ["interrupt1"]
-
async def test_do(self, board: MockBoard, service: BoardRPCService):
async with ChannelFor([service]) as channel:
client = BoardClient(board.name, channel)