Refactor

Author: Stefan Kuethe

docs/api/basemaps.md

@@ -2,4 +2,6 @@
 
 ::: openlayers.basemaps.BasemapLayer
 
-::: openlayers.basemaps.Carto
+::: openlayers.basemaps.CartoBasemapLayer
+
+::: openlayers.basemaps.MapTilerBasemapLayer

docs/examples/concepts/basemaps.py

@@ -1,7 +1,8 @@
 import openlayers as ol
+from openlayers.basemaps import CartoBasemapLayer, Carto
 
-# Use OSM basemap
-m = ol.Map(layers=[ol.BasemapLayer.osm()])
+# Use default OSM basemap
+m = ol.Map(layers=[ol.BasemapLayer()])
 
 # Use a CartoDB basemap
-m = ol.Map(layers=[ol.BasemapLayer.carto()])
+m = ol.Map(layers=[CartoBasemapLayer(Carto.DARK_NO_LABELS)])

docs/examples/concepts/layers.py

@@ -11,6 +11,6 @@
 
 m = ol.Map(
     ol.View(rotation=3.14 / 8),
-    layers=[ol.BasemapLayer.carto(), vector]
+    layers=[ol.BasemapLayer(), vector]
 )
 m.add_default_tooltip()

docs/examples/concepts/view.py

@@ -5,7 +5,7 @@
 m = ol.Map(initial_view)
 
 # Change view settings afterwards
-m.set_center((172.606201, -43.556510))
+m.set_center(lon=172.606201, lat=-43.556510)
 m.set_zoom(14)
 
 m.set_view(ol.View(center=(172.606201, -43.556510), zoom=12))

examples/standalone/layers/maptiler_basemap.py

@@ -1,9 +1,10 @@
 import openlayers as ol
 from openlayers.basemaps import MapTilerBasemapLayer, MapTiler, CartoBasemapLayer, Carto
 
-m = ol.Map()
+m = ol.Map(layers=[])
 m.set_zoom(2)
-# m.add_layer(MapTilerBasemapLayer(MapTiler.TONER))
-m.add_layer(CartoBasemapLayer(Carto.VOYAGER_LABELS_UNDER))
-m.add_control(ol.MapTilerGeocodingControl())
+m.add_layer(ol.BasemapLayer())
+# m.add_layer(MapTilerBasemapLayer(MapTiler.AQUARELLE))
+# m.add_layer(CartoBasemapLayer(Carto.VOYAGER_LABELS_UNDER))
+m.add_control(ol.MapTilerGeocodingControl(country="de"))
 m.save()

src/openlayers/basemaps.py

@@ -11,6 +11,29 @@
 from .models.sources import OSM, ImageTileSource, TileJSONSource
 from .constants import MAPTILER_API_KEY_ENV_VAR
 
+# --- OSM
+
+
+class BasemapLayer(LayerLike):
+    """An OSM raster tile layer"""
+
+    def __init__(self) -> None:
+        self._model = TileLayer(id="osm", source=OSM())
+
+    @property
+    def model(self) -> TileLayer:
+        return self._model
+
+
+"""
+ new OGCMapTile({
+    url: 'https://maps.gnosis.earth/ogcapi/collections/NaturalEarth:raster:HYP_HR_SR_OB_DR/map/tiles/WebMercatorQuad',
+    crossOrigin: '',
+  }),
+"""
+
+# --- CartoDB
+
 # light_all,
 # dark_all,
 # light_nolabels,
@@ -58,66 +81,9 @@ def url(self) -> str:
         )
 
 
-class BasemapLayer(LayerLike):
-    def __init__(self, style: str | Carto = None) -> None:
-        if isinstance(style, Carto):
-            self._model = BasemapLayer.carto(style)
-        else:
-            self._model = BasemapLayer.osm()
-
-    @property
-    def model(self) -> TileLayer:
-        return self._model
-
-    @staticmethod
-    def osm() -> TileLayer:
-        """Create a OSM tile layer object
-
-        Returns:
-            An OSM raster tile layer
-
-        Examples:
-            >>> from openlayers.basemaps import BasemapLayer
-            >>> osm = BasemapLayer.osm()
-        """
-        return TileLayer(id="osm", source=OSM())
-
-    @staticmethod
-    def carto(
-        style_name: str | Carto = Carto.DARK_ALL, double_resolution: bool = True
-    ) -> TileLayer:
-        """Create a CartoDB tile layer object
-
-        Note:
-            See [CartoDB/basemap-styles](https://github.com/CartoDB/basemap-styles) for available styles.
-
-        Args:
-            style_name (str | Carto): The name of the style
-            double_resolution (bool): Whether to use double resolution tiles
-
-        Returns:
-            A CartoDB raster tile layer
-
-        Examples:
-            >>> from openlayers.basemaps import BasemapLayer
-            >>> carto = BasemapLayer.carto()
-        """
-        style = CartoRasterStyle(style=style_name, double_resolution=double_resolution)
-        return TileLayer(
-            id=f"carto-{Carto(style_name).value.replace('_', '-').replace('/', '-')}",
-            source=ImageTileSource(url=style.url, attributions=style.attribution),
-        )
-
-
-"""
- new OGCMapTile({
-    url: 'https://maps.gnosis.earth/ogcapi/collections/NaturalEarth:raster:HYP_HR_SR_OB_DR/map/tiles/WebMercatorQuad',
-    crossOrigin: '',
-  }),
-"""
+class CartoBasemapLayer(BasemapLayer):
+    """A CartoDB raster tile layer"""
 
-
-class CartoBasemapLayer(LayerLike):
     def __init__(
         self, style_name: Carto | str = Carto.DARK_ALL, double_resolution: bool = True
     ):
@@ -127,12 +93,13 @@ def __init__(
             source=ImageTileSource(url=style.url, attributions=style.attribution),
         )
 
-    @property
-    def model(self) -> TileLayer:
-        return self._model
+
+# --- MapTiler
 
 
 class MapTiler(Enum):
+    """MapTiler basemap styles"""
+
     BASIC_V2 = "basic-v2"
     STREETS_V2 = "streets-v2"
     HYBRID = "hybrid"
@@ -158,7 +125,9 @@ class MapTilerValidator(BaseModel):
     api_key: str = Field(os.getenv(MAPTILER_API_KEY_ENV_VAR), validate_default=True)
 
 
-class MapTilerBasemapLayer(LayerLike):
+class MapTilerBasemapLayer(BasemapLayer):
+    """A MapTiler raster tile layer"""
+
     def __init__(
         self,
         style_name: MapTiler | str = MapTiler.STREETS_V2,
@@ -175,7 +144,3 @@ def __init__(
             id=f"maptiler-{style}",
             source=TileJSONSource(url=url, tile_size=512, cross_origin="anonymous"),
         )
-
-    @property
-    def model(self) -> TileLayer:
-        return self._model