chore: refactor utils module

examples/embedders/count_embedder.ipynb

@@ -8,7 +8,7 @@
    "source": [
     "from shapely import geometry\n",
     "import geopandas as gpd\n",
-    "from srai.utils.constants import WGS84_CRS\n",
+    "from srai.constants import WGS84_CRS\n",
     "from srai.loaders.osm_loaders import OSMOnlineLoader\n",
     "from srai.regionizers import H3Regionizer\n",
     "from srai.joiners import IntersectionJoiner\n",

examples/loaders/gtfs_loader.ipynb

@@ -20,8 +20,8 @@
     "import geopandas as gpd\n",
     "import numpy as np\n",
     "from shapely.geometry import Point\n",
-    "from srai.utils.constants import WGS84_CRS\n",
-    "from srai.utils.download import download"
+    "from srai.constants import WGS84_CRS\n",
+    "from srai.utils import download_file"
    ]
   },
   {
@@ -46,7 +46,7 @@
     "wroclaw_gtfs = Path().resolve() / \"files\" / \"example.zip\"\n",
     "gtfs_url = \"https://transitfeeds.com/p/mpk-wroc-aw/663/20221221/download\"\n",
     "\n",
-    "download(gtfs_url, wroclaw_gtfs.as_posix())"
+    "download_file(gtfs_url, wroclaw_gtfs.as_posix())"
    ]
   },
   {

examples/loaders/osm_online_loader.ipynb

@@ -17,7 +17,7 @@
     "from srai.loaders.osm_loaders.filters.popular import get_popular_tags\n",
     "from srai.loaders.osm_loaders.filters import HEX2VEC_FILTER\n",
     "from srai.loaders.osm_loaders import OSMOnlineLoader\n",
-    "from srai.utils.geocode import geocode_to_region_gdf\n",
+    "from srai.utils import geocode_to_region_gdf\n",
     "from functional import seq"
    ]
   },

examples/loaders/osm_pbf_loader.ipynb

@@ -23,10 +23,9 @@
     "from srai.loaders.osm_loaders.filters import HEX2VEC_FILTER\n",
     "from srai.loaders.osm_loaders.filters.popular import get_popular_tags\n",
     "from srai.loaders.osm_loaders import OSMPbfLoader\n",
-    "from srai.utils.geometry import buffer_geometry\n",
-    "from srai.utils.constants import WGS84_CRS\n",
+    "from srai.constants import REGIONS_INDEX, WGS84_CRS\n",
+    "from srai.utils import buffer_geometry, geocode_to_region_gdf\n",
     "\n",
-    "import osmnx as ox\n",
     "from shapely.geometry import Point\n",
     "import geopandas as gpd"
    ]
@@ -54,7 +53,7 @@
    "outputs": [],
    "source": [
     "loader = OSMPbfLoader()\n",
-    "warsaw_gdf = ox.geocode_to_gdf(\"Warsaw, Poland\")\n",
+    "warsaw_gdf = geocode_to_region_gdf(\"Warsaw, Poland\")\n",
     "warsaw_features_gdf = loader.load(warsaw_gdf, HEX2VEC_FILTER)\n",
     "warsaw_features_gdf"
    ]
@@ -146,7 +145,11 @@
    "outputs": [],
    "source": [
     "vienna_center_circle = buffer_geometry(Point(16.37009, 48.20931), meters=1000)\n",
-    "vienna_center_circle_gdf = gpd.GeoDataFrame(geometry=[vienna_center_circle], crs=WGS84_CRS)"
+    "vienna_center_circle_gdf = gpd.GeoDataFrame(\n",
+    "    geometry=[vienna_center_circle],\n",
+    "    crs=WGS84_CRS,\n",
+    "    index=gpd.pd.Index(data=[\"Vienna\"], name=REGIONS_INDEX),\n",
+    ")"
    ]
   },
   {

examples/neighbourhoods/h3_neighbourhood.ipynb

@@ -8,7 +8,7 @@
    "source": [
     "from srai.neighbourhoods import H3Neighbourhood\n",
     "from srai.regionizers import H3Regionizer\n",
-    "from srai.utils.geocode import geocode_to_region_gdf"
+    "from srai.utils import geocode_to_region_gdf"
    ]
   },
   {

examples/regionizers/voronoi_regionizer.ipynb

@@ -13,7 +13,7 @@
     "from shapely.geometry import MultiPolygon, Point, Polygon\n",
     "\n",
     "from srai.regionizers import VoronoiRegionizer\n",
-    "from srai.utils.constants import WGS84_CRS"
+    "from srai.constants import WGS84_CRS"
    ]
   },
   {

srai/embedders/gtfs2vec_embedder.py

@@ -19,9 +19,9 @@
 from torch.utils.data import DataLoader
 
 from srai.embedders import Embedder
+from srai.exceptions import ModelNotFitException
 from srai.loaders.gtfs_loader import GTFS2VEC_DIRECTIONS_PREFIX, GTFS2VEC_TRIPS_PREFIX
 from srai.models import GTFS2VecModel
-from srai.utils.exceptions import ModelNotFitException
 
 
 class GTFS2VecEmbedder(Embedder):

srai/joiners/intersection_joiner.py

@@ -7,7 +7,7 @@
 import geopandas as gpd
 import pandas as pd
 
-from srai.utils.constants import FEATURES_INDEX, REGIONS_INDEX
+from srai.constants import FEATURES_INDEX, REGIONS_INDEX
 
 
 class IntersectionJoiner:

srai/loaders/geoparquet_loader.py

@@ -9,7 +9,7 @@
 
 import geopandas as gpd
 
-from srai.utils.constants import WGS84_CRS
+from srai.constants import WGS84_CRS
 
 
 class GeoparquetLoader:

srai/loaders/gtfs_loader.py

@@ -17,8 +17,8 @@
 import pandas as pd
 from shapely.geometry import Point
 
+from srai.constants import WGS84_CRS
 from srai.utils._optional import import_optional_dependencies
-from srai.utils.constants import WGS84_CRS
 
 if TYPE_CHECKING:  # pragma: no cover
     from gtfs_kit import Feed

srai/loaders/osm_loaders/osm_online_loader.py

@@ -11,9 +11,9 @@
 from functional import seq
 from tqdm import tqdm
 
+from srai.constants import FEATURES_INDEX, WGS84_CRS
 from srai.loaders.osm_loaders.filters.osm_tags_type import osm_tags_type
 from srai.utils._optional import import_optional_dependencies
-from srai.utils.constants import FEATURES_INDEX, WGS84_CRS
 
 
 class OSMOnlineLoader:

srai/loaders/osm_loaders/osm_pbf_loader.py

@@ -9,9 +9,9 @@
 import geopandas as gpd
 import pandas as pd
 
+from srai.constants import FEATURES_INDEX, WGS84_CRS
 from srai.loaders.osm_loaders.filters.osm_tags_type import osm_tags_type
 from srai.utils._optional import import_optional_dependencies
-from srai.utils.constants import FEATURES_INDEX, WGS84_CRS
 
 
 class OSMPbfLoader:

srai/loaders/osm_loaders/pbf_file_downloader.py

@@ -19,9 +19,13 @@
 from shapely.validation import make_valid
 from tqdm import tqdm
 
-from srai.utils.constants import WGS84_CRS
-from srai.utils.download import download_file
-from srai.utils.geometry import buffer_geometry, flatten_geometry, remove_interiors
+from srai.constants import WGS84_CRS
+from srai.utils import (
+    buffer_geometry,
+    download_file,
+    flatten_geometry,
+    remove_interiors,
+)
 
 
 class PbfFileDownloader:

srai/loaders/osm_loaders/pbf_file_handler.py

@@ -16,9 +16,9 @@
 from shapely.geometry.base import BaseGeometry
 from tqdm import tqdm
 
+from srai.constants import FEATURES_INDEX, WGS84_CRS
 from srai.loaders.osm_loaders.filters.hex2vec import HEX2VEC_FILTER
 from srai.loaders.osm_loaders.filters.osm_tags_type import osm_tags_type
-from srai.utils.constants import FEATURES_INDEX, WGS84_CRS
 
 
 class PbfFileHandler(osmium.SimpleHandler):  # type: ignore

srai/regionizers/administrative_boundary_regionizer.py

@@ -14,10 +14,10 @@
 from shapely.validation import make_valid
 from tqdm import tqdm
 
+from srai.constants import REGIONS_INDEX, WGS84_CRS
 from srai.regionizers import Regionizer
+from srai.utils import flatten_geometry_series
 from srai.utils._optional import import_optional_dependencies
-from srai.utils.constants import REGIONS_INDEX, WGS84_CRS
-from srai.utils.geometry import flatten_geometry_series
 
 
 class AdministrativeBoundaryRegionizer(Regionizer):

srai/regionizers/h3_regionizer.py

@@ -19,9 +19,9 @@
 from functional import seq
 from shapely import geometry
 
+from srai.constants import REGIONS_INDEX, WGS84_CRS
 from srai.regionizers import Regionizer
-from srai.utils.constants import REGIONS_INDEX, WGS84_CRS
-from srai.utils.geometry import buffer_geometry
+from srai.utils import buffer_geometry
 
 
 class H3Regionizer(Regionizer):

srai/regionizers/s2_regionizer.py

@@ -18,8 +18,8 @@
 from s2 import s2
 from shapely.geometry import Polygon
 
+from srai.constants import REGIONS_INDEX, WGS84_CRS
 from srai.regionizers import Regionizer
-from srai.utils.constants import REGIONS_INDEX, WGS84_CRS
 
 
 class S2Regionizer(Regionizer):

srai/regionizers/voronoi_regionizer.py

@@ -9,9 +9,9 @@
 import geopandas as gpd
 from shapely.geometry import Point, box
 
+from srai.constants import REGIONS_INDEX, WGS84_CRS
 from srai.regionizers import Regionizer
 from srai.utils._optional import import_optional_dependencies
-from srai.utils.constants import REGIONS_INDEX, WGS84_CRS
 
 
 class VoronoiRegionizer(Regionizer):

srai/utils/__init__.py

@@ -1,8 +1,6 @@
 """Utilities."""
-
-from .merge import _merge_disjointed_gdf_geometries, _merge_disjointed_polygons
-
-__all__ = [
-    "_merge_disjointed_gdf_geometries",
-    "_merge_disjointed_polygons",
-]
+# flake8: noqa F401
+from .download import *
+from .geocode import *
+from .geometry import *
+from .merge import *

srai/utils/geocode.py

@@ -4,7 +4,7 @@
 import geopandas as gpd
 import osmnx as ox
 
-from srai.utils.constants import REGIONS_INDEX
+from srai.constants import REGIONS_INDEX
 
 
 def geocode_to_region_gdf(

srai/utils/merge.py

@@ -6,7 +6,7 @@
 from shapely.geometry import MultiPolygon, Polygon
 
 
-def _merge_disjointed_polygons(polygons: List[Union[Polygon, MultiPolygon]]) -> MultiPolygon:
+def merge_disjointed_polygons(polygons: List[Union[Polygon, MultiPolygon]]) -> MultiPolygon:
     """
     Merges all polygons into a single MultiPolygon.
 
@@ -27,7 +27,7 @@ def _merge_disjointed_polygons(polygons: List[Union[Polygon, MultiPolygon]]) ->
     return MultiPolygon(single_polygons)
 
 
-def _merge_disjointed_gdf_geometries(gdf: gpd.GeoDataFrame) -> MultiPolygon:
+def merge_disjointed_gdf_geometries(gdf: gpd.GeoDataFrame) -> MultiPolygon:
     """
     Merges geometries from a GeoDataFrame into a single MultiPolygon.
 
@@ -39,4 +39,4 @@ def _merge_disjointed_gdf_geometries(gdf: gpd.GeoDataFrame) -> MultiPolygon:
     Returns:
         MultiPolygon: Merged polygon
     """
-    return _merge_disjointed_polygons(list(gdf.geometry))
+    return merge_disjointed_polygons(list(gdf.geometry))

tests/embedders/conftest.py

@@ -5,7 +5,7 @@
 import pytest
 from shapely import geometry
 
-from srai.utils.constants import WGS84_CRS
+from srai.constants import WGS84_CRS
 
 
 @pytest.fixture  # type: ignore

tests/embedders/test_gtfs2vec_embedder.py

@@ -11,7 +11,7 @@
 from shapely.geometry import Polygon
 
 from srai.embedders import GTFS2VecEmbedder
-from srai.utils.exceptions import ModelNotFitException
+from srai.exceptions import ModelNotFitException
 
 
 @pytest.fixture  # type: ignore

tests/joiners/conftest.py

@@ -5,7 +5,7 @@
 import pytest
 from shapely import geometry
 
-from srai.utils.constants import WGS84_CRS
+from srai.constants import WGS84_CRS
 
 
 @pytest.fixture  # type: ignore

tests/loaders/osm_loaders/conftest.py

@@ -4,7 +4,7 @@
 import pytest
 from shapely.geometry import Point, Polygon
 
-from srai.utils.constants import WGS84_CRS
+from srai.constants import WGS84_CRS
 
 
 @pytest.fixture  # type: ignore

tests/loaders/osm_loaders/test_osm_online_loader.py

@@ -6,9 +6,9 @@
 from pandas.testing import assert_frame_equal
 from shapely.geometry import Polygon
 
+from srai.constants import WGS84_CRS
 from srai.loaders.osm_loaders import OSMOnlineLoader
 from srai.loaders.osm_loaders.filters.osm_tags_type import osm_tags_type
-from srai.utils.constants import WGS84_CRS
 
 
 @pytest.fixture  # type: ignore

tests/loaders/osm_loaders/test_osm_pbf_loader.py

@@ -7,12 +7,12 @@
 from shapely.geometry import MultiPolygon, Point, Polygon
 from shapely.geometry.base import BaseGeometry
 
+from srai.constants import REGIONS_INDEX, WGS84_CRS
 from srai.loaders.osm_loaders import OSMPbfLoader
 from srai.loaders.osm_loaders.filters.hex2vec import HEX2VEC_FILTER
 from srai.loaders.osm_loaders.filters.osm_tags_type import osm_tags_type
 from srai.loaders.osm_loaders.pbf_file_downloader import PbfFileDownloader
 from srai.loaders.osm_loaders.pbf_file_handler import PbfFileHandler
-from srai.utils.constants import REGIONS_INDEX, WGS84_CRS
 
 
 @pytest.mark.parametrize(  # type: ignore

tests/loaders/test_geoparquet_loader.py

@@ -5,8 +5,8 @@
 import pytest
 from shapely.geometry import box
 
+from srai.constants import WGS84_CRS
 from srai.loaders import GeoparquetLoader
-from srai.utils.constants import WGS84_CRS
 
 bbox = box(minx=-180, maxx=180, miny=-90, maxy=90)
 bbox_gdf = gpd.GeoDataFrame({"geometry": [bbox]})

tests/miscellaneous/test_optional_dependencies.py

@@ -5,8 +5,8 @@
 
 import pytest
 
+from srai.constants import WGS84_CRS
 from srai.utils._optional import ImportErrorHandle, import_optional_dependency
-from srai.utils.constants import WGS84_CRS
 
 
 @pytest.fixture(autouse=True)  # type: ignore

tests/neighbourhoods/test_adjacency_neighbourhood.py

@@ -4,8 +4,8 @@
 import pytest
 from shapely import geometry
 
+from srai.constants import WGS84_CRS
 from srai.neighbourhoods import AdjacencyNeighbourhood
-from srai.utils.constants import WGS84_CRS
 
 
 @pytest.fixture  # type: ignore

tests/regionizers/conftest.py

@@ -4,7 +4,7 @@
 import pytest
 from shapely import geometry
 
-from srai.utils.constants import WGS84_CRS
+from srai.constants import WGS84_CRS
 
 
 @pytest.fixture  # type: ignore