pytest-embedded 1.3.0__tar.gz → 1.3.1__tar.gz

{pytest-embedded-1.3.0 → pytest-embedded-1.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.2
 Name: pytest-embedded
-Version: 1.3.0
+Version: 1.3.1
 Summary: pytest embedded plugin
 Home-page: https://docs.espressif.com/projects/pytest-embedded/en/latest/
 Author: Fu Hanxi
@@ -10,10 +10,6 @@ Description: ### pytest-embedded
         
         A pytest plugin for embedded systems. Could activate different services for extra functionalities.
         
-        Used CLI Options:
-        
-        - `app_path`
-        
 Platform: UNKNOWN
 Classifier: Framework :: Pytest
 Classifier: Intended Audience :: Developers

{pytest-embedded-1.3.0 → pytest-embedded-1.3.1}/README.md

@@ -1,7 +1,3 @@
 ### pytest-embedded
 
 A pytest plugin for embedded systems. Could activate different services for extra functionalities.
-
-Used CLI Options:
-
-- `app_path`

{pytest-embedded-1.3.0 → pytest-embedded-1.3.1}/pytest_embedded/dut.py

@@ -101,7 +101,7 @@ class Dut(_InjectMixinCls):
     @_pexpect_func  # noqa
     def expect(self, pattern, **kwargs) -> Match:  # noqa
         """
-        Expect the `pattern` from the internal buffer. All the arguments would pass to `pexpect.expect()`.
+        Expect the `pattern` from the internal buffer. All the arguments will be passed to `pexpect.expect()`.
 
         Args:
             pattern: string, or compiled regex, or a list of string and compiled regex.
@@ -112,16 +112,17 @@ class Dut(_InjectMixinCls):
                 Otherwise match any of them could pass
 
         Returns:
-            (AnyStr): if you're matching pexpect.EOF or pexpect.TIMEOUT to get all the current buffers.
+            `AnyStr` or `re.Match`
 
-            (re.Match): if matched given string.
+            - `AnyStr`: if you're matching `pexpect.EOF` or `pexpect.TIMEOUT` to get all the current buffers.
+            - `re.Match`: if matched given string.
         """
         return self.pexpect_proc.expect(pattern, **kwargs)
 
     @_pexpect_func  # noqa
     def expect_exact(self, pattern, **kwargs) -> Match:  # noqa
         """
-        Expect the `pattern` from the internal buffer. All the arguments would pass to `pexpect.expect_exact()`.
+        Expect the `pattern` from the internal buffer. All the arguments will be passed to `pexpect.expect_exact()`.
 
         Args:
             pattern: string, or a list of string
@@ -132,9 +133,10 @@ class Dut(_InjectMixinCls):
                 Otherwise match any of them could pass
 
         Returns:
-            (AnyStr): if you're matching pexpect.EOF or pexpect.TIMEOUT to get all the current buffers.
+            `AnyStr` or `re.Match`
 
-            (re.Match): if matched given string.
+            - `AnyStr`: if you're matching `pexpect.EOF` or `pexpect.TIMEOUT` to get all the current buffers.
+            - `re.Match`: if matched given string.
         """
         return self.pexpect_proc.expect_exact(pattern, **kwargs)
 
@@ -147,7 +149,7 @@ class Dut(_InjectMixinCls):
         """
         Expect a unity test summary block and parse the output into junit report.
 
-        Would combine the junit report into the main one if you use `pytest --junitxml` feature.
+        Would combine the junit report into the main one if you use ``pytest --junitxml`` feature.
 
         Args:
             remove_asci_escape_code: remove asci escape code in the message field. (default: True)
@@ -155,10 +157,10 @@ class Dut(_InjectMixinCls):
             extra_before: would append before the expected bytes.
                 Use this argument when need to run `expect` functions between one unity test call.
 
-        Notes:
+        Note:
             - Would raise AssertionError at the end of the test if any unity test case result is "FAIL"
-            - Would raise TIMEOUT exception at the end of the test if any unity test case execution took longer
-                than timeout value
+            - Would raise TIMEOUT exception at the end of the test \
+                if any unity test case execution took longer than timeout value
 
         Warning:
             - All unity test cases record would be missed if the final report block is uncaught.
@@ -182,7 +184,7 @@ class Dut(_InjectMixinCls):
         reset: bool = False,
         timeout: float = 30,
         run_ignore_cases: bool = False,
-    ):
+    ) -> None:
         """
         Run all multi_stage cases
 
@@ -193,6 +195,6 @@ class Dut(_InjectMixinCls):
             run_ignore_cases: run ignored test cases or not
 
         Warning:
-            requires enable service `idf`
+            requires enable service ``idf``
         """
         pass

{pytest-embedded-1.3.0 → pytest-embedded-1.3.1}/pytest_embedded/log.py

@@ -55,17 +55,15 @@ class PexpectProcess(pexpect.fdpexpect.fdspawn):
             placeholder=f'... (total {len(self.buffer)} bytes)',
         )
 
-    def read_nonblocking(self, size=1, timeout=-1) -> bytes:
+    def read_nonblocking(self, size: int = 1, timeout: int = -1) -> bytes:
         """
         Since we're using real file stream, here we only raise an EOF error when the file stream has been closed.
         This could solve the `os.read()` blocked issue.
 
-        :return: String containing the bytes read
-
         Args:
-            size (int): Read at most *size* bytes.
-            timeout (float): Wait timeout seconds for file descriptor to be
-                ready to read. When -1 (default), use self.timeout. When 0, poll.
+            size: Read at most *size* bytes.
+            timeout: Wait timeout seconds for file descriptor to be
+                ready to read. When -1 (default), use `self.timeout`. When 0, poll.
 
         Returns:
             String containing the bytes read
@@ -115,7 +113,7 @@ def live_print_call(*args, msg_queue: Optional[MessageQueue] = None, expect_retu
         msg_queue: `MessageQueue` instance, would redirect to message queue instead of sys.stdout if specified
         expect_returncode: expect return code. (Default 0). Would raise exception when return code is different
 
-    Notes:
+    Note:
         This function behaves the same as `subprocess.call()`, it would block your current process.
     """
     default_kwargs = {
@@ -210,12 +208,11 @@ class DuplicateStdoutPopen(subprocess.Popen):
         super().terminate()
 
     def write(self, s: AnyStr) -> None:
-        """
+        r"""
         Write to `stdin` via `stdin.write`.
 
-        If the input is `str`, will encode to `bytes` and add a b'\\n' automatically in the end.
-
-        if the input is `bytes`, will pass this directly.
+        - If the input is `str`, will encode to `bytes` and add a b'\\n' automatically in the end.
+        - If the input is `bytes`, will pass this directly.
 
         Args:
             s: bytes or str

{pytest-embedded-1.3.0 → pytest-embedded-1.3.1}/pytest_embedded/plugin.py

@@ -341,7 +341,7 @@ def multi_dut_fixture(func) -> t.Callable[..., t.Union[t.Any, t.Tuple[t.Any]]]:
     """
     Apply the multi-dut arguments to each fixture.
 
-    Notes:
+    Note:
         Run the `func(*args, **kwargs)` for multiple times by iterating all `kwargs` via `itemgetter`
 
         For example:
@@ -387,7 +387,7 @@ def multi_dut_generator_fixture(
     """
     Apply the multi-dut arguments to each fixture.
 
-    Notes:
+    Note:
         Run the `func()` for multiple times by iterating all `kwargs` via `itemgetter`. Auto call `close()` or
         `terminate()` method of the object after it yield back.
 

{pytest-embedded-1.3.0 → pytest-embedded-1.3.1}/pytest_embedded/utils.py

@@ -1,4 +1,5 @@
 import dataclasses
+import functools
 import importlib
 import logging
 import os
@@ -117,10 +118,11 @@ def to_list(s: _T) -> t.List[_T]:
         s: Anything
 
     Returns:
-        List (list[_T]):
-            - `list(s)` (List. If `s` is a tuple or a set.
-            - itself. If `s` is a list.
-            - `[s]`. If `s` is other types.
+        List (list[_T])
+
+        - `list(s)` (List. If `s` is a tuple or a set.
+        - itself. If `s` is a list.
+        - `[s]`. If `s` is other types.
     """
     if not s:
         return s
@@ -231,22 +233,23 @@ def lazy_load(
     Returns:
         __getattr__ function
 
-    Examples:
-        ```python
-        __getattr__ = lazy_load(
-            importlib.import_module(__name__),
-            {
-                'IdfApp': IdfApp,
-                'LinuxDut': LinuxDut,
-                'LinuxSerial': LinuxSerial,
-                'CaseTester': CaseTester,
-            },
-            {
-                'IdfSerial': '.serial',
-                'IdfDut': '.dut',
-            },
-        )
-        ```
+    Example:
+
+        ::
+
+            __getattr__ = lazy_load(
+                importlib.import_module(__name__),
+                {
+                    'IdfApp': IdfApp,
+                    'LinuxDut': LinuxDut,
+                    'LinuxSerial': LinuxSerial,
+                    'CaseTester': CaseTester,
+                },
+                {
+                    'IdfSerial': '.serial',
+                    'IdfDut': '.dut',
+                },
+            )
     """
 
     def __getattr__(object_name):
@@ -294,33 +297,36 @@ class _InjectMixinCls(metaclass=_InjectMixinMeta):
     - provide the autocompletion for the functions provided by the mixins
     - check the requirement at runtime
 
-    Examples:
+    Example:
+
+        ::
 
-        class IdfUnityMixin:
-            def foo(self):
-                print('foo from MixinOne')
+            class IdfUnityMixin:
+                def foo(self):
+                    print('foo from MixinOne')
 
 
-        class Test(_InjectMixinCls):
-            def __init__(self, **kwargs):
-                for k, v in kwargs.items():
-                    setattr(self, k, v)
+            class Test(_InjectMixinCls):
+                def __init__(self, **kwargs):
+                    for k, v in kwargs.items():
+                        setattr(self, k, v)
 
-            @_InjectMixinCls.require_services('idf')
-            def foo(self):
-                pass
+                @_InjectMixinCls.require_services('idf')
+                def foo(self):
+                    pass
 
 
-        # mro(): TestWithIdfUnityMixin, IdfUnityMixin, Test, object
-        s1 = Test(mixins=IdfUnityMixin)
-        # mro(): Test, object
-        s2 = Test()
-        s1.foo()  # foo from IdfUnityMixin
-        s2.foo()  # function foo requires enabling one of the service(s) idf.
+            # mro(): TestWithIdfUnityMixin, IdfUnityMixin, Test, object
+            s1 = Test(mixins=IdfUnityMixin)
+            # mro(): Test, object
+            s2 = Test()
+            s1.foo()  # foo from IdfUnityMixin
+            s2.foo()  # function foo requires enabling one of the service(s) idf.
     """
 
     def require_services(*services):
         def decorator(func):
+            @functools.wraps(func)
             def wrapped(self, *args, **kwargs):
                 based = False
                 for service in services:

{pytest-embedded-1.3.0 → pytest-embedded-1.3.1}/pytest_embedded.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.2
 Name: pytest-embedded
-Version: 1.3.0
+Version: 1.3.1
 Summary: pytest embedded plugin
 Home-page: https://docs.espressif.com/projects/pytest-embedded/en/latest/
 Author: Fu Hanxi
@@ -10,10 +10,6 @@ Description: ### pytest-embedded
         
         A pytest plugin for embedded systems. Could activate different services for extra functionalities.
         
-        Used CLI Options:
-        
-        - `app_path`
-        
 Platform: UNKNOWN
 Classifier: Framework :: Pytest
 Classifier: Intended Audience :: Developers