Remove datastore/database (#1436)

Author: janiversen

API_changes.rst

@@ -7,6 +7,7 @@ Version 3.3.0
 -------------
 - Clients have an optional parameter: on_reconnect_callback, Function that will be called just before a reconnection attempt.
 - general parameter unit= -> slave=
+- move SqlSlaveContext, RedisSlaveContext to examples/contrib (due to lack of maintenance)
 
 -------------
 Version 3.2.0

README.rst

@@ -70,7 +70,7 @@ Server Features
   * TCP, RTU-OVER-TCP, UDP, TLS, Serial ASCII, Serial RTU, and Serial Binary
   * asynchronous and synchronous versions
   * Full server control context (device information, counters, etc)
-  * A number of backend contexts (database, redis, sqlite, a slave device) as datastore
+  * A number of backend contexts as datastore
 
 ^^^^^^^^^^^
 Use Cases
@@ -179,8 +179,6 @@ Available options are:
 
 - **serial**, installs serial drivers.
 
-- **datastore**, installs databases (SQLAlchemy and Redis) for datastore.
-
 - **documentation**, installs tools to generate documentation.
 
 - **development**, installs development tools needed to enable test/check of pymodbus changes.

doc/source/examples.rst

@@ -53,10 +53,17 @@ Examples contributions
 These examples are supplied by users of pymodbus.
 The pymodbus team thanks for sharing the examples.
 
+Redis datastore example
+^^^^^^^^^^^^^^^^^^^^^^^^
+.. literalinclude:: ../../examples/contrib/redis_datastore.py
+
 Serial Forwarder example
 ^^^^^^^^^^^^^^^^^^^^^^^^
 .. literalinclude:: ../../examples/contrib/serial_forwarder.py
 
+Sqlalchemy datastore example
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+.. literalinclude:: ../../examples/contrib/sql_datastore.py
 
 
 Examples version 2.5.3

doc/source/library/datastore.rst

@@ -22,13 +22,3 @@ Datastore classes
 .. autoclass:: pymodbus.datastore.ModbusSimulatorContext
     :members:
     :member-order: bysource
-
-.. autoclass:: pymodbus.datastore.RedisSlaveContext
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-.. autoclass:: pymodbus.datastore.SqlSlaveContext
-    :members:
-    :undoc-members:
-    :show-inheritance:

…us/datastore/database/redis_datastore.py examples/contrib/redis_datastore.pypymodbus/datastore/database/redis_datastore.py renamed to examples/contrib/redis_datastore.py pymodbus/datastore/database/redis_datastore.py renamed to examples/contrib/redis_datastore.py

@@ -193,7 +193,7 @@ def __init__(self, factory, *args, **kwargs):
 # An example line reader, this can replace with:
 # - the TCP protocol
 # - a context recorder
-# - a database or file recorder
+# - a any recorder
 # --------------------------------------------------------------------------- #
 class LoggingContextReader:
     """Logging context reader."""

…dbus/datastore/database/sql_datastore.py examples/contrib/sql_datastore.pypymodbus/datastore/database/sql_datastore.py renamed to examples/contrib/sql_datastore.py pymodbus/datastore/database/sql_datastore.py renamed to examples/contrib/sql_datastore.py

@@ -4,8 +4,6 @@
     ModbusServerContext,
     ModbusSlaveContext,
 )
-from pymodbus.datastore.database.redis_datastore import RedisSlaveContext
-from pymodbus.datastore.database.sql_datastore import SqlSlaveContext
 from pymodbus.datastore.simulator import ModbusSimulatorContext
 from pymodbus.datastore.store import (
     ModbusSequentialDataBlock,
@@ -23,6 +21,4 @@
     "ModbusSlaveContext",
     "ModbusServerContext",
     "ModbusSimulatorContext",
-    "RedisSlaveContext",
-    "SqlSlaveContext",
 ]

examples/v2.5.3/modbus_scraper.py

@@ -33,10 +33,6 @@ click>=8.0.0
 # install:serial
 pyserial>=3.5
 
-# install:datastore
-redis>=2.10.6
-sqlalchemy>=1.1.15
-
 
 # -------------------------------------------------------------------
 # documentation, everything needed to generate documentation.
@@ -69,6 +65,5 @@ pytest-asyncio==0.20.3
 pytest-cov==4.0.0
 pytest-timeout==2.1.0
 pytest-xdist==3.1.0
-types-redis
 types-Pygments
 types-pyserial