✨ Logging: Added file support (Fixes #182)

- Added `VIDGEAR_LOGFILE` environment variable to manually add file/dir path.
- Reworked `logger_handler()` Helper methods (in asyncio too).
- Added new formatter and Filehandler for handling logger files.
- Added auto version extraction from package `version.py` in setup.py.

setup.py

@@ -22,6 +22,7 @@
 import setuptools
 
 from pkg_resources import parse_version
+from distutils.util import convert_path
 from setuptools import setup
 
 
@@ -47,6 +48,11 @@ def test_opencv():
     return False
 
 
+pkg_version = {}
+ver_path = convert_path("vidgear/version.py")
+with open(ver_path) as ver_file:
+    exec(ver_file.read(), pkg_version)
+
 with open("README.md", "r", encoding="utf-8") as fh:
     long_description = fh.read()
     long_description = long_description.replace(  # patch for images
@@ -59,7 +65,7 @@ def test_opencv():
 setup(
     name="vidgear",
     packages=["vidgear", "vidgear.gears", "vidgear.gears.asyncio"],
-    version="0.2.0-dev3",
+    version=pkg_version["__version__"],
     description="High-performance cross-platform Video Processing Python framework powerpacked with unique trailblazing features.",
     license="Apache License 2.0",
     author="Abhishek Thakur",

vidgear/gears/asyncio/helper.py

@@ -58,8 +58,23 @@ def logger_handler():
             "CRITICAL": "bold_red,bg_white",
         },
     )
+    # check if VIDGEAR_LOGFILE defined
+    file_mode = os.environ.get("VIDGEAR_LOGFILE", False)
     # define handler
     handler = log.StreamHandler()
+    if file_mode and isinstance(file_mode, str):
+        file_path = os.path.abspath(file_mode)
+        if (os.name == "nt" or os.access in os.supports_effective_ids) and os.access(
+            os.path.dirname(file_path), os.W_OK
+        ):
+            file_path = (
+                os.path.join(file_path, "log.txt")
+                if os.path.isdir(file_path)
+                else file_path
+            )
+            handler = log.FileHandler(file_path, mode="a")
+            formatter = log.Formatter("%(name)s :: %(levelname)s :: %(message)s")
+
     handler.setFormatter(formatter)
     return handler
 

vidgear/gears/helper.py

@@ -70,8 +70,23 @@ def logger_handler():
             "CRITICAL": "bold_red,bg_white",
         },
     )
+    # check if VIDGEAR_LOGFILE defined
+    file_mode = os.environ.get("VIDGEAR_LOGFILE", False)
     # define handler
     handler = log.StreamHandler()
+    if file_mode and isinstance(file_mode, str):
+        file_path = os.path.abspath(file_mode)
+        if (os.name == "nt" or os.access in os.supports_effective_ids) and os.access(
+            os.path.dirname(file_path), os.W_OK
+        ):
+            file_path = (
+                os.path.join(file_path, "log.txt")
+                if os.path.isdir(file_path)
+                else file_path
+            )
+            handler = log.FileHandler(file_path, mode="a")
+            formatter = log.Formatter("%(name)s :: %(levelname)s :: %(message)s")
+
     handler.setFormatter(formatter)
     return handler
 

vidgear/version.py

@@ -1 +1 @@
-__version__ = "0.2.0-dev3"
+__version__ = "0.2.0-dev5"