Merge pull request #3725 from pypeclub/feature/OP-3655_Replace-PypeLo…

…gger-with-Logger

General: Replace PypeLogger with Logger

openpype/client/entities.py

@@ -1455,7 +1455,7 @@ def get_workfile_info(
 """
 ## Custom data storage:
 - Settings - OP settings overrides and local settings
-- Logging - logs from PypeLogger
+- Logging - logs from Logger
 - Webpublisher - jobs
 - Ftrack - events
 - Maya - Shaders

openpype/hosts/celaction/api/cli.py

@@ -14,7 +14,7 @@
 from openpype.pipeline import install_openpype_plugins
 
 
-log = Logger().get_logger("Celaction_cli_publisher")
+log = Logger.get_logger("Celaction_cli_publisher")
 
 publish_host = "celaction"
 

openpype/hosts/fusion/api/pipeline.py

@@ -8,7 +8,7 @@
 
 import pyblish.api
 
-from openpype.api import Logger
+from openpype.lib import Logger
 from openpype.pipeline import (
  register_loader_plugin_path,
  register_creator_plugin_path,
@@ -20,7 +20,7 @@
 )
 import openpype.hosts.fusion
 
-log = Logger().get_logger(__name__)
+log = Logger.get_logger(__name__)
 
 HOST_DIR = os.path.dirname(os.path.abspath(openpype.hosts.fusion.__file__))
 PLUGINS_DIR = os.path.join(HOST_DIR, "plugins")

openpype/hosts/fusion/utility_scripts/__OpenPype_Menu__.py

@@ -1,14 +1,12 @@
 import os
 import sys
 
-from openpype.api import Logger
+from openpype.lib import Logger
 from openpype.pipeline import (
  install_host,
  registered_host,
 )
 
-log = Logger().get_logger(__name__)
-
 
 def main(env):
  from openpype.hosts.fusion import api
@@ -17,6 +15,7 @@ def main(env):
  # activate resolve from pype
  install_host(api)
 
+ log = Logger.get_logger(__name__)
  log.info(f"Registered host: {registered_host()}")
 
  menu.launch_openpype_menu()

openpype/hosts/hiero/api/events.py

@@ -1,7 +1,6 @@
 import os
 import hiero.core.events
-from openpype.api import Logger
-from openpype.lib import register_event_callback
+from openpype.lib import Logger, register_event_callback
 from .lib import (
  sync_avalon_data_to_workfile,
  launch_workfiles_app,
@@ -11,7 +10,7 @@
 from .tags import add_tags_to_workfile
 from .menu import update_menu_task_label
 
-log = Logger().get_logger(__name__)
+log = Logger.get_logger(__name__)
 
 
 def startupCompleted(event):

openpype/hosts/hiero/api/lib.py

@@ -21,7 +21,7 @@
 )
 from openpype.settings import get_anatomy_settings
 from openpype.pipeline import legacy_io, Anatomy
-from openpype.api import Logger
+from openpype.lib import Logger
 from . import tags
 
 try:
@@ -34,7 +34,7 @@
 # from opentimelineio import opentime
 # from pprint import pformat
 
-log = Logger().get_logger(__name__)
+log = Logger.get_logger(__name__)
 
 self = sys.modules[__name__]
 self._has_been_setup = False

openpype/hosts/hiero/api/pipeline.py

@@ -6,7 +6,7 @@
 from collections import OrderedDict
 
 from pyblish import api as pyblish
-from openpype.api import Logger
+from openpype.lib import Logger
 from openpype.pipeline import (
  schema,
  register_creator_plugin_path,
@@ -18,7 +18,7 @@
 from openpype.tools.utils import host_tools
 from . import lib, menu, events
 
-log = Logger().get_logger(__name__)
+log = Logger.get_logger(__name__)
 
 # plugin paths
 API_DIR = os.path.dirname(os.path.abspath(__file__))

openpype/hosts/hiero/api/plugin.py

@@ -9,11 +9,12 @@
 import qargparse
 
 import openpype.api as openpype
+from openpype.lib import Logger
 from openpype.pipeline import LoaderPlugin, LegacyCreator
 from openpype.pipeline.context_tools import get_current_project_asset
 from . import lib
 
-log = openpype.Logger().get_logger(__name__)
+log = Logger.get_logger(__name__)
 
 
 def load_stylesheet():

openpype/hosts/maya/api/plugin.py

@@ -4,6 +4,7 @@
 
 import qargparse
 
+from openpype.lib import Logger
 from openpype.pipeline import (
  LegacyCreator,
  LoaderPlugin,
@@ -50,9 +51,7 @@ def get_reference_node(members, log=None):
  # Warn the user when we're taking the highest reference node
  if len(references) > 1:
  if not log:
- from openpype.lib import PypeLogger
-
- log = PypeLogger().get_logger(__name__)
+ log = Logger.get_logger(__name__)
 
  log.warning("More than one reference node found in "
  "container, using highest reference node: "

openpype/hosts/nuke/plugins/load/actions.py

@@ -2,10 +2,10 @@
 
 """
 
-from openpype.api import Logger
+from openpype.lib import Logger
 from openpype.pipeline import load
 
-log = Logger().get_logger(__name__)
+log = Logger.get_logger(__name__)
 
 
 class SetFrameRangeLoader(load.LoaderPlugin):

openpype/hosts/nuke/startup/clear_rendered.py

@@ -1,10 +1,11 @@
 import os
 
-from openpype.api import Logger
-log = Logger().get_logger(__name__)
+from openpype.lib import Logger
 
 
 def clear_rendered(dir_path):
+ log = Logger.get_logger(__name__)
+
  for _f in os.listdir(dir_path):
  _f_path = os.path.join(dir_path, _f)
  log.info("Removing: `{}`".format(_f_path))

openpype/hosts/nuke/startup/write_to_read.py

@@ -2,8 +2,8 @@
 import os
 import glob
 import nuke
-from openpype.api import Logger
-log = Logger().get_logger(__name__)
+from openpype.lib import Logger
+log = Logger.get_logger(__name__)
 
 SINGLE_FILE_FORMATS = ['avi', 'mp4', 'mxf', 'mov', 'mpg', 'mpeg', 'wmv', 'm4v',
  'm2v']

openpype/hosts/tvpaint/worker/worker_job.py

@@ -9,7 +9,7 @@
 
 import six
 
-from openpype.api import PypeLogger
+from openpype.lib import Logger
 from openpype.modules import ModulesManager
 
 
@@ -328,7 +328,7 @@ def job_queue_root(self):
  def log(self):
  """Access to logger object."""
  if self._log is None:
- self._log = PypeLogger.get_logger(self.__class__.__name__)
+ self._log = Logger.get_logger(self.__class__.__name__)
  return self._log
 
  @property

openpype/hosts/webpublisher/webserver_service/webpublish_routes.py

@@ -12,9 +12,7 @@
  get_assets,
  OpenPypeMongoConnection,
 )
-from openpype.lib import (
- PypeLogger,
-)
+from openpype.lib import Logger
 from openpype.lib.remote_publish import (
  get_task_data,
  ERROR_STATUS,
@@ -23,7 +21,7 @@
 from openpype.settings import get_project_settings
 from openpype_modules.webserver.base_routes import RestApiEndpoint
 
-log = PypeLogger.get_logger("WebpublishRoutes")
+log = Logger.get_logger("WebpublishRoutes")
 
 
 class ResourceRestApiEndpoint(RestApiEndpoint):

openpype/hosts/webpublisher/webserver_service/webserver_cli.py

@@ -7,7 +7,7 @@
 import subprocess
 
 from openpype.client import OpenPypeMongoConnection
-from openpype.lib import PypeLogger
+from openpype.lib import Logger
 
 from .webpublish_routes import (
  RestApiResource,
@@ -28,7 +28,7 @@
 )
 
 
-log = PypeLogger.get_logger("webserver_gui")
+log = Logger.get_logger("webserver_gui")
 
 
 def run_webserver(*args, **kwargs):

openpype/lib/applications.py

@@ -24,7 +24,7 @@
  METADATA_KEYS,
  M_DYNAMIC_KEY_LABEL
 )
-from . import PypeLogger
+from .log import Logger
 from .profiles_filtering import filter_profiles
 from .local_settings import get_openpype_username
 
@@ -138,7 +138,7 @@ def get_logger():
  """Global lib.applications logger getter."""
  global _logger
  if _logger is None:
- _logger = PypeLogger.get_logger(__name__)
+ _logger = Logger.get_logger(__name__)
  return _logger
 
 
@@ -373,7 +373,7 @@ class ApplicationManager:
  """
 
  def __init__(self, system_settings=None):
- self.log = PypeLogger.get_logger(self.__class__.__name__)
+ self.log = Logger.get_logger(self.__class__.__name__)
 
  self.app_groups = {}
  self.applications = {}
@@ -735,7 +735,7 @@ def __init__(self, launch_context):
 
  Always should be called
  """
- self.log = PypeLogger().get_logger(self.__class__.__name__)
+ self.log = Logger.get_logger(self.__class__.__name__)
 
  self.launch_context = launch_context
 
@@ -877,7 +877,7 @@ def __init__(self, application, executable, env_group=None, **data):
 
  # Logger
  logger_name = "{}-{}".format(self.__class__.__name__, self.app_name)
- self.log = PypeLogger.get_logger(logger_name)
+ self.log = Logger.get_logger(logger_name)
 
  self.executable = executable
 

openpype/lib/execute.py

@@ -5,7 +5,7 @@
 import json
 import tempfile
 
-from .log import PypeLogger as Logger
+from .log import Logger
 from .vendor_bin_utils import find_executable
 
 # MSDN process creation flag (Windows only)
@@ -40,7 +40,7 @@ def execute(args,
 
  log_levels = ['DEBUG:', 'INFO:', 'ERROR:', 'WARNING:', 'CRITICAL:']
 
- log = Logger().get_logger('execute')
+ log = Logger.get_logger('execute')
  log.info("Executing ({})".format(" ".join(args)))
  popen = subprocess.Popen(
  args,

openpype/lib/log.py

@@ -486,12 +486,18 @@ def get_log_mongo_connection(cls):
 
 
 class PypeLogger(Logger):
+ """Duplicate of 'Logger'.
+
+ Deprecated:
+ Class will be removed after release version 3.16.*
+ """
+
  @classmethod
  def get_logger(cls, *args, **kwargs):
  logger = Logger.get_logger(*args, **kwargs)
  # TODO uncomment when replaced most of places
- # logger.warning((
- #  "'openpype.lib.PypeLogger' is deprecated class."
- #  " Please use 'openpype.lib.Logger' instead."
- # ))
+ logger.warning((
+ "'openpype.lib.PypeLogger' is deprecated class."
+ " Please use 'openpype.lib.Logger' instead."
+ ))
  return logger

openpype/lib/path_templates.py

@@ -6,11 +6,6 @@
 
 import six
 
-from .log import PypeLogger
-
-log = PypeLogger.get_logger(__name__)
-
-
 KEY_PATTERN = re.compile(r"(\{.*?[^{0]*\})")
 KEY_PADDING_PATTERN = re.compile(r"([^:]+)\S+[><]\S+")
 SUB_DICT_PATTERN = re.compile(r"([^\[\]]+)")

openpype/lib/remote_publish.py

@@ -66,7 +66,7 @@ def publish(log, close_plugin_name=None, raise_error=False):
  """Loops through all plugins, logs to console. Used for tests.
 
  Args:
- log (OpenPypeLogger)
+ log (openpype.lib.Logger)
  close_plugin_name (str): name of plugin with responsibility to
  close host app
  """
@@ -98,7 +98,7 @@ def publish_and_log(dbcon, _id, log, close_plugin_name=None, batch_id=None):
  Args:
  dbcon (OpenPypeMongoConnection)
  _id (str) - id of current job in DB
- log (OpenPypeLogger)
+ log (openpype.lib.Logger)
  batch_id (str) - id sent from frontend
  close_plugin_name (str): name of plugin with responsibility to
  close host app