use pipe union syntax

gridfinder/__init__.py

@@ -1,17 +1,35 @@
-"""
-gridfinder package contains the following modules:
-
- - _util.py : helper functions used internally
- - gridfinder.py : main implementation of Dijkstra's algorithm
- - post.py : postprocess the algorithm output and check accuracy
- - prepare.py : transforming input data into the cost and targets arrays
-"""
-
 from importlib.metadata import version
 
-from .gridfinder import *  # NoQA
-from .post import *  # NoQA
-from .prepare import *  # NoQA
-from .util import *  # NoQA
+from gridfinder.gridfinder import get_targets_costs, optimise
+from gridfinder.post import accuracy, raster_to_lines, thin, threshold, threshold_arr
+from gridfinder.prepare import (
+    clip_rasters,
+    create_filter,
+    drop_zero_pop,
+    filter_func,
+    merge_rasters,
+    prepare_ntl,
+    prepare_roads,
+)
+from gridfinder.util import clip_raster, save_raster
 
 __version__ = version("gridfinder")
+
+__all__ = [
+    "get_targets_costs",
+    "optimise",
+    "threshold",
+    "threshold_arr",
+    "thin",
+    "raster_to_lines",
+    "accuracy",
+    "clip_rasters",
+    "merge_rasters",
+    "filter_func",
+    "create_filter",
+    "prepare_ntl",
+    "drop_zero_pop",
+    "prepare_roads",
+    "save_raster",
+    "clip_raster",
+]

gridfinder/gridfinder.py

@@ -1,6 +1,4 @@
-"""
-Implements Dijkstra's algorithm on a cost-array to create an MST.
-"""
+from __future__ import annotations
 
 from heapq import heapify, heappop, heappush
 from math import sqrt

gridfinder/post.py

@@ -1,7 +1,4 @@
-"""
-Post-processing for gridfinder package.
-"""
-
+from __future__ import annotations
 
 import geopandas as gpd
 import numpy as np

gridfinder/prepare.py

@@ -1,12 +1,9 @@
-"""
-Prepare input layers for gridfinder.
-"""
+from __future__ import annotations
 
 import json
 import os
 from math import sqrt
 from pathlib import Path
-from typing import Optional
 
 import fiona
 import geopandas as gpd
@@ -122,7 +119,7 @@ def create_filter() -> np.ndarray:
 def prepare_ntl(
     ntl_in: Pathy,
     aoi_in: Pathy,
-    ntl_filter: Optional[np.ndarray] = None,
+    ntl_filter: np.ndarray | None = None,
     threshold: float = 0.1,
     upsample_by: int = 2,
 ) -> tuple[np.ndarray, Affine]:

gridfinder/util.py

@@ -1,10 +1,7 @@
-"""
-Utility module used internally.
-"""
+from __future__ import annotations
 
 import json
 from pathlib import Path
-from typing import Optional, Union
 
 import numpy as np
 import rasterio as rs
@@ -13,7 +10,7 @@
 from pyproj import Proj
 from rasterio.mask import mask
 
-Pathy = Union[str, Path]
+Pathy = str | Path
 
 Loc = tuple[int, int]
 
@@ -22,7 +19,7 @@ def save_raster(
     path: Pathy,
     raster: np.ndarray,
     affine: Affine,
-    crs: Optional[Union[str, Proj]] = None,
+    crs: str | Proj | None = None,
     nodata: int = 0,
 ) -> None:
     """Save a raster to the specified file.

pyproject.toml

@@ -78,6 +78,7 @@ line-length = 88
 exclude = []
 
 [tool.ruff.lint]
+ignore-init-module-imports = true
 select = [
     "F",
     "E",
@@ -100,4 +101,4 @@ reportMissingImports = true
 reportMissingParameterType = true
 reportUnnecessaryTypeIgnoreComment = true
 reportDeprecated = true
-pythonVersion = "3.9"
+pythonVersion = "3.10"