fix: use common interface in joiners and loaders (#235)

* fix: use common interface in joiners and loaders

* fix: add ABC to OSMLoader class

srai/joiners/_base.py

@@ -10,7 +10,9 @@ class Joiner(abc.ABC):
 
     @abc.abstractmethod
     def transform(
-        self, regions: gpd.GeoDataFrame, features: gpd.GeoDataFrame
+        self,
+        regions: gpd.GeoDataFrame,
+        features: gpd.GeoDataFrame,
     ) -> gpd.GeoDataFrame:  # pragma: no cover
         """
         Join features to regions.

srai/joiners/intersection_joiner.py

@@ -8,9 +8,10 @@
 import pandas as pd
 
 from srai.constants import FEATURES_INDEX, GEOMETRY_COLUMN, REGIONS_INDEX
+from srai.joiners import Joiner
 
 
-class IntersectionJoiner:
+class IntersectionJoiner(Joiner):
     """
     Intersection Joiner.
 

srai/loaders/_base.py

@@ -1,8 +1,7 @@
 """Base class for loaders."""
 
 import abc
-from pathlib import Path
-from typing import Union
+from typing import Any
 
 import geopandas as gpd
 
@@ -11,13 +10,13 @@ class Loader(abc.ABC):
     """Abstract class for loaders."""
 
     @abc.abstractmethod
-    def load(self, area: Union[gpd.GeoDataFrame, Path]) -> gpd.GeoDataFrame:  # pragma: no cover
+    def load(self, *args: Any, **kwargs: Any) -> gpd.GeoDataFrame:  # pragma: no cover
         """
         Load data for a given area.
 
         Args:
-            area (gdf.GeoDataFrame | Path): GeoDataFrame with the area of interest or a path
-                to a file with a geometry.
+            *args: Positional arguments dependating on a specific loader.
+            **kwargs: Keyword arguments dependating on a specific loader.
 
         Returns:
             GeoDataFrame with the downloaded data.

srai/loaders/geoparquet_loader.py

@@ -10,9 +10,10 @@
 import geopandas as gpd
 
 from srai.constants import GEOMETRY_COLUMN, WGS84_CRS
+from srai.loaders import Loader
 
 
-class GeoparquetLoader:
+class GeoparquetLoader(Loader):
     """
     GeoparquetLoader.
 

srai/loaders/gtfs_loader.py

@@ -18,6 +18,7 @@
 from shapely.geometry import Point
 
 from srai.constants import GEOMETRY_COLUMN, WGS84_CRS
+from srai.loaders import Loader
 from srai.utils._optional import import_optional_dependencies
 
 if TYPE_CHECKING:  # pragma: no cover
@@ -27,7 +28,7 @@
 GTFS2VEC_TRIPS_PREFIX = "trips_at_"
 
 
-class GTFSLoader:
+class GTFSLoader(Loader):
     """
     GTFSLoader.
 

srai/loaders/osm_loaders/_base.py

@@ -8,6 +8,7 @@
 import pandas as pd
 from tqdm import tqdm
 
+from srai.loaders import Loader
 from srai.loaders.osm_loaders.filters._typing import (
     grouped_osm_tags_type,
     merge_grouped_osm_tags_type,
@@ -16,7 +17,7 @@
 from srai.utils.typing import is_expected_type
 
 
-class OSMLoader(abc.ABC):
+class OSMLoader(Loader, abc.ABC):
     """Abstract class for loaders."""
 
     @abc.abstractmethod

srai/loaders/osm_loaders/osm_online_loader.py

@@ -13,7 +13,10 @@
 
 from srai.constants import FEATURES_INDEX, GEOMETRY_COLUMN, WGS84_CRS
 from srai.loaders.osm_loaders._base import OSMLoader
-from srai.loaders.osm_loaders.filters._typing import grouped_osm_tags_type, osm_tags_type
+from srai.loaders.osm_loaders.filters._typing import (
+    grouped_osm_tags_type,
+    osm_tags_type,
+)
 from srai.utils._optional import import_optional_dependencies
 
 

srai/loaders/osm_loaders/osm_pbf_loader.py

@@ -11,7 +11,10 @@
 
 from srai.constants import FEATURES_INDEX, GEOMETRY_COLUMN, WGS84_CRS
 from srai.loaders.osm_loaders._base import OSMLoader
-from srai.loaders.osm_loaders.filters._typing import grouped_osm_tags_type, osm_tags_type
+from srai.loaders.osm_loaders.filters._typing import (
+    grouped_osm_tags_type,
+    osm_tags_type,
+)
 from srai.utils._optional import import_optional_dependencies
 
 

srai/loaders/osm_way_loader/osm_way_loader.py

@@ -16,6 +16,7 @@
 
 from srai.constants import FEATURES_INDEX, GEOMETRY_COLUMN, WGS84_CRS
 from srai.exceptions import LoadedDataIsEmptyException
+from srai.loaders import Loader
 from srai.utils._optional import import_optional_dependencies
 
 from . import constants
@@ -41,7 +42,7 @@ class NetworkType(str, Enum):
     WALK = "walk"
 
 
-class OSMWayLoader:
+class OSMWayLoader(Loader):
     """
     OSMWayLoader downloads road infrastructure from OSM.