[libcamera-devel,v3,08/30] py: MappedFrameBuffer: Add type hints & docs
diff mbox series

Message ID 20220527144447.94891-9-tomi.valkeinen@ideasonboard.com
State Accepted
Headers show
Series
  • More misc Python patches
Related show

Commit Message

Tomi Valkeinen May 27, 2022, 2:44 p.m. UTC 
Add a few type hints and (minimal) docs to MappedFrameBuffer.

Signed-off-by: Tomi Valkeinen <tomi.valkeinen@ideasonboard.com>
Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
---
 src/py/libcamera/utils/MappedFrameBuffer.py | 11 +++++++++--
 1 file changed, 9 insertions(+), 2 deletions(-)

Patch
diff mbox series 

diff --git a/src/py/libcamera/utils/MappedFrameBuffer.py b/src/py/libcamera/utils/MappedFrameBuffer.py
index e7dd16ec..fc2726b6 100644
--- a/src/py/libcamera/utils/MappedFrameBuffer.py
+++ b/src/py/libcamera/utils/MappedFrameBuffer.py
@@ -1,8 +1,14 @@ 
 # SPDX-License-Identifier: LGPL-2.1-or-later
 # Copyright (C) 2022, Tomi Valkeinen <tomi.valkeinen@ideasonboard.com>
 
+import libcamera
+from typing import Tuple
+
 class MappedFrameBuffer:
-    def __init__(self, fb):
+    """
+    Provides memoryviews for the FrameBuffer's planes
+    """
+    def __init__(self, fb: libcamera.FrameBuffer):
         self.__fb = fb
 
     def __enter__(self):
@@ -70,5 +76,6 @@  class MappedFrameBuffer:
             mm.close()
 
     @property
-    def planes(self):
+    def planes(self) -> Tuple[memoryview, ...]:
+        """memoryviews for the planes"""
         return self.__planes