propagate ugrid logger (#4351)

lib/iris/config.py

@@ -37,7 +37,9 @@
 import warnings
 
 
-def get_logger(name, datefmt=None, fmt=None, level=None, propagate=None):
+def get_logger(
+ name, datefmt=None, fmt=None, level=None, propagate=None, handler=True
+):
  """
  Create a :class:`logging.Logger` with a :class:`logging.StreamHandler`
  and custom :class:`logging.Formatter`.
@@ -68,16 +70,14 @@ def get_logger(name, datefmt=None, fmt=None, level=None, propagate=None):
  passed to the handlers of higher level loggers. Defaults to
  ``False``.
 
- """
- if datefmt is None:
- # Default date format string.
- datefmt = "%d-%m-%Y %H:%M:%S"
+ * handler:
+ Create and attach a :class:`logging.StreamHandler` to the
+ logger. Defaults to ``True``.
 
- # Default format string.
- _fmt = "%(asctime)s %(name)s %(levelname)s - %(message)s"
- # Append additional format string, if appropriate.
- fmt = _fmt if fmt is None else f"{_fmt} {fmt}"
+ Returns:
+ A :class:`logging.Logger`.
 
+ """
  if level is None:
  # Default logging level.
  level = "INFO"
@@ -91,16 +91,25 @@ def get_logger(name, datefmt=None, fmt=None, level=None, propagate=None):
  logger.setLevel(level)
  logger.propagate = propagate
 
- # Create a formatter.
- formatter = logging.Formatter(fmt=fmt, datefmt=datefmt)
+ # Create and add the handler to the logger, if required.
+ if handler:
+ if datefmt is None:
+ # Default date format string.
+ datefmt = "%d-%m-%Y %H:%M:%S"
+
+ # Default format string.
+ _fmt = "%(asctime)s %(name)s %(levelname)s - %(message)s"
+ # Append additional format string, if appropriate.
+ fmt = _fmt if fmt is None else f"{_fmt} {fmt}"
+
+ # Create a formatter.
+ formatter = logging.Formatter(fmt=fmt, datefmt=datefmt)
 
- # Create a logging handler.
- handler = logging.StreamHandler()
- # handler.setLevel(level)
- handler.setFormatter(formatter)
+ # Create a logging handler.
+ handler = logging.StreamHandler()
+ handler.setFormatter(formatter)
 
- # Add the handler to the logger.
- logger.addHandler(handler)
+ logger.addHandler(handler)
 
  return logger
 

lib/iris/experimental/ugrid/__init__.py

@@ -14,16 +14,10 @@
  definition at :const:`iris.experimental.ugrid.load.PARSE_UGRID_ON_LOAD`.
 
 """
-# Configure the logger.
 from ...config import get_logger
-
-logger = get_logger(__name__, fmt="[%(cls)s.%(funcName)s]")
-
-# Lazy imports to avoid circularity.
-from .load import load_mesh, load_meshes, PARSE_UGRID_ON_LOAD # isort:skip
-from .mesh import Connectivity, Mesh, MeshCoord # isort:skip
-from .save import save_mesh # isort:skip
-
+from .load import PARSE_UGRID_ON_LOAD, load_mesh, load_meshes
+from .mesh import Connectivity, Mesh, MeshCoord
+from .save import save_mesh
 
 __all__ = [
  "Connectivity",
@@ -34,3 +28,6 @@
  "load_meshes",
  "save_mesh",
 ]
+
+# Configure the logger as a root logger.
+logger = get_logger(__name__, fmt="[%(cls)s.%(funcName)s]", level="NOTSET")

lib/iris/experimental/ugrid/cf.py

@@ -12,10 +12,13 @@
 """
 import logging
 
-from . import logger
+from ...config import get_logger
 from ...fileformats import cf
 from .mesh import Connectivity
 
+# Configure the logger.
+logger = get_logger(__name__, propagate=True, handler=False)
+
 
 class CFUGridConnectivityVariable(cf.CFVariable):
  """

lib/iris/experimental/ugrid/load.py

@@ -17,7 +17,7 @@
 from pathlib import Path
 import threading
 
-from . import logger
+from ...config import get_logger
 from ...coords import AuxCoord
 from ...fileformats import netcdf
 from ...fileformats._nc_load_rules.helpers import get_attr_units, get_names
@@ -31,6 +31,9 @@
 )
 from .mesh import Connectivity, Mesh
 
+# Configure the logger.
+logger = get_logger(__name__, propagate=True, handler=False)
+
 
 class ParseUGridOnLoad(threading.local):
  def __init__(self):

lib/iris/experimental/ugrid/mesh.py

@@ -18,18 +18,21 @@
 from dask import array as da
 import numpy as np
 
-from . import logger
 from ... import _lazy_data as _lazy
 from ...common import (
  CFVariableMixin,
  metadata_filter,
  metadata_manager_factory,
 )
+from ...config import get_logger
 from ...coords import AuxCoord, _DimensionalMetadata
 from ...exceptions import ConnectivityNotFoundError, CoordinateNotFoundError
 from ...util import guess_coord_axis
 from .metadata import ConnectivityMetadata, MeshCoordMetadata, MeshMetadata
 
+# Configure the logger.
+logger = get_logger(__name__, propagate=True, handler=False)
+
 #: Numpy "threshold" printoptions default argument.
 NP_PRINTOPTIONS_THRESHOLD = 10
 #: Numpy "edgeitems" printoptions default argument.

lib/iris/tests/unit/experimental/ugrid/cf/test_CFUGridAuxiliaryCoordinateVariable.py

@@ -16,16 +16,18 @@
 
 import numpy as np
 
-from iris.experimental.ugrid import logger
-from iris.experimental.ugrid.cf import CFUGridAuxiliaryCoordinateVariable
+from iris.experimental.ugrid.cf import (
+ CFUGridAuxiliaryCoordinateVariable,
+ logger,
+)
 from iris.tests.unit.experimental.ugrid.cf.test_CFUGridReader import (
  netcdf_ugrid_variable,
 )
 
 
 def named_variable(name):
  # Don't need to worry about dimensions or dtype for these tests.
- return netcdf_ugrid_variable(name, "", np.int)
+ return netcdf_ugrid_variable(name, "", int)
 
 
 class TestIdentify(tests.IrisTest):

lib/iris/tests/unit/experimental/ugrid/cf/test_CFUGridConnectivityVariable.py

@@ -16,8 +16,7 @@
 
 import numpy as np
 
-from iris.experimental.ugrid import logger
-from iris.experimental.ugrid.cf import CFUGridConnectivityVariable
+from iris.experimental.ugrid.cf import CFUGridConnectivityVariable, logger
 from iris.experimental.ugrid.mesh import Connectivity
 from iris.tests.unit.experimental.ugrid.cf.test_CFUGridReader import (
  netcdf_ugrid_variable,
@@ -26,7 +25,7 @@
 
 def named_variable(name):
  # Don't need to worry about dimensions or dtype for these tests.
- return netcdf_ugrid_variable(name, "", np.int)
+ return netcdf_ugrid_variable(name, "", int)
 
 
 class TestIdentify(tests.IrisTest):

lib/iris/tests/unit/experimental/ugrid/cf/test_CFUGridMeshVariable.py

@@ -16,16 +16,15 @@
 
 import numpy as np
 
-from iris.experimental.ugrid import logger
-from iris.experimental.ugrid.cf import CFUGridMeshVariable
+from iris.experimental.ugrid.cf import CFUGridMeshVariable, logger
 from iris.tests.unit.experimental.ugrid.cf.test_CFUGridReader import (
  netcdf_ugrid_variable,
 )
 
 
 def named_variable(name):
  # Don't need to worry about dimensions or dtype for these tests.
- return netcdf_ugrid_variable(name, "", np.int)
+ return netcdf_ugrid_variable(name, "", int)
 
 
 class TestIdentify(tests.IrisTest):

lib/iris/tests/unit/experimental/ugrid/load/test_load_meshes.py

@@ -17,8 +17,11 @@
 import tempfile
 from uuid import uuid4
 
-from iris.experimental.ugrid import logger
-from iris.experimental.ugrid.load import PARSE_UGRID_ON_LOAD, load_meshes
+from iris.experimental.ugrid.load import (
+ PARSE_UGRID_ON_LOAD,
+ load_meshes,
+ logger,
+)
 
 
 def setUpModule():

lib/iris/tests/unit/experimental/ugrid/mesh/test_Mesh.py

@@ -13,7 +13,8 @@
 
 from iris.coords import AuxCoord
 from iris.exceptions import ConnectivityNotFoundError, CoordinateNotFoundError
-from iris.experimental.ugrid import logger, mesh, metadata
+from iris.experimental.ugrid import mesh, metadata
+from iris.experimental.ugrid.mesh import logger
 
 
 class TestMeshCommon(tests.IrisTest):