ssb-sgis 1.2.17__py3-none-any.whl → 1.3.1__py3-none-any.whl

sgis/maps/wms.py

@@ -3,7 +3,6 @@ import datetime
 import json
 import re
 from collections.abc import Iterable
-from dataclasses import dataclass
 from io import BytesIO
 from pathlib import Path
 from typing import Any
@@ -28,20 +27,14 @@ from ..geopandas_tools.conversion import to_shapely
 from ..geopandas_tools.sfilter import sfilter
 from ..raster.image_collection import Band
 
-JSON_PATH = Path(__file__).parent / "norge_i_bilder.json"
-
-JSON_YEARS = [str(year) for year in range(2006, datetime.datetime.now().year + 1)]
-
-DEFAULT_YEARS: tuple[str] = tuple(
-    str(year)
-    for year in range(
+DEFAULT_YEARS: tuple[int] = tuple(
+    range(
         int(datetime.datetime.now().year) - 10,
         int(datetime.datetime.now().year) + 1,
     )
 )
 
 
-@dataclass
 class WmsLoader(abc.ABC):
     """Abstract base class for wms loaders.
 
@@ -49,32 +42,84 @@ class WmsLoader(abc.ABC):
     which should return a list of folium.WmsTileLayer.
     """
 
+    _min_year: int = 1900
+
+    @abc.abstractmethod
+    def filter_tiles(
+        self, mask: GeoDataFrame | GeoSeries | Geometry | tuple[float]
+    ) -> list[str]:
+        """Filter relevant dates with pandas and geopandas because fast."""
+
     @abc.abstractmethod
     def get_tiles(self, bbox: Any, max_zoom: int = 40) -> list[folium.WmsTileLayer]:
         """Get all tiles intersecting with a bbox."""
 
     @abc.abstractmethod
     def load_tiles(self) -> None:
-        """Load all tiles into self.tiles.
+        """Load all tiles into self._tiles.
 
         Not needed in sgis.explore.
         """
         pass
 
+    def __repr__(self) -> str:
+        """Print representation."""
+        return str(self)
+
+    def __str__(self) -> str:
+        """String representation."""
+
+        def maybe_to_string(value: Any):
+            if isinstance(value, str):
+                return f"'{value}'"
+            return value
+
+        txt = ", ".join(
+            f"{k}={maybe_to_string(v)}"
+            for k, v in self.__dict__.items()
+            if not k.startswith("_")
+        )
+        return f"{self.__class__.__name__}({txt})"
+
 
-@dataclass
 class NorgeIBilderWms(WmsLoader):
-    """Loads Norge i bilder tiles as folium.WmsTiles."""
+    """Loads Norge i bilder tiles as folium.WmsTiles.
+
+    Args:
+        years: list of years to search for images.
+        contains: substrings to include in image search.
+        not_contains: substrings to exclude in image search.
+        show: Whether to show all layers upon initialisation of the map.
+        _use_json: Whether to use pre-made json file of image names and bounds/masks
+            if all years are within range. Defaults to True (much faster).
+    """
 
-    years: Iterable[int | str] = DEFAULT_YEARS
-    contains: str | Iterable[str] | None = None
-    not_contains: str | Iterable[str] | None = None
-    show: bool | Iterable[int] | int = False
-    _use_json: bool = True
     url: str = "https://wms.geonorge.no/skwms1/wms.nib-prosjekter"
+    _min_year: int = 1935
+    _json_path = Path(__file__).parent / "norge_i_bilder.json"
+
+    def __init__(
+        self,
+        years: Iterable[int | str] = DEFAULT_YEARS,
+        contains: str | Iterable[str] | None = None,
+        not_contains: str | Iterable[str] | None = None,
+        show: bool | Iterable[int] | int = False,
+        _use_json: bool = True,
+    ) -> None:
+        """Initialiser."""
+        self.years = [int(year) for year in years]
+        self.contains = contains
+        self.not_contains = not_contains
+        self.show = show
+        self._use_json = _use_json
+
+        if self._use_json:
+            self._load_from_json()
+        else:
+            self._tiles = None
 
     def load_tiles(self, verbose: bool = False) -> None:
-        """Load all Norge i bilder tiles into self.tiles."""
+        """Load all Norge i bilder tiles into self._tiles."""
         name_pattern = r"<Name>(.*?)</Name>"
         bbox_pattern = (
             r"<EX_GeographicBoundingBox>.*?"
@@ -84,8 +129,12 @@ class NorgeIBilderWms(WmsLoader):
             r"<northBoundLatitude>(.*?)</northBoundLatitude>.*?</EX_GeographicBoundingBox>"
         )
 
+        url: str = (
+            "https://wms.geonorge.no/skwms1/wms.nib-prosjekter?SERVICE=WMS&REQUEST=GetCapabilities"
+        )
+
         all_tiles: list[dict] = []
-        with urlopen(self.url) as file:
+        with urlopen(url) as file:
             xml_data: str = file.read().decode("utf-8")
 
             for text in xml_data.split('<Layer queryable="1">')[1:]:
@@ -105,14 +154,20 @@ class NorgeIBilderWms(WmsLoader):
 
                 if (
                     not name
-                    or not any(year in name for year in self.years)
+                    or not any(str(year) in name for year in self.years)
                     or (
                         self.contains
-                        and not any(re.search(x, name.lower()) for x in self.contains)
+                        and not any(
+                            re.search(x, name.lower())
+                            for x in _string_as_list(self.contains)
+                        )
                     )
                     or (
                         self.not_contains
-                        and any(re.search(x, name.lower()) for x in self.not_contains)
+                        and any(
+                            re.search(x, name.lower())
+                            for x in _string_as_list(self.not_contains)
+                        )
                     )
                 ):
                     continue
@@ -131,10 +186,10 @@ class NorgeIBilderWms(WmsLoader):
 
                 all_tiles.append(this_tile)
 
-        self.tiles = sorted(all_tiles, key=lambda x: (x["year"]))
+        self._tiles = sorted(all_tiles, key=lambda x: (x["year"]))
 
         masks = self._get_norge_i_bilder_polygon_masks(verbose=verbose)
-        for tile in self.tiles:
+        for tile in self._tiles:
             mask = masks.get(tile["name"], None)
             tile["geometry"] = mask
 
@@ -143,7 +198,7 @@ class NorgeIBilderWms(WmsLoader):
         from owslib.wms import WebMapService
         from PIL import Image
 
-        relevant_names: dict[str, str] = {x["name"]: x["bbox"] for x in self.tiles}
+        relevant_names: dict[str, str] = {x["name"]: x["bbox"] for x in self._tiles}
         assert len(relevant_names), relevant_names
 
         url = "https://wms.geonorge.no/skwms1/wms.nib-mosaikk?SERVICE=WMS&REQUEST=GetCapabilities"
@@ -214,7 +269,7 @@ class NorgeIBilderWms(WmsLoader):
 
     def get_tiles(self, mask: Any, max_zoom: int = 40) -> list[folium.WmsTileLayer]:
         """Get all Norge i bilder tiles intersecting with a mask (bbox or polygon)."""
-        if self.tiles is None:
+        if self._tiles is None:
             self.load_tiles()
 
         if not isinstance(mask, (GeoSeries | GeoDataFrame | Geometry)):
@@ -225,7 +280,7 @@ class NorgeIBilderWms(WmsLoader):
         else:
             show = False
 
-        relevant_tiles = self._filter_tiles(mask)
+        relevant_tiles = self.filter_tiles(mask)
         tile_layers = {
             name: folium.WmsTileLayer(
                 url="https://wms.geonorge.no/skwms1/wms.nib-prosjekter",
@@ -238,7 +293,7 @@ class NorgeIBilderWms(WmsLoader):
                 show=show,
                 max_zoom=max_zoom,
             )
-            for name in relevant_tiles["name"]
+            for name in relevant_tiles
         }
 
         if not len(tile_layers):
@@ -254,59 +309,51 @@ class NorgeIBilderWms(WmsLoader):
 
         return tile_layers
 
-    def _filter_tiles(self, mask):
+    def filter_tiles(
+        self, mask: GeoDataFrame | GeoSeries | Geometry | tuple[float]
+    ) -> list[str]:
         """Filter relevant dates with pandas and geopandas because fast."""
-        if not self.tiles:
-            return pd.DataFrame(columns=["name", "year", "geometry", "bbox"])
-        df = pd.DataFrame(self.tiles)
-        filt = (df["name"].notna()) & (df["year"].str.contains("|".join(self.years)))
+        if not self._tiles:
+            return []
+        df = pd.DataFrame(self._tiles)
+        filt = (df["name"].notna()) & (
+            df["year"].str.contains("|".join([str(year) for year in self.years]))
+        )
         if self.contains:
-            for x in self.contains:
+            for x in _string_as_list(self.contains):
                 filt &= df["name"].str.contains(x)
         if self.not_contains:
-            for x in self.not_contains:
+            for x in _string_as_list(self.not_contains):
                 filt &= ~df["name"].str.contains(x)
         df = df[filt]
         geoms = np.where(df["geometry"].notna(), df["geometry"], df["bbox"])
         geoms = GeoSeries(geoms)
         assert geoms.index.is_unique
-        return df.iloc[sfilter(geoms, mask).index]
-
-    def __post_init__(self) -> None:
-        """Fix typings."""
-        if self.contains and isinstance(self.contains, str):
-            self.contains = [self.contains]
-        elif self.contains:
-            self.contains = [x for x in self.contains]
-        if self.not_contains and isinstance(self.not_contains, str):
-            self.not_contains = [self.not_contains]
-        elif self.not_contains:
-            self.not_contains = [x for x in self.not_contains]
-
-        self.years = [str(int(year)) for year in self.years]
-
-        if self._use_json and all(year in JSON_YEARS for year in self.years):
-            try:
-                with open(JSON_PATH, encoding="utf-8") as file:
-                    self.tiles = json.load(file)
-            except FileNotFoundError:
-                self.tiles = None
-                return
-            self.tiles = [
-                {
-                    key: (
-                        value
-                        if key not in ["bbox", "geometry"]
-                        else shapely.wkt.loads(value)
-                    )
-                    for key, value in tile.items()
-                }
-                for tile in self.tiles
-                if any(str(year) in tile["name"] for year in self.years)
-            ]
-        else:
-            self.tiles = None
+        return list(df.iloc[sfilter(geoms, mask).index]["name"])
+
+    def _load_from_json(self) -> None:
+        """Load tiles from json file."""
+        try:
+            with open(self._json_path, encoding="utf-8") as file:
+                self._tiles = json.load(file)
+        except FileNotFoundError:
+            self._tiles = None
+            return
+        self._tiles = [
+            {
+                key: (
+                    value
+                    if key not in ["bbox", "geometry"]
+                    else shapely.wkt.loads(value)
+                )
+                for key, value in tile.items()
+            }
+            for tile in self._tiles
+            if any(str(year) in tile["name"] for year in self.years)
+        ]
 
-    def __repr__(self) -> str:
-        """Print representation."""
-        return f"{self.__class__.__name__}({len(self.tiles or [])})"
+
+def _string_as_list(x: str | list[str]) -> list[str] | None:
+    if not x:
+        return None
+    return [x] if isinstance(x, str) else list(x)

{ssb_sgis-1.2.17.dist-info → ssb_sgis-1.3.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ssb-sgis
-Version: 1.2.17
+Version: 1.3.1
 Summary: GIS functions used at Statistics Norway.
 Home-page: https://github.com/statisticsnorway/ssb-sgis
 License: MIT

{ssb_sgis-1.2.17.dist-info → ssb_sgis-1.3.1.dist-info}/RECORD

@@ -9,7 +9,7 @@ sgis/geopandas_tools/centerlines.py,sha256=Q65Sx01SeAlulBEd9oaZkB2maBBNdLcJwAbTI
 sgis/geopandas_tools/cleaning.py,sha256=fST0xFztmyn-QUOAfvjZmu7aO_zPiolWK7gd7TR6ffI,24393
 sgis/geopandas_tools/conversion.py,sha256=iX954YEpobmn_R1Ecx_zDU1RlWq_67pfbzMXtwTH04I,24162
 sgis/geopandas_tools/duplicates.py,sha256=TDDM4u1n7SIkyJrOfl1Lno92AmUPqtXBHsj1IUKC0hI,14992
-sgis/geopandas_tools/general.py,sha256=YRpNEdwTHyFdQOdAfbCmYXS7PxoDjXxoagwpteXkYdI,43937
+sgis/geopandas_tools/general.py,sha256=DTQM8p-krgR3gA3miP931eCrxDCpF1ya7dRiMy3K_bs,44099
 sgis/geopandas_tools/geocoding.py,sha256=sZjUW52ULhQWDLmU51C9_itBePkDuWkp8swvYaiYmJk,679
 sgis/geopandas_tools/geometry_types.py,sha256=ijQDbQaZPqPGjBl707H4yooNXpk21RXyatI7itnvqLk,7603
 sgis/geopandas_tools/neighbors.py,sha256=VZGOwwC3-C6KpwLQ3j0K5cOVInmckxIXoGMqPGkemk4,17606
@@ -23,7 +23,7 @@ sgis/geopandas_tools/utils.py,sha256=X0pRvB1tWgV_0BCrRS1HU9LtLGnZCpvVPxyqM9JGb0Y
 sgis/helpers.py,sha256=4N6vFWQ3TYVzRHNcWY_fNa_GkFuaZB3vtCkkFND-qs0,9628
 sgis/io/__init__.py,sha256=uyBr20YDqB2bQttrd5q1JuGOvX32A-MSvS7Wmw5f5qg,177
 sgis/io/_is_dapla.py,sha256=wmfkSe98IrLhUg3dtXZusV6OVC8VlY1kbc5EQDf3P-Q,358
-sgis/io/dapla_functions.py,sha256=quq2HkeR0MZSacllDXjVJlthZebT2ATbU6mjsxODOVA,31796
+sgis/io/dapla_functions.py,sha256=YkS2QqNyZ_OcZXXUKnHEItvnO9vZ22k7RK30p-kGl0E,31861
 sgis/io/opener.py,sha256=HWO3G1NB6bpXKM94JadCD513vjat1o1TFjWGWzyVasg,898
 sgis/io/read_parquet.py,sha256=FvZYv1rLkUlrSaUY6QW6E1yntmntTeQuZ9ZRgCDO4IM,3776
 sgis/maps/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -33,10 +33,10 @@ sgis/maps/httpserver.py,sha256=I7tTn3hFaTCc-E-T_o9v0nXwMGaS2Xqd4MlWbq8k-J4,3014
 sgis/maps/legend.py,sha256=gTEWCVIZH1cw6ULVVrJqRR4__uOZvrT3xxQ5lhZMVR4,26899
 sgis/maps/map.py,sha256=iGa0o7NlUMErJCYJpVzkpDvuWJc8iDN_-tH2X2WcBlI,30802
 sgis/maps/maps.py,sha256=fLK5WUlQ2YTm7t-8260lYxCFvpZN6j0Y-bVYCyv8NAY,23249
-sgis/maps/norge_i_bilder.json,sha256=G9DIN_2vyn-18UF5wUC-koZxFCbiNxMu0BbCJhMFJUk,15050340
+sgis/maps/norge_i_bilder.json,sha256=wUYY8VTanI-C4bpNk7bmnQb8S-S3CBUIRLgdOoydnoQ,20197311
 sgis/maps/thematicmap.py,sha256=ZtV4Hfylr1ST_cPzi11_lFIsTdY3D1o1EZQbPXZLwyM,25187
 sgis/maps/tilesources.py,sha256=F4mFHxPwkiPJdVKzNkScTX6xbJAMIUtlTq4mQ83oguw,1746
-sgis/maps/wms.py,sha256=3ZPf-H3sirvHeLQdXGwE3j6w1sFQCkExsEWkvHl7a4g,11233
+sgis/maps/wms.py,sha256=sCVpKxH1Rsd14GECW7BFh8yaWngpVWYvw9Yhuez1yW8,12482
 sgis/networkanalysis/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 sgis/networkanalysis/_get_route.py,sha256=3m5xQdQqGtt51vcI5fcmYQAOQCeBtL6sorDoPxBNf84,7818
 sgis/networkanalysis/_od_cost_matrix.py,sha256=zkyPX7ObT996ahaFJ2oI0D0SqQWbWyfy_qLtXwValPg,3434
@@ -61,7 +61,7 @@ sgis/raster/indices.py,sha256=efJmgfPg_VuSzXFosXV661IendF8CwPFWtMhyP4TMUg,222
 sgis/raster/regex.py,sha256=4idTJ9vFtsGtbxcjJrx2VrpJJuDMP3bLdqF93Vc_cmY,3752
 sgis/raster/sentinel_config.py,sha256=nySDqn2R8M6W8jguoBeSAK_zzbAsqmaI59i32446FwY,1268
 sgis/raster/zonal.py,sha256=D4Gyptw-yOLTCO41peIuYbY-DANsJCG19xXDlf1QAz4,2299
-ssb_sgis-1.2.17.dist-info/LICENSE,sha256=np3IfD5m0ZUofn_kVzDZqliozuiO6wrktw3LRPjyEiI,1073
-ssb_sgis-1.2.17.dist-info/METADATA,sha256=9bFaOD-bXLRJ_2MGquhQqYXOwttbTd2E71s_O94yNAw,11625
-ssb_sgis-1.2.17.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-ssb_sgis-1.2.17.dist-info/RECORD,,
+ssb_sgis-1.3.1.dist-info/LICENSE,sha256=np3IfD5m0ZUofn_kVzDZqliozuiO6wrktw3LRPjyEiI,1073
+ssb_sgis-1.3.1.dist-info/METADATA,sha256=mDvP7_0YnM5lKhKcu3IsX3OYwc-vMIL8mT09tBR_u6o,11624
+ssb_sgis-1.3.1.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+ssb_sgis-1.3.1.dist-info/RECORD,,