Clean __init_ and update log module. (#1411)

janiversen · web-flow · commit 1b241acd91bb · 2023-03-07T15:37:48.000+01:00
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
@@ -28,8 +28,7 @@ Before opening a new issue, make sure you do the following:
 # code and logs here.
 
 # please use the following to format logs when posting them here
-import logging
 import pymodbus
 
-pymodbus.pymodbus_apply_logging_config(logging.DEBUG)
+pymodbus.pymodbus_apply_logging_config()
 ```
diff --git a/API_changes.rst b/API_changes.rst
@@ -5,6 +5,9 @@ PyModbus - API changes.
 -------------
 Version 3.2.0
 -------------
+- import pymodbus.version -> from pymodbus import __version__, __version_full__
+- pymodbus.pymodbus_apply_logging_config(log_file_name="pymodbus.log") to enable file pymodbus_apply_logging_config
+- pymodbus.pymodbus_apply_logging_config have default DEBUG, it not called root settings will be used.
 - pymodbus/interfaces/IModbusDecoder removed.
 - pymodbus/interfaces/IModbusFramer removed.
 - pymodbus/interfaces/IModbusSlaveContext -> pymodbus/datastore/ModbusBaseSlaveContext.
diff --git a/doc/conf.py b/doc/conf.py
@@ -11,7 +11,7 @@
 
 from recommonmark.transform import AutoStructify
 
-from pymodbus import __version__
+from pymodbus import __version__ as pymodbus_version
 
 
 parent_dir = os.path.abspath(os.pardir)
@@ -26,8 +26,8 @@
 project = "PyModbus"
 copyright = "See license"
 author = "Open Source volunteers"
-version = __version__
-release = __version__
+version = pymodbus_version
+release = pymodbus_version
 language = "en"
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 pygments_style = "sphinx"
diff --git a/doc/source/library/pymodbus.rst b/doc/source/library/pymodbus.rst
@@ -87,8 +87,3 @@ Extra functions
     :members:
     :undoc-members:
     :show-inheritance:
-
-.. automodule:: pymodbus.version
-    :members:
-    :undoc-members:
-    :show-inheritance:
diff --git a/examples/server_async.py b/examples/server_async.py
@@ -32,6 +32,7 @@
 import os
 
 from examples.helper import get_commandline
+from pymodbus import __version__ as pymodbus_version
 from pymodbus.datastore import (
     ModbusSequentialDataBlock,
     ModbusServerContext,
@@ -49,7 +50,6 @@
     StartAsyncTlsServer,
     StartAsyncUdpServer,
 )
-from pymodbus.version import version
 
 
 _logger = logging.getLogger()
@@ -130,7 +130,7 @@ def setup_server(args):
             "VendorUrl": "https://github.com/pymodbus-dev/pymodbus/",
             "ProductName": "Pymodbus Server",
             "ModelName": "Pymodbus Server",
-            "MajorMinorRevision": version.short(),
+            "MajorMinorRevision": pymodbus_version,
         }
     )
     return args
diff --git a/examples/v2.5.3/callback_server.py b/examples/v2.5.3/callback_server.py
@@ -10,6 +10,10 @@
 from multiprocessing import Queue
 from threading import Thread
 
+# --------------------------------------------------------------------------- #
+# import the modbus libraries we need
+# --------------------------------------------------------------------------- #
+from pymodbus import __version__ as pymodbus_version
 from pymodbus.datastore import (
     ModbusServerContext,
     ModbusSlaveContext,
@@ -18,11 +22,6 @@
 from pymodbus.device import ModbusDeviceIdentification
 from pymodbus.server import StartTcpServer
 
-# --------------------------------------------------------------------------- #
-# import the modbus libraries we need
-# --------------------------------------------------------------------------- #
-from pymodbus.version import version
-
 
 # from pymodbus.transaction import ModbusRtuFramer, ModbusAsciiFramer
 
@@ -137,7 +136,7 @@ def run_callback_server():
             "VendorUrl": "https://github.com/pymodbus-dev/pymodbus/",
             "ProductName": "pymodbus Server",
             "ModelName": "pymodbus Server",
-            "MajorMinorRevision": version.short(),
+            "MajorMinorRevision": pymodbus_version,
         }
     )
 
diff --git a/examples/v2.5.3/custom_datablock.py b/examples/v2.5.3/custom_datablock.py
@@ -7,6 +7,10 @@
 """
 import logging
 
+# --------------------------------------------------------------------------- #
+# import the modbus libraries we need
+# --------------------------------------------------------------------------- #
+from pymodbus import __version__ as pymodbus_version
 from pymodbus.datastore import (
     ModbusServerContext,
     ModbusSlaveContext,
@@ -15,11 +19,6 @@
 from pymodbus.device import ModbusDeviceIdentification
 from pymodbus.server import StartTcpServer
 
-# --------------------------------------------------------------------------- #
-# import the modbus libraries we need
-# --------------------------------------------------------------------------- #
-from pymodbus.version import version
-
 
 # from pymodbus.transaction import ModbusRtuFramer, ModbusAsciiFramer
 
@@ -75,7 +74,7 @@ def run_custom_db_server():
             "VendorUrl": "https://github.com/pymodbus-dev/pymodbus/",
             "ProductName": "pymodbus Server",
             "ModelName": "pymodbus Server",
-            "MajorMinorRevision": version.short(),
+            "MajorMinorRevision": pymodbus_version,
         }
     )
 
diff --git a/examples/v2.5.3/custom_synchronous_server.py b/examples/v2.5.3/custom_synchronous_server.py
@@ -57,14 +57,14 @@ def decode(self, data):
 """
 import logging
 
+from pymodbus import __version__ as pymodbus_version
 from pymodbus.datastore import (
     ModbusSequentialDataBlock,
     ModbusServerContext,
     ModbusSlaveContext,
 )
 from pymodbus.device import ModbusDeviceIdentification
 from pymodbus.server import StartTcpServer
-from pymodbus.version import version
 
 from .custom_message import (  # pylint: disable=relative-beyond-top-level
     CustomModbusRequest,
@@ -112,7 +112,7 @@ def run_server():
             "VendorUrl": "https://github.com/pymodbus-dev/pymodbus/",
             "ProductName": "Pymodbus Server",
             "ModelName": "Pymodbus Server",
-            "MajorMinorRevision": version.short(),
+            "MajorMinorRevision": pymodbus_version,
         }
     )
 
diff --git a/examples/v2.5.3/dbstore_update_server.py b/examples/v2.5.3/dbstore_update_server.py
@@ -17,16 +17,15 @@
 import logging
 import random
 
+# --------------------------------------------------------------------------- #
+# import the modbus libraries we need
+# --------------------------------------------------------------------------- #
+from pymodbus import __version__ as pymodbus_version
 from pymodbus.datastore import ModbusSequentialDataBlock, ModbusServerContext
 from pymodbus.datastore.database import SqlSlaveContext
 from pymodbus.device import ModbusDeviceIdentification
 from pymodbus.server import StartAsyncTcpServer
 
-# --------------------------------------------------------------------------- #
-# import the modbus libraries we need
-# --------------------------------------------------------------------------- #
-from pymodbus.version import version
-
 
 # from pymodbus.transaction import ModbusRtuFramer, ModbusAsciiFramer
 
@@ -89,7 +88,7 @@ async def run_dbstore_update_server():
             "VendorUrl": "https://github.com/pymodbus-dev/pymodbus/",
             "ProductName": "pymodbus Server",
             "ModelName": "pymodbus Server",
-            "MajorMinorRevision": version.short(),
+            "MajorMinorRevision": pymodbus_version,
         }
     )
 
diff --git a/examples/v2.5.3/deviceinfo_showcase_server.py b/examples/v2.5.3/deviceinfo_showcase_server.py
@@ -19,11 +19,6 @@
 from pymodbus.device import ModbusDeviceIdentification
 from pymodbus.server import StartTcpServer
 
-# --------------------------------------------------------------------------- #
-# import the various server implementations
-# --------------------------------------------------------------------------- #
-from pymodbus.version import version
-
 
 # --------------------------------------------------------------------------- #
 # configure the service logging
@@ -57,7 +52,7 @@ def run_server():
             "VendorUrl": "https://github.com/pymodbus-dev/pymodbus/",
             "ProductName": "Pymodbus Server",
             "ModelName": "Pymodbus Server",
-            "MajorMinorRevision": version.short(),
+            "MajorMinorRevision": pymodbus_version,
         }
     )
 
diff --git a/examples/v2.5.3/tornado_twisted/asynchronous_server.py b/examples/v2.5.3/tornado_twisted/asynchronous_server.py
@@ -12,6 +12,7 @@
 
 from custom_message import CustomModbusRequest
 
+from pymodbus import __version__ as pymodbus_version
 from pymodbus.datastore import (
     ModbusSequentialDataBlock,
     ModbusServerContext,
@@ -21,8 +22,7 @@
 # from pymodbus.server.asynchronous import StartUdpServer
 # from pymodbus.server.asynchronous import StartSerialServer
 from pymodbus.device import ModbusDeviceIdentification
-from pymodbus.server.asynchronous import StartTcpServer
-from pymodbus.version import version
+from pymodbus.server import StartTcpServer
 
 
 # from pymodbus.transaction import (
@@ -121,7 +121,7 @@ def run_async_server():
         info_name={
             "VendorName": "Pymodbus",
             "ModelName": "Pymodbus Server",
-            "MajorMinorRevision": version.short(),
+            "MajorMinorRevision": pymodbus_version,
             "ProductCode": "PM",
             "VendorUrl": "https://github.com/pymodbus-dev/pymodbus/",
             "ProductName": "Pymodbus Server",
diff --git a/pymodbus/__init__.py b/pymodbus/__init__.py
@@ -3,20 +3,19 @@
 Released under the the BSD license
 """
 
-from logging import WARNING
+from pymodbus.logging import pymodbus_apply_logging_config
+from pymodbus.version import version
 
-import pymodbus.version as __version
-from pymodbus.logging import Log
 
+__version__ = version.short()
+__version_full__ = str(version)
 
-__version__ = __version.version.short()
-__author__ = "Galen Collins, Jan Iversen"
-__maintainer__ = "dhoomakethu, janiversen"
+# --------------------------------------------------------------------------- #
+# Exported symbols
+# --------------------------------------------------------------------------- #
 
-
-def pymodbus_apply_logging_config(level=WARNING):
-    """Apply basic logging configuration used by default by Pymodbus maintainers.
-
-    Please call this function to format logging appropriately when opening issues.
-    """
-    Log.apply_logging_config(level)
+__all__ = [
+    "pymodbus_apply_logging_config",
+    "__version__",
+    "__version_full__",
+]
diff --git a/pymodbus/logging.py b/pymodbus/logging.py
@@ -2,10 +2,10 @@
 
 Released under the the BSD license
 """
-
 import logging
 from binascii import b2a_hex
 from logging import NullHandler as __null
+from typing import Union
 
 from pymodbus.utilities import hexlify_packets
 
@@ -16,30 +16,50 @@
 logging.getLogger(__name__).addHandler(__null())
 
 
+def pymodbus_apply_logging_config(
+    level: Union[str, int] = logging.DEBUG, log_file_name: str = None
+):
+    """Apply basic logging configuration used by default by Pymodbus maintainers.
+
+    :param level: (optional) set log level, if not set it is inherited.
+    :param log_file_name: (optional) log additional to file
+
+    Please call this function to format logging appropriately when opening issues.
+    """
+    Log.apply_logging_config(level, log_file_name)
+
+
 class Log:
     """Class to hide logging complexity.
 
     :meta private:
     """
 
-    CRITICAL = logging.CRITICAL
-    ERROR = logging.ERROR
-    WARNING = logging.WARNING
-    DEBUG = logging.DEBUG
-    INFO = logging.INFO
-
-    LOG_LEVEL = logging.WARNING
+    LOG_LEVEL = logging.NOTSET
     _logger = logging.getLogger(__name__)
 
     @classmethod
-    def apply_logging_config(cls, level=logging.WARNING):
+    def apply_logging_config(cls, level, log_file_name):
         """Apply basic logging configuration"""
-        logging.basicConfig(
-            format="%(asctime)s %(levelname)-5s %(module)s:%(lineno)s %(message)s",
-            datefmt="%H:%M:%S",
+        if level == logging.NOTSET:
+            level = cls._logger.getEffectiveLevel()
+        log_stream_handler = logging.StreamHandler()
+        log_formatter = logging.Formatter(
+            "%(asctime)s %(levelname)-5s %(module)s:%(lineno)s %(message)s"
         )
+        log_stream_handler.setFormatter(log_formatter)
+        cls._logger.addHandler(log_stream_handler)
+        if log_file_name:
+            log_file_handler = logging.FileHandler(log_file_name)
+            log_file_handler.setFormatter(log_formatter)
+            cls._logger.addHandler(log_file_handler)
+        cls.setLevel(level)
+
+    @classmethod
+    def setLevel(cls, level):
+        """Apply basic logging level"""
         cls._logger.setLevel(level)
-        cls.LOG_LEVEL = cls._logger.getEffectiveLevel()
+        cls.LOG_LEVEL = level
 
     @classmethod
     def build_msg(cls, txt, *args):
@@ -70,29 +90,39 @@ def build_msg(cls, txt, *args):
     @classmethod
     def info(cls, txt, *args):
         """Log info messagees."""
+        if cls.LOG_LEVEL == logging.NOTSET:
+            cls.LOG_LEVEL = cls._logger.getEffectiveLevel()
         if logging.INFO >= cls.LOG_LEVEL:
             cls._logger.info(cls.build_msg(txt, *args))
 
     @classmethod
     def debug(cls, txt, *args):
         """Log debug messagees."""
+        if cls.LOG_LEVEL == logging.NOTSET:
+            cls.LOG_LEVEL = cls._logger.getEffectiveLevel()
         if logging.DEBUG >= cls.LOG_LEVEL:
             cls._logger.debug(cls.build_msg(txt, *args))
 
     @classmethod
     def warning(cls, txt, *args):
         """Log warning messagees."""
+        if cls.LOG_LEVEL == logging.NOTSET:
+            cls.LOG_LEVEL = cls._logger.getEffectiveLevel()
         if logging.WARNING >= cls.LOG_LEVEL:
             cls._logger.warning(cls.build_msg(txt, *args))
 
     @classmethod
     def error(cls, txt, *args):
         """Log error messagees."""
+        if cls.LOG_LEVEL == logging.NOTSET:
+            cls.LOG_LEVEL = cls._logger.getEffectiveLevel()
         if logging.ERROR >= cls.LOG_LEVEL:
             cls._logger.error(cls.build_msg(txt, *args))
 
     @classmethod
     def critical(cls, txt, *args):
         """Log critical messagees."""
+        if cls.LOG_LEVEL == logging.NOTSET:
+            cls.LOG_LEVEL = cls._logger.getEffectiveLevel()
         if logging.CRITICAL >= cls.LOG_LEVEL:
             cls._logger.critical(cls.build_msg(txt, *args))
diff --git a/pymodbus/repl/client/main.py b/pymodbus/repl/client/main.py
diff --git a/pymodbus/repl/server/main.py b/pymodbus/repl/server/main.py
diff --git a/pymodbus/server/reactive/main.py b/pymodbus/server/reactive/main.py
diff --git a/pymodbus/version.py b/pymodbus/version.py
diff --git a/test/test_logging.py b/test/test_logging.py
diff --git a/test/test_version.py b/test/test_version.py
