snap7-optimized 3.0.0__tar.gz

snap7_optimized-3.0.0/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Gijs Molenaar, Stephan Preeker
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

snap7_optimized-3.0.0/MANIFEST.in

@@ -0,0 +1 @@
+include README.rst

snap7_optimized-3.0.0/PKG-INFO

@@ -0,0 +1,104 @@
+Metadata-Version: 2.4
+Name: snap7-optimized
+Version: 3.0.0
+Summary: Pure Python S7 communication library for Siemens PLCs with read optimization pipeline
+Author-email: Gijs Molenaar <gijsmolenaar@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/QuakeString/python-snap7-optimized
+Project-URL: Documentation, https://python-snap7.readthedocs.io/en/latest/
+Keywords: snap7,s7,siemens,plc
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Topic :: System :: Hardware
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Manufacturing
+Classifier: Operating System :: POSIX
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.10
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: pytest-html; extra == "test"
+Requires-Dist: mypy; extra == "test"
+Requires-Dist: types-setuptools; extra == "test"
+Requires-Dist: ruff; extra == "test"
+Requires-Dist: tox; extra == "test"
+Requires-Dist: tox-uv; 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"
+Dynamic: license-file
+
+About
+=====
+
+Python-snap7 is a pure Python S7 communication library for interfacing with Siemens S7 PLCs.
+
+Python-snap7 is tested with Python 3.10+, on Windows, Linux and OS X.
+
+The full documentation is available on `Read The Docs <https://python-snap7.readthedocs.io/en/latest/>`_.
+
+
+Version 3.0 - Breaking Changes
+===============================
+
+Version 3.0 is a major release that rewrites python-snap7 as a pure Python
+implementation. The C snap7 library is no longer required.
+
+This release may contain breaking changes. If you experience issues, you can
+pin to the last pre-3.0 release::
+
+    $ pip install "python-snap7<3"
+
+The latest stable pre-3.0 release is version 2.1.0.
+
+
+Fork: Optimized Multi-Read Pipeline
+=====================================
+
+This fork (`python-snap7-optimized <https://github.com/QuakeString/python-snap7-optimized>`_)
+adds a transparent **nodeS7-style read optimization pipeline** to the upstream
+`python-snap7 <https://github.com/gijzelaerr/python-snap7>`_ library.
+
+When ``read_multi_vars()`` is called with multiple items targeting standard memory
+areas (DB, M, I, Q), the library now automatically:
+
+1. **Sorts** requests by area, DB number, and byte offset.
+2. **Merges** adjacent or nearby requests (gap ≤ 5 bytes) into contiguous blocks,
+   eliminating redundant reads of overlapping or neighboring addresses.
+3. **Packetizes** merged blocks into minimal S7 PDU-sized packets, respecting both
+   request and reply budget limits.
+
+The result is dramatically fewer network round-trips — hundreds of scattered variable
+reads can collapse into just a few multi-item S7 protocol exchanges.
+
+**No API changes required.** Existing code using ``read_multi_vars()`` benefits
+automatically. Counter/Timer areas (CT/TM) fall back to individual reads due to
+their different addressing semantics.
+
+New modules:
+
+- ``snap7/optimizer.py`` — Pure-logic 3-stage pipeline (sort → merge → packetize).
+- Extended ``snap7/s7protocol.py`` — Multi-item S7 read request building and response parsing.
+- Extended ``snap7/server/__init__.py`` — Server-side multi-item read support for testing.
+
+
+Installation
+============
+
+Install using pip::
+
+   $ pip install python-snap7
+
+No native libraries or platform-specific dependencies are required - python-snap7 is a pure Python package that works on all platforms.

snap7_optimized-3.0.0/README.rst

@@ -0,0 +1,62 @@
+About
+=====
+
+Python-snap7 is a pure Python S7 communication library for interfacing with Siemens S7 PLCs.
+
+Python-snap7 is tested with Python 3.10+, on Windows, Linux and OS X.
+
+The full documentation is available on `Read The Docs <https://python-snap7.readthedocs.io/en/latest/>`_.
+
+
+Version 3.0 - Breaking Changes
+===============================
+
+Version 3.0 is a major release that rewrites python-snap7 as a pure Python
+implementation. The C snap7 library is no longer required.
+
+This release may contain breaking changes. If you experience issues, you can
+pin to the last pre-3.0 release::
+
+    $ pip install "python-snap7<3"
+
+The latest stable pre-3.0 release is version 2.1.0.
+
+
+Fork: Optimized Multi-Read Pipeline
+=====================================
+
+This fork (`python-snap7-optimized <https://github.com/QuakeString/python-snap7-optimized>`_)
+adds a transparent **nodeS7-style read optimization pipeline** to the upstream
+`python-snap7 <https://github.com/gijzelaerr/python-snap7>`_ library.
+
+When ``read_multi_vars()`` is called with multiple items targeting standard memory
+areas (DB, M, I, Q), the library now automatically:
+
+1. **Sorts** requests by area, DB number, and byte offset.
+2. **Merges** adjacent or nearby requests (gap ≤ 5 bytes) into contiguous blocks,
+   eliminating redundant reads of overlapping or neighboring addresses.
+3. **Packetizes** merged blocks into minimal S7 PDU-sized packets, respecting both
+   request and reply budget limits.
+
+The result is dramatically fewer network round-trips — hundreds of scattered variable
+reads can collapse into just a few multi-item S7 protocol exchanges.
+
+**No API changes required.** Existing code using ``read_multi_vars()`` benefits
+automatically. Counter/Timer areas (CT/TM) fall back to individual reads due to
+their different addressing semantics.
+
+New modules:
+
+- ``snap7/optimizer.py`` — Pure-logic 3-stage pipeline (sort → merge → packetize).
+- Extended ``snap7/s7protocol.py`` — Multi-item S7 read request building and response parsing.
+- Extended ``snap7/server/__init__.py`` — Server-side multi-item read support for testing.
+
+
+Installation
+============
+
+Install using pip::
+
+   $ pip install python-snap7
+
+No native libraries or platform-specific dependencies are required - python-snap7 is a pure Python package that works on all platforms.

snap7_optimized-3.0.0/pyproject.toml

@@ -0,0 +1,74 @@
+[build-system]
+requires = ["setuptools>=68.0.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "snap7-optimized"
+version = "3.0.0"
+description = "Pure Python S7 communication library for Siemens PLCs with read optimization pipeline"
+readme = "README.rst"
+authors = [
+    {name = "Gijs Molenaar", email = "gijsmolenaar@gmail.com"},
+]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: Console",
+    "Topic :: System :: Hardware",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Manufacturing",
+    "Operating System :: POSIX",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+]
+license = {text = "MIT"}
+requires-python = ">=3.10"
+keywords = ["snap7", "s7", "siemens", "plc"]
+
+[project.urls]
+Homepage = "https://github.com/QuakeString/python-snap7-optimized"
+Documentation = "https://python-snap7.readthedocs.io/en/latest/"
+
+[project.optional-dependencies]
+test = ["pytest", "pytest-cov", "pytest-html", "mypy", "types-setuptools", "ruff", "tox", "tox-uv", "types-click", "uv"]
+cli = ["rich", "click" ]
+doc = ["sphinx", "sphinx_rtd_theme"]
+
+[tool.setuptools.package-data]
+snap7 = ["py.typed"]
+
+[tool.setuptools.packages.find]
+include = ["snap7*"]
+
+[project.scripts]
+snap7-server = "snap7.server:mainloop"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+markers =[
+    "client",
+    "common",
+    "e2e: end-to-end tests requiring a real PLC connection",
+    "logo",
+    "mainloop",
+    "partner",
+    "server",
+    "util"
+    ]
+
+[tool.mypy]
+ignore_missing_imports = true
+strict = true
+# https://github.com/python/mypy/issues/2427#issuecomment-1419206807
+disable_error_code = ["method-assign", "attr-defined"]
+
+[tool.ruff]
+output-format = "full"
+line-length = 130
+target-version = "py310"
+
+[tool.ruff.lint]
+ignore = []
+mccabe.max-complexity = 10

snap7_optimized-3.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

snap7_optimized-3.0.0/snap7/__init__.py

@@ -0,0 +1,34 @@
+"""
+The Snap7 Python library.
+
+Pure Python implementation of the S7 protocol for communicating with
+Siemens S7 PLCs without requiring the native Snap7 C library.
+"""
+
+from importlib.metadata import version, PackageNotFoundError
+
+from .client import Client
+from .server import Server
+from .partner import Partner
+from .logo import Logo
+from .util.db import Row, DB
+from .type import Area, Block, WordLen, SrvEvent, SrvArea
+
+__all__ = [
+    "Client",
+    "Server",
+    "Partner",
+    "Logo",
+    "Row",
+    "DB",
+    "Area",
+    "Block",
+    "WordLen",
+    "SrvEvent",
+    "SrvArea",
+]
+
+try:
+    __version__ = version("python-snap7")
+except PackageNotFoundError:
+    __version__ = "0.0rc0"