add lock=Lock() to cachetools cached instance to avoid thread cor…

…ruption (#238) * add `lock=Lock()` to cachetools `cached` instance to avoid thread corruption * update python version support
developmentseed · Feb 13, 2025 · ff47e90 · ff47e90
1 parent c13cf41
commit ff47e90
Show file tree

Hide file tree

Showing 12 changed files with 30 additions and 4 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -9,14 +9,14 @@ on:
     - '*'
   pull_request:
 env:
-  LATEST_PY_VERSION: '3.12'
+  LATEST_PY_VERSION: '3.13'
 
 jobs:
   tests:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ['3.8', '3.9', '3.10', '3.11', '3.12']
+        python-version: ['3.9', '3.10', '3.11', '3.12', '3.13']
 
     steps:
       - uses: actions/checkout@v4

diff --git a/CHANGES.md b/CHANGES.md
@@ -1,5 +1,11 @@
 ## Unreleased
 
+## 8.1.0 (2025-02-13)
+
+* add `lock=Lock()` to cachetools `cached` instance to avoid thread corruption
+* remove python 3.8 support
+* add python 3.13 support
+
 ## 8.0.0 (2024-10-21)
 
 * remove deprecated methods

diff --git a/cogeo_mosaic/backends/az.py b/cogeo_mosaic/backends/az.py
@@ -1,6 +1,7 @@
 """cogeo-mosaic Azure Blob Storage backend."""
 
 import json
+from threading import Lock
 from typing import Any
 from urllib.parse import urlparse
 
@@ -68,6 +69,7 @@ def write(self, overwrite: bool = False, **kwargs: Any):
     @cached(  # type: ignore
         TTLCache(maxsize=cache_config.maxsize, ttl=cache_config.ttl),
         key=lambda self: hashkey(self.input),
+        lock=Lock(),
     )
     def _read(self) -> MosaicJSON:  # type: ignore
         """Get mosaicjson document."""

diff --git a/cogeo_mosaic/backends/base.py b/cogeo_mosaic/backends/base.py
@@ -3,6 +3,7 @@
 import abc
 import itertools
 import warnings
+from threading import Lock
 from typing import Any, Dict, List, Optional, Sequence, Tuple, Type, Union
 
 import attr
@@ -235,6 +236,7 @@ def assets_for_bbox(
     @cached(  # type: ignore
         TTLCache(maxsize=cache_config.maxsize, ttl=cache_config.ttl),
         key=lambda self, x, y, z: hashkey(self.input, x, y, z, self.mosaicid),
+        lock=Lock(),
     )
     def get_assets(self, x: int, y: int, z: int) -> List[str]:
         """Find assets."""

diff --git a/cogeo_mosaic/backends/dynamodb.py b/cogeo_mosaic/backends/dynamodb.py
@@ -6,6 +6,7 @@
 import re
 import warnings
 from decimal import Decimal
+from threading import Lock
 from typing import Any, Dict, List, Sequence
 from urllib.parse import urlparse
 
@@ -88,6 +89,7 @@ def __attrs_post_init__(self):
     @cached(  # type: ignore
         TTLCache(maxsize=cache_config.maxsize, ttl=cache_config.ttl),
         key=lambda self: hashkey(self.input),
+        lock=Lock(),
     )
     def _read(self) -> MosaicJSON:  # type: ignore
         """Get Mosaic definition info."""
@@ -218,6 +220,7 @@ def update(
     @cached(  # type: ignore
         TTLCache(maxsize=cache_config.maxsize, ttl=cache_config.ttl),
         key=lambda self, x, y, z: hashkey(self.input, x, y, z, self.mosaicid),
+        lock=Lock(),
     )
     def get_assets(self, x: int, y: int, z: int) -> List[str]:
         """Find assets."""

diff --git a/cogeo_mosaic/backends/file.py b/cogeo_mosaic/backends/file.py
@@ -2,6 +2,7 @@
 
 import json
 import pathlib
+from threading import Lock
 
 import attr
 from cachetools import TTLCache, cached
@@ -39,6 +40,7 @@ def write(self, overwrite: bool = False):
     @cached(  # type: ignore
         TTLCache(maxsize=cache_config.maxsize, ttl=cache_config.ttl),
         key=lambda self: hashkey(self.input),
+        lock=Lock(),
     )
     def _read(self) -> MosaicJSON:  # type: ignore
         """Get mosaicjson document."""

diff --git a/cogeo_mosaic/backends/gs.py b/cogeo_mosaic/backends/gs.py
@@ -1,6 +1,7 @@
 """cogeo-mosaic Google Cloud Storage backend."""
 
 import json
+from threading import Lock
 from typing import Any
 from urllib.parse import urlparse
 
@@ -60,6 +61,7 @@ def write(self, overwrite: bool = False, **kwargs: Any):
     @cached(  # type: ignore
         TTLCache(maxsize=cache_config.maxsize, ttl=cache_config.ttl),
         key=lambda self: hashkey(self.input),
+        lock=Lock(),
     )
     def _read(self) -> MosaicJSON:  # type: ignore
         """Get mosaicjson document."""

diff --git a/cogeo_mosaic/backends/s3.py b/cogeo_mosaic/backends/s3.py
@@ -1,6 +1,7 @@
 """cogeo-mosaic AWS S3 backend."""
 
 import json
+from threading import Lock
 from typing import Any
 from urllib.parse import urlparse
 
@@ -58,6 +59,7 @@ def write(self, overwrite: bool = False, **kwargs: Any):
     @cached(  # type: ignore
         TTLCache(maxsize=cache_config.maxsize, ttl=cache_config.ttl),
         key=lambda self: hashkey(self.input),
+        lock=Lock(),
     )
     def _read(self) -> MosaicJSON:  # type: ignore
         """Get mosaicjson document."""

diff --git a/cogeo_mosaic/backends/sqlite.py b/cogeo_mosaic/backends/sqlite.py
@@ -6,6 +6,7 @@
 import sqlite3
 import warnings
 from pathlib import Path
+from threading import Lock
 from typing import Dict, List, Sequence
 from urllib.parse import urlparse
 
@@ -94,6 +95,7 @@ def __exit__(self, exc_type, exc_value, traceback):
     @cached(  # type: ignore
         TTLCache(maxsize=cache_config.maxsize, ttl=cache_config.ttl),
         key=lambda self: hashkey(self.input),
+        lock=Lock(),
     )
     def _read(self) -> MosaicJSON:  # type: ignore
         """Get Mosaic definition info."""
@@ -311,6 +313,7 @@ def update(
     @cached(  # type: ignore
         TTLCache(maxsize=cache_config.maxsize, ttl=cache_config.ttl),
         key=lambda self, x, y, z: hashkey(self.input, x, y, z, self.mosaicid),
+        lock=Lock(),
     )
     def get_assets(self, x: int, y: int, z: int) -> List[str]:
         """Find assets."""

diff --git a/cogeo_mosaic/backends/stac.py b/cogeo_mosaic/backends/stac.py
@@ -2,6 +2,7 @@
 
 import json
 import os
+from threading import Lock
 from typing import Dict, List, Optional, Sequence, Type
 
 import attr
@@ -151,6 +152,7 @@ def query_from_link(link: Dict, query: Dict):
 @cached(  # type: ignore
     TTLCache(maxsize=cache_config.maxsize, ttl=cache_config.ttl),
     key=lambda url, query, **kwargs: hashkey(url, json.dumps(query), **kwargs),
+    lock=Lock(),
 )
 def _fetch(  # noqa: C901
     stac_url: str,

diff --git a/cogeo_mosaic/backends/web.py b/cogeo_mosaic/backends/web.py
@@ -5,6 +5,7 @@
 """
 
 import json
+from threading import Lock
 from typing import Dict, Sequence
 
 import attr
@@ -32,6 +33,7 @@ class HttpBackend(BaseBackend):
     @cached(  # type: ignore
         TTLCache(maxsize=cache_config.maxsize, ttl=cache_config.ttl),
         key=lambda self: hashkey(self.input),
+        lock=Lock(),
     )
     def _read(self) -> MosaicJSON:  # type: ignore
         """Get mosaicjson document."""

diff --git a/pyproject.toml b/pyproject.toml
@@ -1,7 +1,7 @@
 [project]
 name = "cogeo-mosaic"
 description = 'CLI and Backends to work with MosaicJSON.'
-requires-python = ">=3.8"
+requires-python = ">=3.9"
 license = {file = "LICENSE"}
 authors = [
   { name = "Vincent Sarago", email = "vincent@developmentseed.com" },
@@ -13,11 +13,11 @@ classifiers = [
   "License :: OSI Approved :: MIT License",
   "Programming Language :: Python :: 3",
   "Programming Language :: Python :: 3 :: Only",
-  "Programming Language :: Python :: 3.8",
   "Programming Language :: Python :: 3.9",
   "Programming Language :: Python :: 3.10",
   "Programming Language :: Python :: 3.11",
   "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
   "Topic :: Scientific/Engineering :: GIS",
 ]
 dynamic = ["version", "readme"]