ne-loader 0.3.2__tar.gz → 0.3.3__tar.gz

{ne_loader-0.3.2 → ne_loader-0.3.3}/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.4
 Name: ne-loader
-Version: 0.3.2
+Version: 0.3.3
 Summary: A simple loader for Natural Earth map data.
 Author-email: Eric Tunn <erictunn@icloud.com>
 Project-URL: Homepage, https://github.com/erictunn/ne-loader
-Requires-Python: >=3.8
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 Requires-Dist: geopandas>=0.12
 Requires-Dist: platformdirs>=4
@@ -12,6 +12,8 @@ Requires-Dist: requests>=2.25
 
 # NE Loader
 
+[![CI](https://github.com/erictunn/NE_loader_package/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/erictunn/NE_loader_package/actions/workflows/ci.yml)
+
 A simple, robust Python package to download and load Natural Earth map data using GeoPandas.
 
 ## Features

{ne_loader-0.3.2 → ne_loader-0.3.3}/README.md

@@ -1,5 +1,7 @@
 # NE Loader
 
+[![CI](https://github.com/erictunn/NE_loader_package/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/erictunn/NE_loader_package/actions/workflows/ci.yml)
+
 A simple, robust Python package to download and load Natural Earth map data using GeoPandas.
 
 ## Features

{ne_loader-0.3.2 → ne_loader-0.3.3}/pyproject.toml

@@ -7,14 +7,14 @@ where = ["src"]
 
 [project]
 name = "ne-loader"
-version = "0.3.2"
+version = "0.3.3"
 description = "A simple loader for Natural Earth map data."
 authors = [
     { name = "Eric Tunn", email = "erictunn@icloud.com" }
 ]
 readme = "README.md"
 license = { file = "LICENSE" }
-requires-python = ">=3.8"
+requires-python = ">=3.10"
 dependencies = [
     "geopandas>=0.12",
     "platformdirs>=4",

{ne_loader-0.3.2 → ne_loader-0.3.3}/src/ne_loader/cacher.py

@@ -2,15 +2,14 @@
 
 import os
 from pathlib import Path
-from typing import Optional, Union
 
 from platformdirs import user_cache_dir
 
 
-PathLike = Union[str, Path]
+PathLike = str | Path
 
 
-def get_cache_dir(path_override: Optional[PathLike] = None) -> Path:
+def get_cache_dir(path_override: PathLike | None = None) -> Path:
     """Return the directory used to cache Natural Earth downloads.
 
     Cache directory in order of precedence:
@@ -27,7 +26,7 @@ def get_cache_dir(path_override: Optional[PathLike] = None) -> Path:
     if path_override:
         return Path(path_override).expanduser()
 
-    env_path: Optional[str] = os.getenv("NATURAL_EARTH_CACHE_DIR")
+    env_path: str | None = os.getenv("NATURAL_EARTH_CACHE_DIR")
     if env_path:
         return Path(env_path).expanduser()
 

{ne_loader-0.3.2 → ne_loader-0.3.3}/src/ne_loader/error_handler.py

@@ -1,6 +1,6 @@
 """Helpers for error handling."""
 
-from typing import Literal, NoReturn, Union, overload
+from typing import Literal, NoReturn, overload
 
 ErrorMode = Literal["ignore", "raise", "return"]
 
@@ -20,7 +20,7 @@ def error_handler(error: Exception, error_mode: Literal["raise"]) -> NoReturn: .
 def error_handler(
     error: Exception,
     error_mode: ErrorMode,
-) -> Union[None, Exception]:
+) -> Exception | None:
     """Provide consistent error handling based on standardised error mode.
 
     Args:
@@ -32,7 +32,7 @@ def error_handler(
         ValueError: if error mode is invalid, raises a ValueError.
 
     Returns:
-        Union[None, Exception]: depending on mode, can return None (ignore),
+        Exception | None: depending on mode, can return None (ignore),
             the error object (return) or raise the error again (raise).
 
     """

{ne_loader-0.3.2 → ne_loader-0.3.3}/src/ne_loader/map_loader.py

@@ -5,7 +5,7 @@ import logging
 import shutil
 import zipfile
 from pathlib import Path
-from typing import Literal, Optional, Union, overload
+from typing import Literal, overload
 
 import geopandas as gpd
 import requests
@@ -54,10 +54,10 @@ def get_natural_earth(
     name: str,
     res: Resolution = "10m",
     *,
-    dir_override: Optional[PathLike] = None,
+    dir_override: PathLike | None = None,
     error_mode: Literal["ignore"],
-    user_logger: Optional[logging.Logger] = None,
-) -> Optional[gpd.GeoDataFrame]: ...
+    user_logger: logging.Logger | None = None,
+) -> gpd.GeoDataFrame | None: ...
 
 
 @overload
@@ -66,9 +66,9 @@ def get_natural_earth(
     name: str,
     res: Resolution = "10m",
     *,
-    dir_override: Optional[PathLike] = None,
+    dir_override: PathLike | None = None,
     error_mode: Literal["raise"] = "raise",
-    user_logger: Optional[logging.Logger] = None,
+    user_logger: logging.Logger | None = None,
 ) -> gpd.GeoDataFrame: ...
 
 
@@ -78,10 +78,10 @@ def get_natural_earth(
     name: str,
     res: Resolution = "10m",
     *,
-    dir_override: Optional[PathLike] = None,
+    dir_override: PathLike | None = None,
     error_mode: Literal["return"],
-    user_logger: Optional[logging.Logger] = None,
-) -> Union[gpd.GeoDataFrame, Exception]: ...
+    user_logger: logging.Logger | None = None,
+) -> gpd.GeoDataFrame | Exception: ...
 
 
 def get_natural_earth(
@@ -89,10 +89,10 @@ def get_natural_earth(
     name: str,
     res: Resolution = "10m",
     *,
-    dir_override: Optional[PathLike] = None,
+    dir_override: PathLike | None = None,
     error_mode: ErrorMode = "raise",
-    user_logger: Optional[logging.Logger] = None,
-) -> Union[gpd.GeoDataFrame, Exception, None]:
+    user_logger: logging.Logger | None = None,
+) -> gpd.GeoDataFrame | Exception | None:
     """Download, cache, and load a Natural Earth vector dataset.
 
     Args:
@@ -129,7 +129,7 @@ def get_natural_earth(
         extract_dir: Path = build_ne_extract_dir(data_dir, name, res)
         shp_file: Path = build_ne_shp_path(data_dir, name, res)
 
-        _download_ne_data(
+        download_ne_data(
             url=url,
             extract_dir=extract_dir,
             name=name,
@@ -148,7 +148,7 @@ def get_natural_earth(
         return error_handler(error, error_mode)
 
 
-def _download_ne_data(
+def download_ne_data(
     url: str,
     extract_dir: Path,
     name: str,
@@ -178,7 +178,7 @@ def _download_ne_data(
 
     except requests.exceptions.HTTPError as error:
         logger.error(
-            "ne-loader/_download_ne_data(): "
+            "ne-loader/download_ne_data(): "
             "A HTTP error occurred while attempting to fetch data: %s\n"
             "This may cause an error when attempting to load the data.",
             error,
@@ -186,7 +186,7 @@ def _download_ne_data(
         raise
     except requests.exceptions.RequestException as error:
         logger.error(
-            "ne-loader/_download_ne_data(): "
+            "ne-loader/download_ne_data(): "
             "A request error occurred while attempting to fetch data: %s\n"
             "This may cause an error when attempting to load the data.",
             error,
@@ -196,10 +196,12 @@ def _download_ne_data(
     finally:
         with contextlib.suppress(FileNotFoundError):
             zip_path.unlink()
-        if (not shp_file.exists() and
-        extract_dir.name == build_ne_filename(name, res, suffix="")):
+
+        expected_extract_dir = build_ne_filename(name, res, suffix="")
+        if not shp_file.exists() and extract_dir.name == expected_extract_dir:
             shutil.rmtree(extract_dir, ignore_errors=True)
 
+
 def validate_res(res: str) -> None:
     """Validate the resolution against "10m", "50m", "110m".
 
@@ -211,5 +213,7 @@ def validate_res(res: str) -> None:
 
     """
     if res not in ("10m", "50m", "110m"):
-        raise ValueError(f"Invalid resolution: {res}.\
-                         \nResolution must be one of (\"10m\", \"50m\", \"110m\")")
+        raise ValueError(
+            f"Invalid resolution: {res}.\n"
+            'Resolution must be one of ("10m", "50m", "110m")'
+        )

{ne_loader-0.3.2 → ne_loader-0.3.3}/src/ne_loader.egg-info/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.4
 Name: ne-loader
-Version: 0.3.2
+Version: 0.3.3
 Summary: A simple loader for Natural Earth map data.
 Author-email: Eric Tunn <erictunn@icloud.com>
 Project-URL: Homepage, https://github.com/erictunn/ne-loader
-Requires-Python: >=3.8
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 Requires-Dist: geopandas>=0.12
 Requires-Dist: platformdirs>=4
@@ -12,6 +12,8 @@ Requires-Dist: requests>=2.25
 
 # NE Loader
 
+[![CI](https://github.com/erictunn/NE_loader_package/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/erictunn/NE_loader_package/actions/workflows/ci.yml)
+
 A simple, robust Python package to download and load Natural Earth map data using GeoPandas.
 
 ## Features

{ne_loader-0.3.2 → ne_loader-0.3.3}/src/ne_loader.egg-info/SOURCES.txt

@@ -11,5 +11,6 @@ src/ne_loader.egg-info/dependency_links.txt
 src/ne_loader.egg-info/entry_points.txt
 src/ne_loader.egg-info/requires.txt
 src/ne_loader.egg-info/top_level.txt
+tests/test_download_ne_data.py
 tests/test_error_handler.py
 tests/test_map_loader.py

ne_loader-0.3.3/tests/test_download_ne_data.py

@@ -0,0 +1,127 @@
+"""Tests for natural earth data downloader functions."""
+
+import io
+import logging
+import zipfile
+from collections.abc import Iterator
+from pathlib import Path
+
+import pytest
+import requests
+
+from ne_loader.map_loader import build_ne_filename, download_ne_data, Resolution
+
+
+def _mock_zip_bytes(name: str, res: str) -> bytes:
+    """Build an in-memory Natural Earth zip file containing one shapefile."""
+    buffer = io.BytesIO()
+    with zipfile.ZipFile(buffer, "w") as zip_file:
+        zip_file.writestr(
+            build_ne_filename(name, res, suffix=".shp"),
+            b"mock shp content",
+        )
+    return buffer.getvalue()
+
+
+class MockResponse:
+    """Mock successful response object for the downloader's requests.get call."""
+
+    def __init__(self, data: bytes) -> None:
+        """Store response bytes for chunked streaming."""
+        self._data = data
+
+    def raise_for_status(self) -> None:
+        """Match requests.Response.raise_for_status for a successful response."""
+        return None
+
+    def iter_content(self, chunk_size: int = 8192) -> Iterator[bytes]:
+        """Yield response bytes in the same shape as requests.Response."""
+        for start in range(0, len(self._data), chunk_size):
+            yield self._data[start : start + chunk_size]
+
+
+
+url = "https://example.org/fake.zip"
+name = "admin_0_countries"
+res: Resolution = "10m"
+logger = logging.getLogger("testing")
+
+def test_download_ne_data_success(
+    tmp_path: Path,
+    monkeypatch: pytest.MonkeyPatch,
+) -> None:
+    """Verify download_ne_data writes the extracted shapefile on success."""
+    mocked_zip = _mock_zip_bytes(name, res)
+
+    def mock_get(request_url: str, stream: bool, timeout: int) -> MockResponse:
+        """Return a fake response and verify the downloader's request options."""
+        assert request_url == url
+        assert stream is True
+        assert timeout == 10
+        return MockResponse(mocked_zip)
+
+    monkeypatch.setattr(requests, "get", mock_get)
+    base = tmp_path / "ne-cache"
+    base.mkdir()
+    extract_dir = base / build_ne_filename(name, res, suffix="")
+    zip_path = base / build_ne_filename(name, res)
+    shp_file = extract_dir / build_ne_filename(name, res, suffix=".shp")
+
+    download_ne_data(
+        url=url,
+        extract_dir=extract_dir,
+        name=name,
+        res=res,
+        zip_path=zip_path,
+        shp_file=shp_file,
+        logger=logger,
+    )
+
+    assert shp_file.exists()
+    assert extract_dir.exists()
+    assert not zip_path.exists()
+
+
+class BadResponse:
+    """Mock unsuccessful response for the downloader's requests.get call."""
+
+    def raise_for_status(self) -> None:
+        """Mock the unsuccessful response."""
+        raise requests.exceptions.HTTPError("404 Client Error")
+
+
+def test_download_ne_data_failure(
+    tmp_path: Path,
+    monkeypatch: pytest.MonkeyPatch,
+) -> None:
+    """Tests that download_ne_data leaves no artifacts upon HTTP error."""
+
+    def mock_get(request_url: str, stream: bool, timeout: int) -> BadResponse:
+        """Return a fake response and verify the downloader's request options."""
+        assert request_url == url
+        assert stream is True
+        assert timeout == 10
+        return BadResponse()
+
+    monkeypatch.setattr(requests, "get", mock_get)
+
+    base = tmp_path / "ne-cache"
+    base.mkdir()
+    extract_dir = base / build_ne_filename(name, res, suffix="")
+    zip_path = base / build_ne_filename(name, res)
+    shp_file = extract_dir / build_ne_filename(name, res, suffix=".shp")
+
+
+    with pytest.raises(requests.exceptions.HTTPError):
+        download_ne_data(
+            url=url,
+            extract_dir=extract_dir,
+            name=name,
+            res=res,
+            zip_path=zip_path,
+            shp_file=shp_file,
+            logger=logger,
+        )
+
+    assert not zip_path.exists()
+    assert not extract_dir.exists()

{ne_loader-0.3.2 → ne_loader-0.3.3}/tests/test_map_loader.py

@@ -51,6 +51,9 @@ def test_build_ne_shp_path() -> None:
 
 def test_validate_res() -> None:
     """Tests that validate_res(res=kaboom) raises the correct ValueError."""
-    with pytest.raises(ValueError, match=re.escape(f"Invalid resolution: kaboom.\
-                         \nResolution must be one of (\"10m\", \"50m\", \"110m\")")):
+    expected_message = (
+        'Invalid resolution: kaboom.\n'
+        'Resolution must be one of ("10m", "50m", "110m")'
+    )
+    with pytest.raises(ValueError, match=re.escape(expected_message)):
         validate_res("kaboom")