python-snap7 2.0.0__tar.gz → 2.0.1__tar.gz

{python_snap7-2.0.0/python_snap7.egg-info → python_snap7-2.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-snap7
-Version: 2.0.0
+Version: 2.0.1
 Summary: Python wrapper for the snap7 library
 Author-email: Gijs Molenaar <gijsmolenaar@gmail.com>
 License: MIT License
@@ -18,6 +18,7 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Requires-Python: >=3.9
 Description-Content-Type: text/x-rst
 License-File: LICENSE
@@ -28,12 +29,14 @@ Requires-Dist: types-setuptools; extra == "test"
 Requires-Dist: ruff; extra == "test"
 Requires-Dist: tox; extra == "test"
 Requires-Dist: types-click; extra == "test"
+Requires-Dist: uv; extra == "test"
 Provides-Extra: cli
 Requires-Dist: rich; extra == "cli"
 Requires-Dist: click; extra == "cli"
 Provides-Extra: doc
 Requires-Dist: sphinx; extra == "doc"
 Requires-Dist: sphinx_rtd_theme; extra == "doc"
+Requires-Dist: enum-tools[sphinx]; extra == "doc"
 
 About
 =====

{python_snap7-2.0.0 → python_snap7-2.0.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "python-snap7"
-version = "2.0.0"
+version = "2.0.1"
 description = "Python wrapper for the snap7 library"
 readme = "README.rst"
 authors = [
@@ -22,6 +22,7 @@ classifiers = [
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
 ]
 license = {text = "MIT License"}
 requires-python = ">=3.9"
@@ -32,9 +33,9 @@ Homepage = "https://github.com/gijzelaerr/python-snap7"
 Documentation = "https://python-snap7.readthedocs.io/en/latest/"
 
 [project.optional-dependencies]
-test = ["pytest", "mypy", "types-setuptools", "ruff", "tox", "types-click"]
+test = ["pytest", "mypy", "types-setuptools", "ruff", "tox", "types-click", "uv"]
 cli = ["rich", "click" ]
-doc = ["sphinx", "sphinx_rtd_theme"]
+doc = ["sphinx", "sphinx_rtd_theme", "enum-tools[sphinx]"]
 
 [tool.setuptools.package-data]
 snap7 = ["py.typed", "lib/libsnap7.so", "lib/snap7.dll", "lib/libsnap7.dylib"]

{python_snap7-2.0.0 → python_snap7-2.0.1/python_snap7.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-snap7
-Version: 2.0.0
+Version: 2.0.1
 Summary: Python wrapper for the snap7 library
 Author-email: Gijs Molenaar <gijsmolenaar@gmail.com>
 License: MIT License
@@ -18,6 +18,7 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Requires-Python: >=3.9
 Description-Content-Type: text/x-rst
 License-File: LICENSE
@@ -28,12 +29,14 @@ Requires-Dist: types-setuptools; extra == "test"
 Requires-Dist: ruff; extra == "test"
 Requires-Dist: tox; extra == "test"
 Requires-Dist: types-click; extra == "test"
+Requires-Dist: uv; extra == "test"
 Provides-Extra: cli
 Requires-Dist: rich; extra == "cli"
 Requires-Dist: click; extra == "cli"
 Provides-Extra: doc
 Requires-Dist: sphinx; extra == "doc"
 Requires-Dist: sphinx_rtd_theme; extra == "doc"
+Requires-Dist: enum-tools[sphinx]; extra == "doc"
 
 About
 =====

{python_snap7-2.0.0 → python_snap7-2.0.1}/python_snap7.egg-info/requires.txt

@@ -6,6 +6,7 @@ click
 [doc]
 sphinx
 sphinx_rtd_theme
+enum-tools[sphinx]
 
 [test]
 pytest
@@ -14,3 +15,4 @@ types-setuptools
 ruff
 tox
 types-click
+uv

{python_snap7-2.0.0 → python_snap7-2.0.1}/snap7/client.py

@@ -469,9 +469,6 @@ class Client:
 
         Returns:
             If size is 0, it returns a 0, otherwise an `Array` of specified block type.
-
-        Raises:
-            :obj:`ValueError`: if the `block_type` is not valid.
         """
 
         logger.debug(f"listing blocks of type: {block_type} size: {size}")
@@ -498,11 +495,8 @@ class Client:
         Returns:
             Structure of information from block.
 
-        Raises:
-            :obj:`ValueError`: if the `blocktype` is not valid.
-
         Examples:
-            >>> block_info = Client().get_block_info("DB", 1)
+            >>> block_info = Client().get_block_info(block_type.DB, 1)
             >>> print(block_info)
             Block type: 10
             Block number: 1

{python_snap7-2.0.0 → python_snap7-2.0.1}/snap7/type.py

@@ -45,7 +45,10 @@ mkLog = 1
 
 
 class Parameter(IntEnum):
-    # // PARAMS LIST
+    """
+    The snap7 parameter types
+    """
+
     LocalPort = 1
     RemotePort = 2
     PingTimeout = 3
@@ -87,6 +90,10 @@ class Parameter(IntEnum):
 # Area ID
 # Word Length
 class WordLen(IntEnum):
+    """
+    The snap7 word length types
+    """
+
     Bit = 0x01
     Byte = 0x02
     Char = 0x03
@@ -113,6 +120,10 @@ class WordLen(IntEnum):
 
 
 class Area(IntEnum):
+    """
+    The snap7 area types
+    """
+
     PE = 0x81
     PA = 0x82
     MK = 0x83
@@ -134,6 +145,8 @@ Areas = Area
 
 class SrvArea(IntEnum):
     """
+    The snap7 server area types
+
     NOTE: these values are DIFFERENT from the normal area IDs.
     """
 
@@ -146,6 +159,10 @@ class SrvArea(IntEnum):
 
 
 class Block(IntEnum):
+    """
+    The snap7 block type
+    """
+
     OB = 0x38
     DB = 0x41
     SDB = 0x42
@@ -173,6 +190,10 @@ cpu_statuses = {
 
 
 class SrvEvent(Structure):
+    """
+    The snap7 server event structure
+    """
+
     _fields_ = [
         ("EvtTime", time_t),
         ("EvtSender", c_int),
@@ -193,6 +214,10 @@ class SrvEvent(Structure):
 
 
 class BlocksList(Structure):
+    """
+    The snap7 block list structure
+    """
+
     _fields_ = [
         ("OBCount", c_int32),
         ("FBCount", c_int32),
@@ -250,6 +275,8 @@ class TS7BlockInfo(Structure):
 
 
 class S7DataItem(Structure):
+    """ """
+
     _pack_ = 1
     _fields_ = [
         ("Area", c_int32),

{python_snap7-2.0.0 → python_snap7-2.0.1}/snap7/util/db.py

@@ -149,11 +149,23 @@ def parse_specification(db_specification: str) -> Dict[str, Any]:
         Parsed DB specification.
     """
     parsed_db_specification = {}
+    pattern = r"""
+        (?P<index>\d+(\.\d+)?)\s+    # Match integer or decimal index
+        (?P<var_name>.*?)\s+         # Non-greedy match for variable name
+        (?P<_type>\S+)$              # Match type at end of line
+    """
+    regex = re.compile(pattern, re.VERBOSE)
 
     for line in db_specification.split("\n"):
         if line and not line.lstrip().startswith("#"):
-            index, var_name, _type = line.lstrip().split("#")[0].split()
-            parsed_db_specification[var_name] = (index, _type)
+            match = regex.match(line.strip())
+            if match:
+                index = match.group("index")
+                var_name = match.group("var_name")
+                _type = match.group("_type")
+                var_name = var_name.strip()
+
+                parsed_db_specification[var_name] = (index, _type)
 
     return parsed_db_specification
 
@@ -303,7 +315,7 @@ class DB:
             if key and key in self.index:
                 msg = f"{key} not unique!"
                 logger.error(msg)
-            self.index[key] = row
+            self.index[str(key)] = row
 
     def __getitem__(self, key: str, default: Optional[None] = None) -> Union[None, "Row"]:
         """Access a row of the table through its index.

{python_snap7-2.0.0 → python_snap7-2.0.1}/snap7/util/getters.py

@@ -493,25 +493,24 @@ def get_lint(bytearray_: bytearray, byte_index: int) -> int:
 def get_lreal(bytearray_: bytearray, byte_index: int) -> float:
     """Get the long real
 
-    Notes:
-        Datatype `lreal` (long real) consists in 8 bytes in the PLC.
-        Negative Range: -1.7976931348623158e+308 to -2.2250738585072014e-308
-        Positive Range: +2.2250738585072014e-308 to +1.7976931348623158e+308
-        Zero: ±0
+    Datatype `lreal` (long real) consists in 8 bytes in the PLC.
+    Negative Range: -1.7976931348623158e+308 to -2.2250738585072014e-308
+    Positive Range: +2.2250738585072014e-308 to +1.7976931348623158e+308
+    Zero: ±0
 
     Args:
         bytearray_: buffer to read from.
         byte_index: byte index from where to start reading.
 
     Returns:
-        Value read.
+        The real value.
 
     Examples:
         read lreal value (here as example 12345.12345) from DB1.10 of a PLC
         >>> from snap7 import Client
         >>> data = Client().db_read(db_number=1, start=10, size=8)
         >>> get_lreal(data, 0)
-            12345.12345
+        12345.12345
     """
     return float(struct.unpack_from(">d", bytearray_, offset=byte_index)[0])
 
@@ -637,7 +636,7 @@ def get_char(bytearray_: bytearray, byte_index: int) -> str:
         >>> from snap7 import Client
         >>> data = Client().db_read(db_number=1, start=10, size=1)
         >>> get_char(data, 0)
-            'C'
+        'C'
     """
     char = chr(bytearray_[byte_index])
     return char
@@ -646,9 +645,7 @@ def get_char(bytearray_: bytearray, byte_index: int) -> str:
 def get_wchar(bytearray_: bytearray, byte_index: int) -> str:
     """Get wchar value from bytearray.
 
-    Notes:
-        Datatype `wchar` in the PLC is represented in 2 bytes. It has to be in utf-16-be format.
-
+    Datatype `wchar` in the PLC is represented in 2 bytes. It has to be in utf-16-be format.
 
     Args:
         bytearray_: buffer to read from.
@@ -662,7 +659,7 @@ def get_wchar(bytearray_: bytearray, byte_index: int) -> str:
         >>> from snap7 import Client
         >>> data = Client().db_read(db_number=1, start=10, size=2)
         >>> get_wchar(data, 0)
-            'C'
+        'C'
     """
     if bytearray_[byte_index] == 0:
         return chr(bytearray_[1])

{python_snap7-2.0.0 → python_snap7-2.0.1}/tests/test_client.py

@@ -18,7 +18,7 @@ from ctypes import (
     pointer,
     Array,
 )
-from datetime import datetime, timedelta, date
+from datetime import datetime, timedelta, timezone
 from multiprocessing import Process
 from unittest import mock
 from typing import cast as typing_cast
@@ -382,8 +382,8 @@ class TestClient(unittest.TestCase):
             self.assertRaises(Exception, self.client.get_param, non_client)
 
     def test_as_copy_ram_to_rom(self) -> None:
-        response = self.client.as_copy_ram_to_rom(timeout=1)
-        self.client.wait_as_completion(1100)
+        response = self.client.as_copy_ram_to_rom(timeout=2)
+        self.client.wait_as_completion(2000)
         self.assertEqual(0, response)
 
     def test_as_ct_read(self) -> None:
@@ -714,7 +714,7 @@ class TestClient(unittest.TestCase):
 
     def test_copy_ram_to_rom(self) -> None:
         # Cli_CopyRamToRom
-        self.assertEqual(0, self.client.copy_ram_to_rom(timeout=1))
+        self.assertEqual(0, self.client.copy_ram_to_rom(timeout=2))
 
     def test_ct_read(self) -> None:
         # Cli_CTRead
@@ -803,8 +803,14 @@ class TestClient(unittest.TestCase):
         self.assertEqual(10, block_info.BlkType)
         self.assertEqual(99, block_info.BlkNumber)
         self.assertEqual(2752512, block_info.SBBLength)
-        self.assertEqual(bytes((date(2019, 6, 27).strftime("%Y/%m/%d")), encoding="utf-8"), block_info.CodeDate)
-        self.assertEqual(bytes((date(2019, 6, 27).strftime("%Y/%m/%d")), encoding="utf-8"), block_info.IntfDate)
+        self.assertEqual(
+            bytes((datetime(2019, 6, 27, tzinfo=timezone.utc).astimezone().strftime("%Y/%m/%d")), encoding="utf-8"),
+            block_info.CodeDate,
+        )
+        self.assertEqual(
+            bytes((datetime(2019, 6, 27, tzinfo=timezone.utc).astimezone().strftime("%Y/%m/%d")), encoding="utf-8"),
+            block_info.IntfDate,
+        )
 
     def test_iso_exchange_buffer(self) -> None:
         # Cli_IsoExchangeBuffer

{python_snap7-2.0.0 → python_snap7-2.0.1}/tests/test_util.py

@@ -53,7 +53,7 @@ test_spec_indented = """
  12.0	testbool1    BOOL
        12.1	testbool2    BOOL
  12.2	testbool3    BOOL
-#    12.3	testbool4    BOOL
+#    12.3	test bool4    BOOL
  #  12.4	testbool5    BOOL
       #    12.5	testbool6    BOOL
     #   12.6	testbool7    BOOL
@@ -439,13 +439,27 @@ class TestS7util(unittest.TestCase):
             self.assertEqual(row["testbool2"], 1)
             self.assertEqual(row["testbool3"], 1)
             self.assertEqual(row["testbool4"], 1)
-
             self.assertEqual(row["testbool5"], 0)
             self.assertEqual(row["testbool6"], 0)
             self.assertEqual(row["testbool7"], 0)
             self.assertEqual(row["testbool8"], 0)
             self.assertEqual(row["NAME"], "test")
 
+    def test_db_creation_vars_with_whitespace(self) -> None:
+        test_array = bytearray(_bytearray * 1)
+        test_spec = """
+        50      testZeroSpaces    BYTE
+        52      testOne Space    BYTE
+        59      testTWo  Spaces   BYTE
+"""
+
+        test_db = DB(1, test_array, test_spec, row_size=len(_bytearray), size=1, layout_offset=0, db_offset=0)
+        db_export = test_db.export()
+        for i in db_export:
+            self.assertTrue("testZeroSpaces" in db_export[i].keys())
+            self.assertTrue("testOne Space" in db_export[i].keys())
+            self.assertTrue("testTWo  Spaces" in db_export[i].keys())
+
     def test_db_export(self) -> None:
         test_array = bytearray(_bytearray * 10)
         test_db = DB(1, test_array, test_spec, row_size=len(_bytearray), size=10, layout_offset=4, db_offset=0)