Implement loggers

dev-requirements.txt

@@ -55,6 +55,7 @@ colorama==0.4.6
     # via
     #   build
     #   click
+    #   loguru
     #   pytest
     #   tqdm
 contourpy==1.2.0
@@ -116,6 +117,8 @@ lazy-loader==0.3
     # via scikit-image
 llvmlite==0.41.1
     # via numba
+loguru==0.7.2
+    # via swmmanywhere (pyproject.toml)
 matplotlib==3.8.2
     # via
     #   salib
@@ -300,6 +303,8 @@ virtualenv==20.24.5
     # via pre-commit
 wheel==0.41.3
     # via pip-tools
+win32-setctime==1.1.0
+    # via loguru
 xarray==2023.12.0
     # via
     #   rioxarray

pyproject.toml

@@ -20,6 +20,7 @@ dependencies = [ # TODO definitely don't need all of these
                 "geopandas",
                 "geopy",
                 "GitPython",
+                "loguru",
                 "matplotlib",
                 "netcdf4",
                 "networkx",

requirements.txt

@@ -48,6 +48,7 @@ cligj==0.7.2
 colorama==0.4.6
     # via
     #   click
+    #   loguru
     #   tqdm
 contourpy==1.2.0
     # via matplotlib
@@ -94,6 +95,8 @@ lazy-loader==0.3
     # via scikit-image
 llvmlite==0.41.1
     # via numba
+loguru==0.7.2
+    # via swmmanywhere (pyproject.toml)
 matplotlib==3.8.2
     # via
     #   salib
@@ -237,6 +240,8 @@ tzdata==2024.1
     # via pandas
 urllib3==2.1.0
     # via requests
+win32-setctime==1.1.0
+    # via loguru
 xarray==2023.12.0
     # via
     #   rioxarray

swmmanywhere/graph_utilities.py

@@ -22,6 +22,7 @@
 
 from swmmanywhere import geospatial_utilities as go
 from swmmanywhere import parameters
+from swmmanywhere.utils import logger
 
 
 def load_graph(fid: Path) -> nx.Graph:
@@ -940,7 +941,7 @@ def process_successors(G: nx.Graph,
         edge_diams[(node,ds_node,0)] = diam
         chamber_floor[ds_node] = surface_elevations[ds_node] - depth
         if ix > 0:
-            print('''a node has multiple successors, 
+            logger.warning('''a node has multiple successors, 
                 not sure how that can happen if using shortest path
                 to derive topology''')
 

swmmanywhere/prepare_data.py

@@ -18,7 +18,8 @@
 import yaml
 from geopy.geocoders import Nominatim
 
-# Some minor comment (to remove)
+from swmmanywhere.utils import logger
+
 
 def get_country(x: float, 
                 y: float) -> dict[int, str]:
@@ -85,9 +86,9 @@ def download_buildings(file_address: Path,
         # Save data to the specified file address
         with file_address.open("wb") as file:
             file.write(response.content)
-        print(f"Data downloaded and saved to {file_address}")
+        logger.info(f"Data downloaded and saved to {file_address}")
     else:
-        print(f"Error downloading data. Status code: {response.status_code}")
+        logger.error(f"Error downloading data. Status code: {response.status_code}")
     return response.status_code
 
 def download_street(bbox: tuple[float, float, float, float]) -> nx.MultiDiGraph:
@@ -176,10 +177,10 @@ def download_elevation(fid: Path,
         with fid.open('wb') as rast_file:
             shutil.copyfileobj(r.raw, rast_file)
 
-        print('Elevation data downloaded successfully.')
+        logger.info('Elevation data downloaded successfully.')
 
     except requests.exceptions.RequestException as e:
-        print(f'Error downloading elevation data: {e}')
+        logger.error(f'Error downloading elevation data: {e}')
 
     return r.status_code
 

swmmanywhere/preprocessing.py

@@ -16,6 +16,7 @@
 from swmmanywhere import geospatial_utilities as go
 from swmmanywhere import graph_utilities as gu
 from swmmanywhere import parameters, prepare_data
+from swmmanywhere.utils import logger
 
 
 def next_directory(keyword: str, directory: Path) -> int:
@@ -161,7 +162,7 @@ def prepare_precipitation(bbox: tuple[float, float, float, float],
     """Download and reproject precipitation data."""
     if addresses.precipitation.exists():
         return
-    print(f'downloading precipitation to {addresses.precipitation}')
+    logger.info(f'downloading precipitation to {addresses.precipitation}')
     precip = prepare_data.download_precipitation(bbox,
                                                     api_keys['cds_username'],
                                                     api_keys['cds_api_key'])
@@ -179,7 +180,7 @@ def prepare_elvation(bbox: tuple[float, float, float, float],
     """Download and reproject elevation data."""
     if addresses.elevation.exists():
         return
-    print(f'downloading elevation to {addresses.elevation}')
+    logger.info(f'downloading elevation to {addresses.elevation}')
     with tempfile.TemporaryDirectory() as temp_dir:
         fid = Path(temp_dir) / 'elevation.tif'
         prepare_data.download_elevation(fid,
@@ -198,12 +199,12 @@ def prepare_building(bbox: tuple[float, float, float, float],
         return
 
     if not addresses.national_building.exists():  
-        print(f'downloading buildings to {addresses.national_building}')
+        logger.info(f'downloading buildings to {addresses.national_building}')
         prepare_data.download_buildings(addresses.national_building, 
                                         bbox[0],
                                         bbox[1])
 
-    print(f'trimming buildings to {addresses.building}')
+    logger.info(f'trimming buildings to {addresses.building}')
     national_buildings = gpd.read_parquet(addresses.national_building)
     buildings = national_buildings.cx[bbox[0]:bbox[2], bbox[1]:bbox[3]] # type: ignore 
 
@@ -217,7 +218,7 @@ def prepare_street(bbox: tuple[float, float, float, float],
     """Download and reproject street graph."""
     if addresses.street.exists():
         return
-    print(f'downloading street network to {addresses.street}')
+    logger.info(f'downloading street network to {addresses.street}')
     street_network = prepare_data.download_street(bbox)
     street_network = go.reproject_graph(street_network, 
                                         source_crs, 
@@ -231,7 +232,7 @@ def prepare_river(bbox: tuple[float, float, float, float],
     """Download and reproject river graph."""
     if addresses.river.exists():
         return
-    print(f'downloading river network to {addresses.river}')
+    logger.info(f'downloading river network to {addresses.river}')
     river_network = prepare_data.download_river(bbox)
     river_network = go.reproject_graph(river_network, 
                                         source_crs,

swmmanywhere/utils.py

@@ -0,0 +1,35 @@
+# -*- coding: utf-8 -*-
+"""Created on 2024-03-04.
+
+@author: Barney
+"""
+import os
+import sys
+
+import loguru
+
+
+def get_logger(verbose: bool = False) -> loguru.logger:
+    """Get a logger."""
+    logger = loguru.logger
+    logger.configure(
+        handlers=[
+            {
+                "sink": sys.stdout,
+                "colorize": True,
+                "format": " | ".join(
+                    [
+                        "<cyan>{time:YYYY/MM/DD HH:mm:ss}</>",
+                        "{message}",
+                    ]
+                ),
+            }
+        ]
+    )
+    if os.getenv("PACKAGE_NAME_VERBOSE", str(verbose)).lower() == "true":
+        logger.enable("package_name")
+    else:
+        logger.disable("package_name")
+    return logger
+
+logger = get_logger()

tests/test_utils.py

@@ -0,0 +1,33 @@
+# -*- coding: utf-8 -*-
+"""Created on 2024-01-26.
+
+@author: Barney
+"""
+from pathlib import Path
+from tempfile import NamedTemporaryFile
+
+from swmmanywhere.utils import logger
+
+
+def test_logger():
+    """Test the get_logger function."""
+    assert logger is not None
+    logger.debug("This is a debug message.")
+    logger.info("This is an info message.")
+    logger.warning("This is a warning message.")
+    logger.error("This is an error message.")
+    logger.critical("This is a critical message.")
+
+    with NamedTemporaryFile(suffix='.log',
+                            mode = 'w+b',
+                            delete=False) as temp_file:
+        fid = Path(temp_file.name)
+        logger.add(fid)
+        logger.debug("This is a debug message.")
+        logger.info("This is an info message.")
+        logger.warning("This is a warning message.")
+        logger.error("This is an error message.")
+        logger.critical("This is a critical message.")
+        assert temp_file.read() != b""
+        logger.remove()
+    fid.unlink()