Fix/addtyping

.github/workflows/docs-build.yml

@@ -23,7 +23,7 @@ jobs:
                   gdalinfo --version
             - name: Install dependencies
               run: |
-                  pip install --no-cache-dir Cython
+                  pip install --no-cache-dir Cython PyYAML==6.0.1
                   pip install -r requirements.txt -r requirements_dev.txt
                   pip install .
             - name: Discover typos with codespell

docs/notebooks/02_using_basemaps.ipynb

@@ -181,8 +181,8 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "import os\n",
-    "import xyzservices.providers as xyz"
+    "# import os\n",
+    "# import xyzservices.providers as xyz"
    ]
   },
   {
@@ -191,8 +191,8 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "basemap = xyz.HEREv3.basicMap\n",
-    "basemap"
+    "# basemap = xyz.HEREv3.basicMap\n",
+    "# basemap"
    ]
   },
   {
@@ -208,7 +208,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "basemap['apiKey'] = os.environ[\"HEREMAPS_API_KEY\"]"
+    "# basemap['apiKey'] = os.environ[\"HEREMAPS_API_KEY\"]"
    ]
   },
   {
@@ -224,9 +224,9 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "m = leafmap.Map()\n",
-    "m.add_basemap(basemap)\n",
-    "m"
+    "# m = leafmap.Map()\n",
+    "# m.add_basemap(basemap)\n",
+    "# m"
    ]
   }
  ],

docs/notebooks/38_plotly.ipynb

@@ -44,7 +44,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "# leafmap.fix_widget_error()"
+    "leafmap.fix_widget_error()"
    ]
   },
   {

leafmap/basemaps.py

@@ -16,6 +16,7 @@
 import ipyleaflet
 import xyzservices.providers as xyz
 from .common import check_package, planet_tiles
+from typing import Dict, Optional, List
 
 # from box import Box
 
@@ -228,7 +229,7 @@ def _unpack_sub_parameters(var, param):
     return temp
 
 
-def get_xyz_dict(free_only=True, france=False):
+def get_xyz_dict(free_only: bool = True, france: bool = False) -> Dict:
     """Returns a dictionary of xyz services.
 
     Args:
@@ -279,7 +280,7 @@ def get_xyz_dict(free_only=True, france=False):
     return xyz_dict
 
 
-def xyz_to_leaflet():
+def xyz_to_leaflet() -> Dict:
     """Convert xyz tile services to ipyleaflet tile layers.
 
     Returns:
@@ -306,7 +307,7 @@ def xyz_to_leaflet():
     return leaflet_dict
 
 
-def xyz_to_pydeck():
+def xyz_to_pydeck() -> Dict:
     """Convert xyz tile services to pydeck custom tile layers.
 
     Returns:
@@ -345,7 +346,7 @@ def xyz_to_pydeck():
     return pydeck_dict
 
 
-def xyz_to_folium():
+def xyz_to_folium() -> Dict:
     """Convert xyz tile services to folium tile layers.
 
     Returns:
@@ -409,7 +410,7 @@ def xyz_to_folium():
     return folium_dict
 
 
-def xyz_to_heremap():
+def xyz_to_heremap() -> Dict:
     """Convert xyz tile services to hermap tile layers.
 
     Returns:
@@ -510,7 +511,7 @@ def xyz_to_heremap():
     return heremap_dict
 
 
-def xyz_to_plotly():
+def xyz_to_plotly() -> Dict:
     """Convert xyz tile services to plotly tile layers.
 
     Returns:
@@ -546,7 +547,7 @@ def xyz_to_plotly():
     return plotly_dict
 
 
-def xyz_to_bokeh():
+def xyz_to_bokeh() -> Dict:
     """Convert xyz tile services to bokeh tile layers.
 
     Returns:
@@ -600,13 +601,13 @@ def search_qms(keywords, limit=10):
         return services["results"][:limit]
 
 
-def get_qms(service_id):
+def get_qms(service_id: str) -> Dict:
     QMS_API = "https://qms.nextgis.com/api/v1/geoservices"
     service_details = requests.get(f"{QMS_API}/{service_id}")
     return service_details.json()
 
 
-def qms_to_leafmap(service_id):
+def qms_to_leafmap(service_id: str) -> Dict:
     service_details = get_qms(service_id)
     name = service_details["name"]
     url = service_details["url"]

leafmap/bokehmap.py

@@ -6,6 +6,7 @@
 from bokeh.io import output_notebook
 from .basemaps import xyz_to_bokeh
 from .common import *
+from typing import Optional, List, Sequence, Tuple, Dict
 
 os.environ["OUTPUT_NOTEBOOK"] = "False"
 basemaps = Box(xyz_to_bokeh(), frozen_box=True)
@@ -14,13 +15,13 @@
 class Map:
     def __init__(
         self,
-        center=[10, 0],
-        zoom=2,
-        width=800,
-        height=400,
-        basemap="OpenStreetMap",
-        grid_visible=False,
-        output_notebook=True,
+        center: List[float] = [10, 0],
+        zoom: float = 2,
+        width: float = 800,
+        height: float = 400,
+        basemap: Optional[str] = "OpenStreetMap",
+        grid_visible: bool = False,
+        output_notebook: bool = True,
         **kwargs,
     ):
         if "x_axis_type" not in kwargs:
@@ -67,7 +68,12 @@ def _repr_mimebundle_(self, **kwargs):
             os.environ["OUTPUT_NOTEBOOK"] = "True"
         show(self.figure)
 
-    def add_basemap(self, basemap="OpenStreetMap", retina=True, **kwargs):
+    def add_basemap(
+        self,
+        basemap: Optional[str] = "OpenStreetMap",
+        retina: Optional[bool] = True,
+        **kwargs,
+    ):
         """Adds a basemap to the map.
 
         Args:
@@ -104,8 +110,10 @@ def add_basemap(self, basemap="OpenStreetMap", retina=True, **kwargs):
                     raise ValueError(
                         f"Basemap {basemap} is not supported. Please choose one from {basemaps.keys()}"
                     )
+        elif basemap is None:
+            raise ValueError("Please specify a valid basemap")
 
-    def add_tile(self, tile, **kwargs):
+    def add_tile(self, tile: str, **kwargs):
         """Adds a tile to the map.
 
         Args:
@@ -121,12 +129,12 @@ def add_tile(self, tile, **kwargs):
 
     def add_cog_layer(
         self,
-        url,
-        attribution="",
-        bands=None,
-        titiler_endpoint=None,
-        cog_args={},
-        fit_bounds=True,
+        url: str,
+        attribution: str = "",
+        bands: Optional[List[str]] = None,
+        titiler_endpoint: Optional[str] = None,
+        cog_args: Dict = {},
+        fit_bounds: bool = True,
         **kwargs,
     ):
         """Adds a COG TileLayer to the map.
@@ -155,15 +163,15 @@ def add_cog_layer(
 
     def add_raster(
         self,
-        source,
-        band=None,
-        palette=None,
-        vmin=None,
-        vmax=None,
-        nodata=None,
-        attribution="",
+        source: str,
+        band: Optional[List] = None,
+        palette: Optional[str] = None,
+        vmin: Optional[float] = None,
+        vmax: Optional[float] = None,
+        nodata: Optional[float] = None,
+        attribution: Optional[str] = "",
+        fit_bounds: bool = True,
         layer_name="Local COG",
-        fit_bounds=True,
         open_args={},
         **kwargs,
     ):
@@ -218,22 +226,22 @@ def add_raster(
 
     def add_stac_layer(
         self,
-        url=None,
-        collection=None,
-        item=None,
-        assets=None,
-        bands=None,
-        titiler_endpoint=None,
-        attribution="",
-        fit_bounds=True,
+        url: str,
+        collection: Optional[str] = None,
+        item: Optional[str] = None,
+        assets: Optional[str] = None,
+        bands: Optional[List[str]] = None,
+        titiler_endpoint: Optional[str] = None,
+        attribution: Optional[str] = "",
+        fit_bounds: Optional[bool] = True,
         open_args={},
         **kwargs,
     ):
         """Adds a STAC TileLayer to the map.
 
         Args:
             url (str): HTTP URL to a STAC item, e.g., https://canada-spot-ortho.s3.amazonaws.com/canada_spot_orthoimages/canada_spot5_orthoimages/S5_2007/S5_11055_6057_20070622/S5_11055_6057_20070622.json
-            collection (str): The Microsoft Planetary Computer STAC collection ID, e.g., landsat-8-c2-l2.
+            collection (str | Optional): The Microsoft Planetary Computer STAC collection ID, e.g., landsat-8-c2-l2.
             item (str): The Microsoft Planetary Computer STAC item ID, e.g., LC08_L2SP_047027_20201204_02_T1.
             assets (str | list): The Microsoft Planetary Computer STAC asset ID, e.g., ["SR_B7", "SR_B5", "SR_B4"].
             bands (list): A list of band names, e.g., ["SR_B7", "SR_B5", "SR_B4"]
@@ -304,20 +312,20 @@ def add_gdf(
 
     def add_geojson(
         self,
-        filename,
-        encoding="utf-8",
-        read_file_args={},
-        to_crs="epsg:3857",
-        tooltips=None,
-        fit_bounds=True,
+        filename: str,
+        encoding: Optional[str] = "utf-8",
+        read_file_args: Dict = {},
+        to_crs: Optional[str] = "epsg:3857",
+        tooltips: Optional[List] = None,
+        fit_bounds: bool = True,
         **kwargs,
     ):
         """Adds a GeoJSON file to the map.
 
         Args:
             filename (str): The path to the GeoJSON file. Can be a local file or a URL.
             encoding (str, optional): The encoding of the GeoJSON file. Defaults to "utf-8".
-            read_file_args (dict, optional): A dictionary of arguments to pass to geopandas.read_file. Defaults to {}.
+            read_file_args (Dict, optional): A dictionary of arguments to pass to geopandas.read_file. Defaults to {}.
             to_crs (str, optional): The CRS to use for the GeoDataFrame. Defaults to "epsg:3857".
             tooltips (list, optional): A list of column names to use for tooltips in the form of [(name, @column_name), ...]. Defaults to None, which uses all columns.
             fit_bounds (bool, optional): A flag indicating whether to fit the map bounds to the GeoJSON. Defaults to True.
@@ -336,20 +344,20 @@ def add_geojson(
 
     def add_shp(
         self,
-        filename,
-        encoding="utf-8",
-        read_file_args={},
-        to_crs="epsg:3857",
-        tooltips=None,
-        fit_bounds=True,
+        filename: str,
+        encoding: Optional[str] = "utf-8",
+        read_file_args: Dict = {},
+        to_crs: Optional[str] = "epsg:3857",
+        tooltips: Optional[List] = None,
+        fit_bounds: bool = True,
         **kwargs,
     ):
         """Adds a shapefile to the map.
 
         Args:
             filename (str): The path to the shapefile.
             encoding (str, optional): The encoding of the shapefile. Defaults to "utf-8".
-            read_file_args (dict, optional): A dictionary of arguments to pass to geopandas.read_file. Defaults to {}.
+            read_file_args (Dict, optional): A dictionary of arguments to pass to geopandas.read_file. Defaults to {}.
             to_crs (str, optional): The CRS to use for the GeoDataFrame. Defaults to "epsg:3857".
             tooltips (list, optional): A list of column names to use for tooltips in the form of [(name, @column_name), ...]. Defaults to None, which uses all columns.
             fit_bounds (bool, optional): A flag indicating whether to fit the map bounds to the shapefile. Defaults to True.
@@ -389,20 +397,20 @@ def add_shp(
 
     def add_vector(
         self,
-        filename,
-        encoding="utf-8",
-        read_file_args={},
-        to_crs="epsg:3857",
-        tooltips=None,
-        fit_bounds=True,
+        filename: str,
+        encoding: Optional[str] = "utf-8",
+        read_file_args: Dict = {},
+        to_crs: Optional[str] = "epsg:3857",
+        tooltips: Optional[List] = None,
+        fit_bounds: bool = True,
         **kwargs,
     ):
         """Adds a vector dataset to the map.
 
         Args:
             filename (str): The path to the vector dataset. Can be a local file or a URL.
             encoding (str, optional): The encoding of the vector dataset. Defaults to "utf-8".
-            read_file_args (dict, optional): A dictionary of arguments to pass to geopandas.read_file. Defaults to {}.
+            read_file_args (Dict, optional): A dictionary of arguments to pass to geopandas.read_file. Defaults to {}.
             to_crs (str, optional): The CRS to use for the GeoDataFrame. Defaults to "epsg:3857".
             tooltips (list, optional): A list of column names to use for tooltips in the form of [(name, @column_name), ...]. Defaults to None, which uses all columns.
             fit_bounds (bool, optional): A flag indicating whether to fit the map bounds to the vector dataset. Defaults to True.
@@ -423,7 +431,9 @@ def add_vector(
             gdf, to_crs=to_crs, tooltips=tooltips, fit_bounds=fit_bounds, **kwargs
         )
 
-    def to_html(self, filename=None, title=None, **kwargs):
+    def to_html(
+        self, filename: Optional[str] = None, title: Optional[str] = None, **kwargs
+    ):
         """Converts the map to HTML.
 
         Args:
@@ -433,7 +443,7 @@ def to_html(self, filename=None, title=None, **kwargs):
         """
         save(self.figure, filename=filename, title=title, **kwargs)
 
-    def fit_bounds(self, bounds):
+    def fit_bounds(self, bounds: List[float]):
         """Fits the map to the specified bounds in the form of [xmin, ymin, xmax, ymax].
 
         Args:
@@ -447,7 +457,13 @@ def fit_bounds(self, bounds):
         self.figure.y_range.start = bounds[1][0]
         self.figure.y_range.end = bounds[1][1]
 
-    def to_streamlit(self, width=800, height=600, use_container_width=True, **kwargs):
+    def to_streamlit(
+        self,
+        width: Optional[int] = 800,
+        height: Optional[int] = 600,
+        use_container_width: bool = True,
+        **kwargs,
+    ):
         """Displays the map in a Streamlit app.
 
         Args: