Merge pull request #1177 from serengil/feat-task-0804-singleton-logger

singleton logger and docstrings

Author: serengil

deepface/DeepFace.py

@@ -17,7 +17,7 @@
 
 # package dependencies
 from deepface.commons import package_utils, folder_utils
-from deepface.commons.logger import Logger
+from deepface.commons import logger as log
 from deepface.modules import (
     modeling,
     representation,
@@ -29,7 +29,7 @@
 )
 from deepface import __version__
 
-logger = Logger(module="DeepFace")
+logger = log.get_singletonish_logger()
 
 # -----------------------------------
 # configurations for dependencies
@@ -88,7 +88,7 @@ def verify(
             OpenFace, DeepFace, DeepID, Dlib, ArcFace, SFace and GhostFaceNet (default is VGG-Face).
 
         detector_backend (string): face detector backend. Options: 'opencv', 'retinaface',
-            'mtcnn', 'ssd', 'dlib', 'mediapipe', 'yolov8' (default is opencv).
+            'mtcnn', 'ssd', 'dlib', 'mediapipe', 'yolov8' or 'skip' (default is opencv).
 
         distance_metric (string): Metric for measuring similarity. Options: 'cosine',
             'euclidean', 'euclidean_l2' (default is cosine).
@@ -168,7 +168,7 @@ def analyze(
             Set to False to avoid the exception for low-resolution images (default is True).
 
         detector_backend (string): face detector backend. Options: 'opencv', 'retinaface',
-            'mtcnn', 'ssd', 'dlib', 'mediapipe', 'yolov8' (default is opencv).
+            'mtcnn', 'ssd', 'dlib', 'mediapipe', 'yolov8' or 'skip' (default is opencv).
 
         distance_metric (string): Metric for measuring similarity. Options: 'cosine',
             'euclidean', 'euclidean_l2' (default is cosine).
@@ -272,7 +272,7 @@ def find(
             Set to False to avoid the exception for low-resolution images (default is True).
 
         detector_backend (string): face detector backend. Options: 'opencv', 'retinaface',
-            'mtcnn', 'ssd', 'dlib', 'mediapipe', 'yolov8' (default is opencv).
+            'mtcnn', 'ssd', 'dlib', 'mediapipe', 'yolov8' or 'skip' (default is opencv).
 
         align (boolean): Perform alignment based on the eye positions (default is True).
 
@@ -348,7 +348,7 @@ def represent(
             (default is True).
 
         detector_backend (string): face detector backend. Options: 'opencv', 'retinaface',
-            'mtcnn', 'ssd', 'dlib', 'mediapipe', 'yolov8' (default is opencv).
+            'mtcnn', 'ssd', 'dlib', 'mediapipe', 'yolov8' or 'skip' (default is opencv).
 
         align (boolean): Perform alignment based on the eye positions (default is True).
 
@@ -406,7 +406,7 @@ def stream(
             OpenFace, DeepFace, DeepID, Dlib, ArcFace, SFace and GhostFaceNet (default is VGG-Face).
 
         detector_backend (string): face detector backend. Options: 'opencv', 'retinaface',
-            'mtcnn', 'ssd', 'dlib', 'mediapipe', 'yolov8' (default is opencv).
+            'mtcnn', 'ssd', 'dlib', 'mediapipe', 'yolov8' or 'skip' (default is opencv).
 
         distance_metric (string): Metric for measuring similarity. Options: 'cosine',
             'euclidean', 'euclidean_l2' (default is cosine).
@@ -454,7 +454,7 @@ def extract_faces(
             as a string, numpy array (BGR), or base64 encoded images.
 
         detector_backend (string): face detector backend. Options: 'opencv', 'retinaface',
-            'mtcnn', 'ssd', 'dlib', 'mediapipe', 'yolov8' (default is opencv).
+            'mtcnn', 'ssd', 'dlib', 'mediapipe', 'yolov8' or 'skip' (default is opencv).
 
         enforce_detection (boolean): If no face is detected in an image, raise an exception.
             Set to False to avoid the exception for low-resolution images (default is True).
@@ -520,7 +520,7 @@ def detectFace(
             added to resize the image (default is (224, 224)).
 
         detector_backend (string): face detector backend. Options: 'opencv', 'retinaface',
-            'mtcnn', 'ssd', 'dlib', 'mediapipe', 'yolov8' (default is opencv).
+            'mtcnn', 'ssd', 'dlib', 'mediapipe', 'yolov8' or 'skip' (default is opencv).
 
         enforce_detection (boolean): If no face is detected in an image, raise an exception.
             Set to False to avoid the exception for low-resolution images (default is True).

deepface/api/src/modules/core/routes.py

@@ -1,8 +1,8 @@
 from flask import Blueprint, request
 from deepface.api.src.modules.core import service
-from deepface.commons.logger import Logger
+from deepface.commons import logger as log
 
-logger = Logger(module="api/src/routes.py")
+logger = log.get_singletonish_logger()
 
 blueprint = Blueprint("routes", __name__)
 

deepface/basemodels/ArcFace.py

@@ -1,10 +1,11 @@
 import os
 import gdown
 from deepface.commons import package_utils, folder_utils
-from deepface.commons.logger import Logger
 from deepface.models.FacialRecognition import FacialRecognition
 
-logger = Logger(module="basemodels.ArcFace")
+from deepface.commons import logger as log
+
+logger = log.get_singletonish_logger()
 
 # pylint: disable=unsubscriptable-object
 

deepface/basemodels/DeepID.py

@@ -1,10 +1,10 @@
 import os
 import gdown
 from deepface.commons import package_utils, folder_utils
-from deepface.commons.logger import Logger
 from deepface.models.FacialRecognition import FacialRecognition
+from deepface.commons import logger as log
 
-logger = Logger(module="basemodels.DeepID")
+logger = log.get_singletonish_logger()
 
 tf_version = package_utils.get_tf_major_version()
 

deepface/basemodels/Dlib.py

@@ -4,10 +4,10 @@
 import gdown
 import numpy as np
 from deepface.commons import folder_utils
-from deepface.commons.logger import Logger
 from deepface.models.FacialRecognition import FacialRecognition
+from deepface.commons import logger as log
 
-logger = Logger(module="basemodels.DlibResNet")
+logger = log.get_singletonish_logger()
 
 # pylint: disable=too-few-public-methods
 

deepface/basemodels/Facenet.py

@@ -1,10 +1,10 @@
 import os
 import gdown
 from deepface.commons import package_utils, folder_utils
-from deepface.commons.logger import Logger
 from deepface.models.FacialRecognition import FacialRecognition
+from deepface.commons import logger as log
 
-logger = Logger(module="basemodels.Facenet")
+logger = log.get_singletonish_logger()
 
 # --------------------------------
 # dependency configuration

deepface/basemodels/FbDeepFace.py

@@ -2,10 +2,10 @@
 import zipfile
 import gdown
 from deepface.commons import package_utils, folder_utils
-from deepface.commons.logger import Logger
 from deepface.models.FacialRecognition import FacialRecognition
+from deepface.commons import logger as log
 
-logger = Logger(module="basemodels.FbDeepFace")
+logger = log.get_singletonish_logger()
 
 # --------------------------------
 # dependency configuration

deepface/basemodels/GhostFaceNet.py

@@ -8,9 +8,9 @@
 # project dependencies
 from deepface.commons import package_utils, folder_utils
 from deepface.models.FacialRecognition import FacialRecognition
-from deepface.commons.logger import Logger
+from deepface.commons import logger as log
 
-logger = Logger(module="basemodels.GhostFaceNet")
+logger = log.get_singletonish_logger()
 
 tf_major = package_utils.get_tf_major_version()
 if tf_major == 1:

deepface/basemodels/OpenFace.py

@@ -2,10 +2,10 @@
 import gdown
 import tensorflow as tf
 from deepface.commons import package_utils, folder_utils
-from deepface.commons.logger import Logger
 from deepface.models.FacialRecognition import FacialRecognition
+from deepface.commons import logger as log
 
-logger = Logger(module="basemodels.OpenFace")
+logger = log.get_singletonish_logger()
 
 tf_version = package_utils.get_tf_major_version()
 if tf_version == 1:

deepface/basemodels/SFace.py

@@ -1,15 +1,18 @@
+# built-in dependencies
 import os
 from typing import Any, List
 
+# 3rd party dependencies
 import numpy as np
 import cv2 as cv
 import gdown
 
+# project dependencies
 from deepface.commons import folder_utils
-from deepface.commons.logger import Logger
 from deepface.models.FacialRecognition import FacialRecognition
+from deepface.commons import logger as log
 
-logger = Logger(module="basemodels.SFace")
+logger = log.get_singletonish_logger()
 
 # pylint: disable=line-too-long, too-few-public-methods
 

deepface/basemodels/VGGFace.py

@@ -5,9 +5,9 @@
 from deepface.commons import package_utils, folder_utils
 from deepface.modules import verification
 from deepface.models.FacialRecognition import FacialRecognition
-from deepface.commons.logger import Logger
+from deepface.commons import logger as log
 
-logger = Logger(module="basemodels.VGGFace")
+logger = log.get_singletonish_logger()
 
 # ---------------------------------------
 

deepface/commons/folder_utils.py

@@ -1,8 +1,8 @@
 import os
 from pathlib import Path
-from deepface.commons.logger import Logger
+from deepface.commons import logger as log
 
-logger = Logger(module="deepface/commons/folder_utils.py")
+logger = log.get_singletonish_logger()
 
 
 def initialize_folder() -> None:

deepface/commons/logger.py

@@ -39,3 +39,16 @@ def critical(self, message):
 
     def dump_log(self, message):
         print(f"{str(datetime.now())[2:-7]} - {message}")
+
+
+def get_singletonish_logger():
+    # singleton design pattern
+    global model_obj
+
+    if not "model_obj" in globals():
+        model_obj = {}
+
+    if "logger" not in model_obj.keys():
+        model_obj["logger"] = Logger(module="Singleton")
+
+    return model_obj["logger"]

deepface/commons/package_utils.py

@@ -6,9 +6,9 @@
 import tensorflow as tf
 
 # package dependencies
-from deepface.commons.logger import Logger
+from deepface.commons import logger as log
 
-logger = Logger(module="commons.package_utils")
+logger = log.get_singletonish_logger()
 
 
 def get_tf_major_version() -> int:

deepface/detectors/DetectorWrapper.py

@@ -13,9 +13,9 @@
     Yolo,
     YuNet,
 )
-from deepface.commons.logger import Logger
+from deepface.commons import logger as log
 
-logger = Logger(module="deepface/detectors/DetectorWrapper.py")
+logger = log.get_singletonish_logger()
 
 
 def build_model(detector_backend: str) -> Any:

deepface/detectors/Dlib.py

@@ -5,9 +5,9 @@
 import numpy as np
 from deepface.commons import folder_utils
 from deepface.models.Detector import Detector, FacialAreaRegion
-from deepface.commons.logger import Logger
+from deepface.commons import logger as log
 
-logger = Logger(module="detectors.DlibWrapper")
+logger = log.get_singletonish_logger()
 
 
 class DlibClient(Detector):

deepface/detectors/Ssd.py

@@ -7,9 +7,9 @@
 from deepface.detectors import OpenCv
 from deepface.commons import folder_utils
 from deepface.models.Detector import Detector, FacialAreaRegion
-from deepface.commons.logger import Logger
+from deepface.commons import logger as log
 
-logger = Logger(module="detectors.SsdWrapper")
+logger = log.get_singletonish_logger()
 
 # pylint: disable=line-too-long, c-extension-no-member
 

deepface/detectors/Yolo.py

@@ -4,9 +4,9 @@
 import gdown
 from deepface.models.Detector import Detector, FacialAreaRegion
 from deepface.commons import folder_utils
-from deepface.commons.logger import Logger
+from deepface.commons import logger as log
 
-logger = Logger()
+logger = log.get_singletonish_logger()
 
 # Model's weights paths
 PATH = "/.deepface/weights/yolov8n-face.pt"

deepface/detectors/YuNet.py

@@ -1,13 +1,18 @@
+# built-in dependencies
 import os
 from typing import Any, List
+
+# 3rd party dependencies
 import cv2
 import numpy as np
 import gdown
+
+# project dependencies
 from deepface.commons import folder_utils
 from deepface.models.Detector import Detector, FacialAreaRegion
-from deepface.commons.logger import Logger
+from deepface.commons import logger as log
 
-logger = Logger(module="detectors.YunetWrapper")
+logger = log.get_singletonish_logger()
 
 
 class YuNetClient(Detector):

deepface/extendedmodels/Age.py

@@ -3,10 +3,10 @@
 import numpy as np
 from deepface.basemodels import VGGFace
 from deepface.commons import package_utils, folder_utils
-from deepface.commons.logger import Logger
 from deepface.models.Demography import Demography
+from deepface.commons import logger as log
 
-logger = Logger(module="extendedmodels.Age")
+logger = log.get_singletonish_logger()
 
 # ----------------------------------------
 # dependency configurations

deepface/extendedmodels/Emotion.py

@@ -1,12 +1,17 @@
+# built-in dependencies
 import os
+
+# 3rd party dependencies
 import gdown
 import numpy as np
 import cv2
+
+# project dependencies
 from deepface.commons import package_utils, folder_utils
-from deepface.commons.logger import Logger
 from deepface.models.Demography import Demography
+from deepface.commons import logger as log
 
-logger = Logger(module="extendedmodels.Emotion")
+logger = log.get_singletonish_logger()
 
 # -------------------------------------------
 # pylint: disable=line-too-long

deepface/extendedmodels/Gender.py

@@ -1,12 +1,17 @@
+# built-in dependencies
 import os
+
+# 3rd party dependencies
 import gdown
 import numpy as np
+
+# project dependencies
 from deepface.basemodels import VGGFace
 from deepface.commons import package_utils, folder_utils
-from deepface.commons.logger import Logger
 from deepface.models.Demography import Demography
+from deepface.commons import logger as log
 
-logger = Logger(module="extendedmodels.Gender")
+logger = log.get_singletonish_logger()
 
 # -------------------------------------
 # pylint: disable=line-too-long

deepface/extendedmodels/Race.py

@@ -1,12 +1,17 @@
+# built-in dependencies
 import os
+
+# 3rd party dependencies
 import gdown
 import numpy as np
+
+# project dependencies
 from deepface.basemodels import VGGFace
 from deepface.commons import package_utils, folder_utils
-from deepface.commons.logger import Logger
 from deepface.models.Demography import Demography
+from deepface.commons import logger as log
 
-logger = Logger(module="extendedmodels.Race")
+logger = log.get_singletonish_logger()
 
 # --------------------------
 # pylint: disable=line-too-long