ssb-sgis 1.0.13__py3-none-any.whl → 1.0.15__py3-none-any.whl

sgis/maps/wms.py

@@ -0,0 +1,187 @@
+import abc
+import datetime
+import json
+import re
+from collections.abc import Iterable
+from dataclasses import dataclass
+from pathlib import Path
+from typing import Any
+from urllib.request import urlopen
+
+import folium
+import shapely
+
+from ..geopandas_tools.conversion import to_shapely
+
+JSON_PATH = Path(__file__).parent / "norge_i_bilder.json"
+
+DEFAULT_YEARS: tuple[str] = tuple(
+    str(year)
+    for year in range(
+        int(datetime.datetime.now().year) - 8,
+        int(datetime.datetime.now().year) + 1,
+    )
+)
+
+
+@dataclass
+class WmsLoader(abc.ABC):
+    """Abstract base class for wms loaders.
+
+    Child classes must implement the method 'get_tiles',
+    which should return a list of folium.WmsTileLayer.
+    """
+
+    @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.
+
+        Not needed in sgis.explore.
+        """
+        pass
+
+
+@dataclass
+class NorgeIBilderWms(WmsLoader):
+    """Loads Norge i bilder tiles as folium.WmsTiles."""
+
+    years: Iterable[int | str] = DEFAULT_YEARS
+    contains: str | Iterable[str] | None = None
+    not_contains: str | Iterable[str] | None = None
+
+    def load_tiles(self) -> None:
+        """Load all Norge i bilder tiles into self.tiles."""
+        url = "https://wms.geonorge.no/skwms1/wms.nib-prosjekter?SERVICE=WMS&REQUEST=GetCapabilities"
+
+        name_pattern = r"<Name>(.*?)</Name>"
+        bbox_pattern = (
+            r"<EX_GeographicBoundingBox>.*?"
+            r"<westBoundLongitude>(.*?)</westBoundLongitude>.*?"
+            r"<eastBoundLongitude>(.*?)</eastBoundLongitude>.*?"
+            r"<southBoundLatitude>(.*?)</southBoundLatitude>.*?"
+            r"<northBoundLatitude>(.*?)</northBoundLatitude>.*?</EX_GeographicBoundingBox>"
+        )
+
+        all_tiles: list[dict] = []
+        with urlopen(url) as file:
+            xml_data: str = file.read().decode("utf-8")
+
+            for text in xml_data.split('<Layer queryable="1">')[1:]:
+
+                # Extract bounding box values
+                bbox_match = re.search(bbox_pattern, text, re.DOTALL)
+                if bbox_match:
+                    minx, maxx, miny, maxy = (
+                        float(bbox_match.group(i)) for i in [1, 2, 3, 4]
+                    )
+                    this_bbox = shapely.box(minx, miny, maxx, maxy)
+                else:
+                    this_bbox = None
+
+                name_match = re.search(name_pattern, text, re.DOTALL)
+                name = name_match.group(1) if name_match else None
+
+                if (
+                    not name
+                    or not any(year in name for year in self.years)
+                    or (
+                        self.contains
+                        and not any(re.search(x, name.lower()) for x in self.contains)
+                    )
+                    or (
+                        self.not_contains
+                        and any(re.search(x, name.lower()) for x in self.not_contains)
+                    )
+                ):
+                    continue
+
+                this_tile = {}
+                this_tile["name"] = name
+                this_tile["bbox"] = this_bbox
+                year = name.split(" ")[-1]
+                if year.isnumeric() and len(year) == 4:
+                    this_tile["year"] = year
+                else:
+                    this_tile["year"] = "9999"
+                all_tiles.append(this_tile)
+
+        self.tiles = sorted(all_tiles, key=lambda x: x["year"])
+
+    def get_tiles(self, bbox: Any, max_zoom: int = 40) -> list[folium.WmsTileLayer]:
+        """Get all Norge i bilder tiles intersecting with a bbox."""
+        if self.tiles is None:
+            self.load_tiles()
+
+        all_tiles = {}
+
+        bbox = to_shapely(bbox)
+
+        for tile in self.tiles:
+            if not tile["bbox"] or not tile["bbox"].intersects(bbox):
+                continue
+
+            name = tile["name"]
+
+            if (
+                not name
+                or not any(year in name for year in self.years)
+                or (
+                    self.contains
+                    and not any(re.search(x, name.lower()) for x in self.contains)
+                )
+                or (
+                    self.not_contains
+                    and any(re.search(x, name.lower()) for x in self.not_contains)
+                )
+            ):
+                continue
+
+            all_tiles[name] = folium.WmsTileLayer(
+                url="https://wms.geonorge.no/skwms1/wms.nib-prosjekter",
+                name=name,
+                layers=name,
+                format="image/png",  # Tile format
+                transparent=True,  # Allow transparency
+                version="1.3.0",  # WMS version
+                attr="&copy; <a href='https://www.geonorge.no/'>Geonorge</a>",
+                show=False,
+                max_zoom=max_zoom,
+            )
+
+        return all_tiles
+
+    def __post_init__(self) -> None:
+        """Fix typings."""
+        if self.contains and isinstance(self.contains, str):
+            self.contains = [self.contains.lower()]
+        elif self.contains:
+            self.contains = [x.lower() for x in self.contains]
+
+        if self.not_contains and isinstance(self.not_contains, str):
+            self.not_contains = [self.not_contains.lower()]
+        elif self.not_contains:
+            self.not_contains = [x.lower() for x in self.not_contains]
+
+        self.years = [str(int(year)) for year in self.years]
+
+        if all(year in DEFAULT_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 != "bbox" 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

{ssb_sgis-1.0.13.dist-info → ssb_sgis-1.0.15.dist-info}/METADATA

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

{ssb_sgis-1.0.13.dist-info → ssb_sgis-1.0.15.dist-info}/RECORD

@@ -1,4 +1,4 @@
-sgis/__init__.py,sha256=kqHf60QUo0_TaB1ikBQXkxCQK4hUjSM6u_GKfLJ3C-4,7351
+sgis/__init__.py,sha256=Bh-W4cB6-1uc-xRzUxqxECwwoennpdlikZI3gwXtZ7E,7389
 sgis/debug_config.py,sha256=Tfr19kU46hSkkspsIJcrUWvlhaL4U3-f8xEPkujSCAQ,593
 sgis/exceptions.py,sha256=WNaEBPNNx0rmz-YDzlFX4vIE7ocJQruUTqS2RNAu2zU,660
 sgis/geopandas_tools/__init__.py,sha256=bo8lFMcltOz7TtWAi52_ekR2gd3mjfBfKeMDV5zuqFY,28
@@ -24,13 +24,15 @@ sgis/io/opener.py,sha256=HWO3G1NB6bpXKM94JadCD513vjat1o1TFjWGWzyVasg,898
 sgis/io/read_parquet.py,sha256=FvZYv1rLkUlrSaUY6QW6E1yntmntTeQuZ9ZRgCDO4IM,3776
 sgis/maps/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 sgis/maps/examine.py,sha256=Pb0dH8JazU5E2svfQrzHO1Bi-sjy5SeyY6zoeMO34jE,9369
-sgis/maps/explore.py,sha256=dHwQmD_8U9dLaBJHs2VKJvqK-yNUhH6yZoInF0iFrAE,46237
+sgis/maps/explore.py,sha256=JX9ZTeHVsV1KsXP2YNVBa21Edvc6EksKdbb3V6W0tKs,47051
 sgis/maps/httpserver.py,sha256=7Od9JMCtntcIQKk_TchetojMHzFHT9sPw7GANahI97c,1982
 sgis/maps/legend.py,sha256=lVRVCkhPmJRjGK23obFJZAO3qp6du1LYnobkkN7DPkc,26279
 sgis/maps/map.py,sha256=smaf9i53EoRZWmZjn9UuqlhzUvVs1XKo2ItIpHxyuik,29592
-sgis/maps/maps.py,sha256=9uidfWhbdJzO6lzDUjn4EWJMpCtc4st3uy4dRbNRVtQ,22430
+sgis/maps/maps.py,sha256=gxu0rgcVygjudRtM1dVRmsUMilMUIg3vG-UgvASM91E,23072
+sgis/maps/norge_i_bilder.json,sha256=W_mFfte3DxugWbEudZ5fadZ2JeFYb0hyab2Quf4oJME,481311
 sgis/maps/thematicmap.py,sha256=yAE1xEfubJcDmBlOJf-Q3SVae1ZHIEMP-YB95Wy8cRw,21691
 sgis/maps/tilesources.py,sha256=F4mFHxPwkiPJdVKzNkScTX6xbJAMIUtlTq4mQ83oguw,1746
+sgis/maps/wms.py,sha256=XHlCszR0raPbmUc2wYpQ_XRHnSJ6c1ic3w2dNnfMRm4,6252
 sgis/networkanalysis/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 sgis/networkanalysis/_get_route.py,sha256=9I3t9pnccUPr4mozy3TJCOpGCCf3UOIojmsbifubZbA,6368
 sgis/networkanalysis/_od_cost_matrix.py,sha256=zkyPX7ObT996ahaFJ2oI0D0SqQWbWyfy_qLtXwValPg,3434
@@ -54,7 +56,7 @@ sgis/raster/indices.py,sha256=-J1HYmnT240iozvgagvyis6K0_GHZHRuUrPOgyoeIrY,223
 sgis/raster/regex.py,sha256=kYhVpRYzoXutx1dSYmqMoselWXww7MMEsTPmLZwHjbM,3759
 sgis/raster/sentinel_config.py,sha256=nySDqn2R8M6W8jguoBeSAK_zzbAsqmaI59i32446FwY,1268
 sgis/raster/zonal.py,sha256=D4Gyptw-yOLTCO41peIuYbY-DANsJCG19xXDlf1QAz4,2299
-ssb_sgis-1.0.13.dist-info/LICENSE,sha256=np3IfD5m0ZUofn_kVzDZqliozuiO6wrktw3LRPjyEiI,1073
-ssb_sgis-1.0.13.dist-info/METADATA,sha256=H0AhyHQ3_Va2WmbAkd5IgycphRpYVw0GyctqeIAqQt0,11741
-ssb_sgis-1.0.13.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-ssb_sgis-1.0.13.dist-info/RECORD,,
+ssb_sgis-1.0.15.dist-info/LICENSE,sha256=np3IfD5m0ZUofn_kVzDZqliozuiO6wrktw3LRPjyEiI,1073
+ssb_sgis-1.0.15.dist-info/METADATA,sha256=bRaj-9WssZ9IsI2IPEtI_uyLGhpEWd52xfMst-vI3g4,11741
+ssb_sgis-1.0.15.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+ssb_sgis-1.0.15.dist-info/RECORD,,