hardpy 0.6.1__py3-none-any.whl → 0.7.0__py3-none-any.whl

hardpy/pytest_hardpy/utils/__init__.py

@@ -1,40 +1,40 @@
 # Copyright (c) 2024 Everypin
 # GNU General Public License v3.0 (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
 
-from hardpy.pytest_hardpy.utils.node_info import NodeInfo
-from hardpy.pytest_hardpy.utils.progress_calculator import ProgressCalculator
-from hardpy.pytest_hardpy.utils.const import TestStatus
-from hardpy.pytest_hardpy.utils.singleton import Singleton
 from hardpy.pytest_hardpy.utils.connection_data import ConnectionData
-from hardpy.pytest_hardpy.utils.exception import (
-    DuplicateSerialNumberError,
-    DuplicatePartNumberError,
-    DuplicateTestStandNameError,
-    DuplicateDialogBoxError,
-    WidgetInfoError,
-)
+from hardpy.pytest_hardpy.utils.const import TestStatus
 from hardpy.pytest_hardpy.utils.dialog_box import (
-    DialogBox,
-    TextInputWidget,
-    NumericInputWidget,
     CheckboxWidget,
-    RadiobuttonWidget,
+    DialogBox,
     ImageWidget,
     MultistepWidget,
+    NumericInputWidget,
+    RadiobuttonWidget,
     StepWidget,
+    TextInputWidget,
 )
-
+from hardpy.pytest_hardpy.utils.exception import (
+    DuplicatePartNumberError,
+    DuplicateSerialNumberError,
+    DuplicateTestStandLocationError,
+    DuplicateTestStandNameError,
+    WidgetInfoError,
+)
+from hardpy.pytest_hardpy.utils.machineid import machine_id
+from hardpy.pytest_hardpy.utils.node_info import NodeInfo
+from hardpy.pytest_hardpy.utils.progress_calculator import ProgressCalculator
+from hardpy.pytest_hardpy.utils.singleton import SingletonMeta
 
 __all__ = [
     "NodeInfo",
     "ProgressCalculator",
     "TestStatus",
-    "Singleton",
+    "SingletonMeta",
     "ConnectionData",
     "DuplicateSerialNumberError",
     "DuplicatePartNumberError",
+    "DuplicateTestStandLocationError",
     "DuplicateTestStandNameError",
-    "DuplicateDialogBoxError",
     "WidgetInfoError",
     "DialogBox",
     "TextInputWidget",
@@ -43,5 +43,6 @@ __all__ = [
     "RadiobuttonWidget",
     "ImageWidget",
     "MultistepWidget",
-    "StepWidget"
+    "StepWidget",
+    "machine_id",
 ]

hardpy/pytest_hardpy/utils/connection_data.py

@@ -3,15 +3,13 @@
 
 from socket import gethostname
 
-from hardpy.pytest_hardpy.utils.singleton import Singleton
+from hardpy.pytest_hardpy.utils.singleton import SingletonMeta
 
 
-class ConnectionData(Singleton):
+class ConnectionData(metaclass=SingletonMeta):
     """Connection data storage."""
 
-    def __init__(self):
-        if not self._initialized:
-            self.database_url: str = "http://dev:dev@localhost:5984/"
-            self.socket_host: str = gethostname()
-            self.socket_port: int = 6525
-            self._initialized = True
+    def __init__(self) -> None:
+        self.database_url: str = "http://dev:dev@localhost:5984/"
+        self.socket_host: str = gethostname()
+        self.socket_port: int = 6525

hardpy/pytest_hardpy/utils/const.py

@@ -4,7 +4,7 @@
 from enum import Enum
 
 
-class TestStatus(str, Enum):  # noqa: WPS600
+class TestStatus(str, Enum):
     """Pytest test status.
 
     Statuses, that can be returned by Pytest.

hardpy/pytest_hardpy/utils/dialog_box.py

@@ -1,5 +1,6 @@
 # Copyright (c) 2024 Everypin
 # GNU General Public License v3.0 (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
+from __future__ import annotations
 
 import base64
 from abc import ABC, abstractmethod
@@ -28,12 +29,12 @@ class WidgetType(Enum):
 class IWidget(ABC):
     """Dialog box widget interface."""
 
-    def __init__(self, widget_type: WidgetType):
+    def __init__(self, widget_type: WidgetType) -> None:
         self.type: Final[str] = widget_type.value
         self.info: dict = {}
 
     @abstractmethod
-    def convert_data(self, input_data: str | None) -> Any | None:
+    def convert_data(self, input_data: str | None) -> Any | None:  # noqa: ANN401
         """Get the widget data in the correct format.
 
         Args:
@@ -48,10 +49,10 @@ class IWidget(ABC):
 class BaseWidget(IWidget):
     """Widget info interface."""
 
-    def __init__(self, widget_type: WidgetType = WidgetType.BASE):
+    def __init__(self, widget_type: WidgetType = WidgetType.BASE) -> None:  # noqa: ARG002
         super().__init__(WidgetType.BASE)
 
-    def convert_data(self, input_data: str | None = None) -> bool:  # noqa: WPS324
+    def convert_data(self, input_data: str | None = None) -> bool:  # noqa: ARG002
         """Get base widget data, i.e. None.
 
         Args:
@@ -66,7 +67,7 @@ class BaseWidget(IWidget):
 class TextInputWidget(IWidget):
     """Text input widget."""
 
-    def __init__(self):
+    def __init__(self) -> None:
         """Initialize the TextInputWidget."""
         super().__init__(WidgetType.TEXT_INPUT)
 
@@ -85,7 +86,7 @@ class TextInputWidget(IWidget):
 class NumericInputWidget(IWidget):
     """Numeric input widget."""
 
-    def __init__(self):
+    def __init__(self) -> None:
         """Initialize the NumericInputWidget."""
         super().__init__(WidgetType.NUMERIC_INPUT)
 
@@ -107,7 +108,7 @@ class NumericInputWidget(IWidget):
 class RadiobuttonWidget(IWidget):
     """Radiobutton widget."""
 
-    def __init__(self, fields: list[str]):
+    def __init__(self, fields: list[str]) -> None:
         """Initialize the RadiobuttonWidget.
 
         Args:
@@ -118,7 +119,8 @@ class RadiobuttonWidget(IWidget):
         """
         super().__init__(WidgetType.RADIOBUTTON)
         if not fields:
-            raise ValueError("RadiobuttonWidget must have at least one field")
+            msg = "RadiobuttonWidget must have at least one field"
+            raise ValueError(msg)
         self.info["fields"] = fields
 
     def convert_data(self, input_data: str) -> str:
@@ -136,7 +138,7 @@ class RadiobuttonWidget(IWidget):
 class CheckboxWidget(IWidget):
     """Checkbox widget."""
 
-    def __init__(self, fields: list[str]):
+    def __init__(self, fields: list[str]) -> None:
         """Initialize the CheckboxWidget.
 
         Args:
@@ -147,7 +149,8 @@ class CheckboxWidget(IWidget):
         """
         super().__init__(WidgetType.CHECKBOX)
         if not fields:
-            raise ValueError("Checkbox must have at least one field")
+            msg = "Checkbox must have at least one field"
+            raise ValueError(msg)
         self.info["fields"] = fields
 
     def convert_data(self, input_data: str) -> list[str] | None:
@@ -168,7 +171,7 @@ class CheckboxWidget(IWidget):
 class ImageWidget(IWidget):
     """Image widget."""
 
-    def __init__(self, address: str, format: str = "image", width: int = 100):
+    def __init__(self, address: str, format: str = "image", width: int = 100) -> None:  # noqa: A002
         """Validate the image fields and defines the base64 if it does not exist.
 
         Args:
@@ -182,20 +185,22 @@ class ImageWidget(IWidget):
         super().__init__(WidgetType.IMAGE)
 
         if width < 1:
-            raise WidgetInfoError("Width must be positive")
+            msg = "Width must be positive"
+            raise WidgetInfoError(msg)
 
         self.info["address"] = address
         self.info["format"] = format
         self.info["width"] = width
 
         try:
-            with open(address, "rb") as file:
+            with open(address, "rb") as file:  # noqa: PTH123
                 file_data = file.read()
         except FileNotFoundError:
-            raise WidgetInfoError("The image address is invalid")
+            msg = "The image address is invalid"
+            raise WidgetInfoError(msg)  # noqa: B904
         self.info["base64"] = base64.b64encode(file_data).decode("utf-8")
 
-    def convert_data(self, input_data: str | None = None) -> bool:
+    def convert_data(self, input_data: str | None = None) -> bool:  # noqa: ARG002
         """Get the image widget data, i.e. None.
 
         Args:
@@ -219,17 +224,23 @@ class StepWidget(IWidget):
         WidgetInfoError: If the text or widget are not provided.
     """
 
-    def __init__(self, title: str, text: str | None, widget: ImageWidget | None):
+    def __init__(
+        self,
+        title: str,
+        text: str | None,
+        widget: ImageWidget | None,
+    ) -> None:
         super().__init__(WidgetType.STEP)
         if text is None and widget is None:
-            raise WidgetInfoError("Text or widget must be provided")
+            msg = "Text or widget must be provided"
+            raise WidgetInfoError(msg)
         self.info["title"] = title
         if isinstance(text, str):
             self.info["text"] = text
         if isinstance(widget, ImageWidget):
             self.info["widget"] = widget.__dict__
 
-    def convert_data(self, input_data: str) -> bool:
+    def convert_data(self, input_data: str) -> bool:  # noqa: ARG002
         """Get the step widget data in the correct format.
 
         Args:
@@ -244,7 +255,7 @@ class StepWidget(IWidget):
 class MultistepWidget(IWidget):
     """Multistep widget."""
 
-    def __init__(self, steps: list[StepWidget]):
+    def __init__(self, steps: list[StepWidget]) -> None:
         """Initialize the MultistepWidget.
 
         Args:
@@ -255,12 +266,13 @@ class MultistepWidget(IWidget):
         """
         super().__init__(WidgetType.MULTISTEP)
         if not steps:
-            raise ValueError("MultistepWidget must have at least one step")
+            msg = "MultistepWidget must have at least one step"
+            raise ValueError(msg)
         self.info["steps"] = []
         for step in steps:
             self.info["steps"].append(step.__dict__)
 
-    def convert_data(self, input_data: str) -> bool:
+    def convert_data(self, input_data: str) -> bool:  # noqa: ARG002
         """Get the multistep widget data in the correct format.
 
         Args:
@@ -287,7 +299,7 @@ class DialogBox:
         dialog_text: str,
         title_bar: str | None = None,
         widget: IWidget | None = None,
-    ):
+    ) -> None:
         self.widget: IWidget = BaseWidget() if widget is None else widget
         self.dialog_text: str = dialog_text
         self.title_bar: str | None = title_bar

hardpy/pytest_hardpy/utils/exception.py

@@ -5,40 +5,40 @@
 class HardpyError(Exception):
     """Base HardPy exception."""
 
-    def __init__(self, msg: str):
+    def __init__(self, msg: str) -> None:
         super().__init__(f"HardPy error: {msg}")
 
 
 class DuplicateSerialNumberError(HardpyError):
     """The serial number has already been determined."""
 
-    def __init__(self):
+    def __init__(self) -> None:
         super().__init__(self.__doc__)  # type: ignore
 
 
 class DuplicatePartNumberError(HardpyError):
     """The part number has already been determined."""
 
-    def __init__(self):
+    def __init__(self) -> None:
         super().__init__(self.__doc__)  # type: ignore
 
 
 class DuplicateTestStandNameError(HardpyError):
     """The test stand name has already been determined."""
 
-    def __init__(self):
+    def __init__(self) -> None:
         super().__init__(self.__doc__)  # type: ignore
 
 
-class DuplicateDialogBoxError(HardpyError):
-    """The dialog box has already been determined."""
+class DuplicateTestStandLocationError(HardpyError):
+    """The test stand location has already been determined."""
 
-    def __init__(self):
+    def __init__(self) -> None:
         super().__init__(self.__doc__)  # type: ignore
 
 
 class WidgetInfoError(HardpyError):
     """The widget info is not correct."""
 
-    def __init__(self, message):
+    def __init__(self, message: str) -> None:
         super().__init__(message)

hardpy/pytest_hardpy/utils/machineid.py

@@ -0,0 +1,15 @@
+from platform import node as platform_node
+
+import machineid
+
+
+def machine_id() -> str:
+    """Get machine id.
+
+    Returns:
+        str: id, if available, otherwise MAC address
+    """
+    try:
+        return machineid.id()
+    except machineid.MachineIdNotFound:
+        return platform_node()

hardpy/pytest_hardpy/utils/node_info.py

@@ -1,12 +1,14 @@
 # Copyright (c) 2024 Everypin
 # GNU General Public License v3.0 (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
+from __future__ import annotations
 
 import re
 from logging import getLogger
 from pathlib import Path
-from typing import NamedTuple
+from typing import TYPE_CHECKING, NamedTuple
 
-from pytest import Item, Mark
+if TYPE_CHECKING:
+    from pytest import Item, Mark
 
 
 class TestDependencyInfo(NamedTuple):
@@ -22,7 +24,7 @@ class TestDependencyInfo(NamedTuple):
 class NodeInfo:
     """Test node info."""
 
-    def __init__(self, item: Item):
+    def __init__(self, item: Item) -> None:
         self._item = item
         self._log = getLogger(__name__)
 
@@ -31,19 +33,21 @@ class NodeInfo:
             "case_name",
         )
         self._module_name = self._get_human_name(
-            item.parent.own_markers,
+            item.parent.own_markers,  # type: ignore
             "module_name",
         )
 
         self._dependency = self._get_dependency_info(
-            item.own_markers + item.parent.own_markers
+            item.own_markers + item.parent.own_markers,  # type: ignore
         )
 
-        self._module_id = Path(item.parent.nodeid).stem
+        self._attempt = self._get_attempt(item.own_markers)
+
+        self._module_id = Path(item.parent.nodeid).stem  # type: ignore
         self._case_id = item.name
 
     @property
-    def module_id(self):
+    def module_id(self) -> str:
         """Get module id.
 
         Returns:
@@ -52,7 +56,7 @@ class NodeInfo:
         return self._module_id
 
     @property
-    def case_id(self):
+    def case_id(self) -> str:
         """Get case id.
 
         Returns:
@@ -61,7 +65,7 @@ class NodeInfo:
         return self._case_id
 
     @property
-    def module_name(self):
+    def module_name(self) -> str:
         """Get module name.
 
         Returns:
@@ -70,7 +74,7 @@ class NodeInfo:
         return self._module_name
 
     @property
-    def case_name(self):
+    def case_name(self) -> str:
         """Get case name.
 
         Returns:
@@ -79,7 +83,7 @@ class NodeInfo:
         return self._case_name
 
     @property
-    def dependency(self):
+    def dependency(self) -> TestDependencyInfo | str:
         """Get dependency information.
 
         Returns:
@@ -87,6 +91,15 @@ class NodeInfo:
         """
         return self._dependency
 
+    @property
+    def attempt(self) -> int:
+        """Get attempt.
+
+        Returns:
+            int: attempt number
+        """
+        return self._attempt
+
     def _get_human_name(self, markers: list[Mark], marker_name: str) -> str:
         """Get human name from markers.
 
@@ -98,10 +111,8 @@ class NodeInfo:
             str: human name by user
         """
         for marker in markers:
-            if marker.name == marker_name:
-                if marker.args:
-                    return marker.args[0]
-
+            if marker.name == marker_name and marker.args:
+                return marker.args[0]
         return ""
 
     def _get_dependency_info(self, markers: list[Mark]) -> TestDependencyInfo | str:
@@ -118,8 +129,26 @@ class NodeInfo:
         dependency_data = re.search(r"(\w+)::(\w+)", dependency_value)
         if dependency_data:
             return TestDependencyInfo(*dependency_data.groups())
-        elif re.search(r"^\w+$", dependency_value):
+        elif re.search(r"^\w+$", dependency_value):  # noqa: RET505
             return TestDependencyInfo(dependency_value, None)
         elif dependency_data is None and dependency_value == "":
             return ""
         raise ValueError
+
+    def _get_attempt(self, markers: list[Mark]) -> int:
+        """Get the number of attempts.
+
+        Args:
+            markers (list[Mark]): item markers list
+
+        Returns:
+            int: number of attempts
+        """
+        attempt: int = 1
+        for marker in markers:
+            if marker.name == "attempt" and marker.args:
+                attempt = marker.args[0]
+        if not isinstance(attempt, int) or attempt < 1:
+            msg = "The 'attempt' marker value must be a positive integer."
+            raise ValueError(msg)
+        return attempt

hardpy/pytest_hardpy/utils/progress_calculator.py

@@ -7,12 +7,12 @@ from logging import getLogger
 class ProgressCalculator:
     """Test run progress calculator."""
 
-    def __init__(self):
+    def __init__(self) -> None:
         self._progress_nodeids: set[str] = set()
         self._tests_amount: int = 1
         self._log = getLogger(__name__)
 
-    def set_test_amount(self, amount: int):
+    def set_test_amount(self, amount: int) -> None:
         """Set test amount.
 
         Raises:
@@ -22,7 +22,8 @@ class ProgressCalculator:
             amount (int): test amount
         """
         if amount <= 0:
-            raise ValueError("Test amount must be greater than 0.")
+            msg = "Test amount must be greater than 0."
+            raise ValueError(msg)
         self._tests_amount = amount
 
     def calculate(self, nodeid: str) -> int:

hardpy/pytest_hardpy/utils/singleton.py

@@ -1,23 +1,30 @@
 # Copyright (c) 2024 Everypin
 # GNU General Public License v3.0 (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
+from __future__ import annotations
 
-class Singleton:
-    """Singleton class.
+from typing import Generic, TypeVar
 
-    In the child class must be used constructor of type:
+T = TypeVar("T")
 
-    def __init__(self):
-        if not self._initialized:
-            ...
-            your code
-            ...
-            self._initialized = True
-    """
 
-    _instance = None
-    _initialized = False
+class SingletonMeta(type, Generic[T]):  # noqa: D101
+    _instances: dict[SingletonMeta[T], T] = {}  # noqa: RUF012
 
-    def __new__(cls, *args, **kwargs):  # noqa: D102
-        if not cls._instance:
-            cls._instance = super().__new__(cls, *args, **kwargs)
-        return cls._instance
+    def __call__(cls, *args, **kwargs) -> T:  # noqa: ANN002, ANN003
+        """Magic method to create an instance of the class.
+
+        Args:
+            *args: Variable length argument list
+            **kwargs: Arbitrary keyword arguments
+        Returns:
+            object: An instance of the class
+        """
+        if cls not in cls._instances:
+            cls._instances[cls] = super().__call__(
+                *args,
+                **kwargs,
+            )
+        return cls._instances[cls]
+
+    def __instancecheck__(cls, instance: object) -> bool:
+        return cls.__subclasscheck__(type(instance))

{hardpy-0.6.1.dist-info → hardpy-0.7.0.dist-info}/METADATA

@@ -1,17 +1,17 @@
 Metadata-Version: 2.1
 Name: hardpy
-Version: 0.6.1
+Version: 0.7.0
 Summary: HardPy library for device testing
 Project-URL: Homepage, https://github.com/everypinio/hardpy/
 Project-URL: Documentation, https://everypinio.github.io/hardpy/
 Project-URL: Repository, https://github.com/everypinio/hardpy/
 Project-URL: Changelog, https://everypinio.github.io/hardpy/changelog/
-Author: Everypin
+Author-email: Everypin <info@everypin.io>
+License-Expression: GPL-3.0-or-later
 License-File: LICENSE
 Classifier: Development Status :: 4 - Beta
 Classifier: Framework :: Pytest
 Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
@@ -22,10 +22,11 @@ Classifier: Topic :: Software Development :: Libraries
 Classifier: Topic :: Software Development :: Testing
 Classifier: Topic :: Software Development :: Testing :: Acceptance
 Classifier: Topic :: Utilities
-Requires-Python: <4,>=3.10
+Requires-Python: >=3.10
 Requires-Dist: fastapi>=0.100.1
 Requires-Dist: glom>=23.3.0
 Requires-Dist: natsort>=8.4.0
+Requires-Dist: py-machineid~=0.6.0
 Requires-Dist: pycouchdb>=1.14.2
 Requires-Dist: pydantic>=2.4.0
 Requires-Dist: pytest<9,>=7
@@ -35,30 +36,27 @@ Requires-Dist: uvicorn>=0.23.2
 Provides-Extra: build
 Requires-Dist: build==1.0.3; extra == 'build'
 Provides-Extra: dev
-Requires-Dist: black; extra == 'dev'
-Requires-Dist: mypy; extra == 'dev'
-Requires-Dist: wemake-python-styleguide; extra == 'dev'
+Requires-Dist: mypy>=1.11.0; extra == 'dev'
+Requires-Dist: ruff>=0.5.6; extra == 'dev'
+Requires-Dist: wemake-python-styleguide>=0.19.2; extra == 'dev'
 Description-Content-Type: text/markdown
 
 <h1 align="center">
-    <img src="https://everypinio.github.io/hardpy/img/logo256.png" alt="HardPy" style="width:200px;">
-</h1>
-
-<h1 align="center">
-    <b>HardPy</b>
+    <img src="https://raw.githubusercontent.com/everypinio/hardpy/main/docs/img/logo256.png" alt="HardPy" style="width:150px;">
 </h1>
 
 <p align="center">
 HardPy is a python library for creating a test bench for devices.
 </p>
 
----
-
-**Documentation**: <a href=https://everypinio.github.io/hardpy/ target="_blank">https://everypinio.github.io/hardpy/</a>
+<div align="center">
 
-**Source Code**: <a href=https://github.com/everypinio/hardpy target="_blank">https://github.com/everypinio/hardpy</a>
+[![PyPI version](https://badge.fury.io/py/hardpy.svg)](https://badge.fury.io/py/hardpy)
+![python versions](https://img.shields.io/pypi/pyversions/hardpy.svg)
+[![pytest versions](https://img.shields.io/badge/pytest-%3E%3D7.0%20%3C9.0-blue)](https://docs.pytest.org/en/latest/)
+[![Documentation](https://img.shields.io/badge/Documentation%20-Overview%20-%20%23007ec6)](https://everypinio.github.io/hardpy/)
 
-**PyPi**: <a href=https://pypi.org/project/hardpy/ target="_blank">https://pypi.org/project/hardpy/</a>
+</div>
 
 ---
 
@@ -70,6 +68,10 @@ HardPy allows you to:
 * Use a browser to view, start, stop, and interact with tests;
 * Store test results in the [CouchDB](https://couchdb.apache.org/) database.
 
+<h1 align="center">
+    <img src="https://raw.githubusercontent.com/everypinio/hardpy/main/docs/img/hardpy_panel.gif" alt="hardpy panel" style="width:550px;">
+</h1>
+
 ## To Install
 
 ```bash
@@ -92,21 +94,10 @@ docker compose up -d
 hardpy run
 ```
 4. View operator panel in browser: http://localhost:8000/
-
-  <h1 align="center">
-      <img src="https://everypinio.github.io/hardpy/img/hardpy_operator_panel_hello_hardpy.png"
-      alt="hardpy operator panel" style="width:600px;">
-  </h1>
-
 5. View the latest test report: http://localhost:5984/_utils
 
     Login and password: **dev**, database - **runstore**, document - **current**.
 
-  <h1 align="center">
-      <img src="https://everypinio.github.io/hardpy/img/runstore_hello_hardpy.png"
-      alt="hardpy runstore" style="width:500px;">
-  </h1>
-
 ## Examples
 
 Find more examples of using the **HardPy** in the [examples](https://github.com/everypinio/hardpy/tree/main/examples) folder.