diff mbox series

[libgpiod,v2,11/23] bindings: python: fix LineRequest union-attr type errors

Message ID 20241114145116.2123714-12-vfazio@xes-inc.com
State New
Headers show
Series bindings: python: conform to mypy and ruff linter recommendations | expand

Commit Message

Vincent Fazio Nov. 14, 2024, 2:51 p.m. UTC
Since `LineRequest._req` is typed to be `Optional` and because type
checkers may not be able to infer that an object is not `None` from an
earlier call (such as `_check_released`) it is necessary to inform type
checkers of the state of the object to silence union-attr [0] errors.

Instead of littering the code with "# type: ignore" comments, use casts
to inform type checkers that objects are not `None`.

Using `assert` is another option, however this duplicates the logic in
`_check_released` so is redundant at best and, at worst, is not a safe
replacement as `assert` can be elided in optimized Python environments
and these checks need to be runtime enforced.

[0]: https://mypy.readthedocs.io/en/stable/error_code_list.html#check-that-attribute-exists-in-each-union-item-union-attr
Signed-off-by: Vincent Fazio <vfazio@xes-inc.com>
---
 bindings/python/gpiod/line_request.py | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)
diff mbox series

Patch

diff --git a/bindings/python/gpiod/line_request.py b/bindings/python/gpiod/line_request.py
index f8bbf64..81f2517 100644
--- a/bindings/python/gpiod/line_request.py
+++ b/bindings/python/gpiod/line_request.py
@@ -3,7 +3,7 @@ 
 
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, Optional, Union
+from typing import TYPE_CHECKING, Optional, Union, cast
 
 from . import _ext
 from ._internal import poll_fd
@@ -78,7 +78,7 @@  class LineRequest:
         not be used after a call to this method.
         """
         self._check_released()
-        self._req.release()
+        cast(_ext.Request, self._req).release()
         self._req = None
 
     def get_value(self, line: Union[int, str]) -> Value:
@@ -128,7 +128,7 @@  class LineRequest:
 
         buf = [None] * len(lines)
 
-        self._req.get_values(offsets, buf)
+        cast(_ext.Request, self._req).get_values(offsets, buf)
         return buf
 
     def set_value(self, line: Union[int, str], value: Value) -> None:
@@ -158,7 +158,7 @@  class LineRequest:
             for line in values
         }
 
-        self._req.set_values(mapped)
+        cast(_ext.Request, self._req).set_values(mapped)
 
     def reconfigure_lines(
         self,
@@ -193,7 +193,7 @@  class LineRequest:
             settings = line_settings.get(offset) or LineSettings()
             line_cfg.add_line_settings([offset], _line_settings_to_ext(settings))
 
-        self._req.reconfigure_lines(line_cfg)
+        cast(_ext.Request, self._req).reconfigure_lines(line_cfg)
 
     def wait_edge_events(
         self, timeout: Optional[Union[timedelta, float]] = None
@@ -227,7 +227,7 @@  class LineRequest:
         """
         self._check_released()
 
-        return self._req.read_edge_events(max_events)
+        return cast(_ext.Request, self._req).read_edge_events(max_events)
 
     def __str__(self) -> str:
         """
@@ -279,4 +279,4 @@  class LineRequest:
         File descriptor associated with this request.
         """
         self._check_released()
-        return self._req.fd
+        return cast(_ext.Request, self._req).fd