Merge pull request #81 from lsst/tickets/DM-42698

DM-42698: Switch to the moto v5 API

Author: timj

.pre-commit-config.yaml

@@ -7,7 +7,7 @@ repos:
       - id: trailing-whitespace
       - id: check-toml
   - repo: https://github.com/psf/black-pre-commit-mirror
-    rev: 23.11.0
+    rev: 24.1.1
     hooks:
       - id: black
         # It is recommended to specify the latest version of Python
@@ -16,13 +16,13 @@ repos:
         # https://pre-commit.com/#top_level-default_language_version
         language_version: python3.11
   - repo: https://github.com/pycqa/isort
-    rev: 5.13.1
+    rev: 5.13.2
     hooks:
       - id: isort
         name: isort (python)
   - repo: https://github.com/astral-sh/ruff-pre-commit
     # Ruff version.
-    rev: v0.1.7
+    rev: v0.1.14
     hooks:
       - id: ruff
   - repo: https://github.com/numpy/numpydoc

pyproject.toml

@@ -45,7 +45,7 @@ gs = [
     "google-cloud-storage",
 ]
 test = [
-    "moto >= 1.3",
+    "moto >= 1.3,!=5.0.0",
     "pytest >= 3.2",
     "pytest-openfiles >= 0.5.0",
     "responses >= 0.12.0",

python/lsst/resources/_resourceHandles/_baseResourceHandle.py

@@ -45,84 +45,66 @@ class ResourceHandleProtocol(Protocol, Generic[U]):
     """
 
     @abstractproperty
-    def mode(self) -> str:
-        ...
+    def mode(self) -> str: ...
 
     @abstractmethod
-    def close(self) -> None:
-        ...
+    def close(self) -> None: ...
 
     @abstractproperty
-    def closed(self) -> bool:
-        ...
+    def closed(self) -> bool: ...
 
     @abstractmethod
-    def fileno(self) -> int:
-        ...
+    def fileno(self) -> int: ...
 
     @abstractmethod
-    def flush(self) -> None:
-        ...
+    def flush(self) -> None: ...
 
     @abstractproperty
-    def isatty(self) -> bool | Callable[[], bool]:
-        ...
+    def isatty(self) -> bool | Callable[[], bool]: ...
 
     @abstractmethod
-    def readable(self) -> bool:
-        ...
+    def readable(self) -> bool: ...
 
     @abstractmethod
-    def readline(self, size: int = -1) -> U:
-        ...
+    def readline(self, size: int = -1) -> U: ...
 
     @abstractmethod
-    def readlines(self, hint: int = -1) -> Iterable[U]:
-        ...
+    def readlines(self, hint: int = -1) -> Iterable[U]: ...
 
     @abstractmethod
     def seek(self, offset: int, whence: int = SEEK_SET, /) -> int:
         pass
 
     @abstractmethod
-    def seekable(self) -> bool:
-        ...
+    def seekable(self) -> bool: ...
 
     @abstractmethod
-    def tell(self) -> int:
-        ...
+    def tell(self) -> int: ...
 
     @abstractmethod
-    def truncate(self, size: int | None = None) -> int:
-        ...
+    def truncate(self, size: int | None = None) -> int: ...
 
     @abstractmethod
-    def writable(self) -> bool:
-        ...
+    def writable(self) -> bool: ...
 
     @abstractmethod
-    def writelines(self, lines: Iterable[U], /) -> None:
-        ...
+    def writelines(self, lines: Iterable[U], /) -> None: ...
 
     @abstractmethod
-    def read(self, size: int = -1) -> U:
-        ...
+    def read(self, size: int = -1) -> U: ...
 
     @abstractmethod
-    def write(self, b: U, /) -> int:
-        ...
+    def write(self, b: U, /) -> int: ...
 
-    def __enter__(self: S) -> S:
-        ...
+    def __enter__(self: S) -> S: ...
 
     def __exit__(
         self,
         exc_type: type[BaseException] | None,
         exc_val: BaseException | None,
         exc_tb: TracebackType | None,
         /,
-    ) -> bool | None:
-        ...
+    ) -> bool | None: ...
 
 
 class BaseResourceHandle(ABC, ResourceHandleProtocol[U]):

python/lsst/resources/_resourcePath.py

@@ -1271,8 +1271,7 @@ def findFileResources(
         candidates: Iterable[ResourcePathExpression],
         file_filter: str | re.Pattern | None,
         grouped: Literal[True],
-    ) -> Iterator[Iterator[ResourcePath]]:
-        ...
+    ) -> Iterator[Iterator[ResourcePath]]: ...
 
     @overload
     @classmethod
@@ -1281,8 +1280,7 @@ def findFileResources(
         candidates: Iterable[ResourcePathExpression],
         *,
         grouped: Literal[True],
-    ) -> Iterator[Iterator[ResourcePath]]:
-        ...
+    ) -> Iterator[Iterator[ResourcePath]]: ...
 
     @overload
     @classmethod
@@ -1291,8 +1289,7 @@ def findFileResources(
         candidates: Iterable[ResourcePathExpression],
         file_filter: str | re.Pattern | None = None,
         grouped: Literal[False] = False,
-    ) -> Iterator[ResourcePath]:
-        ...
+    ) -> Iterator[ResourcePath]: ...
 
     @classmethod
     def findFileResources(

python/lsst/resources/utils.py

@@ -135,8 +135,7 @@ class TransactionProtocol(Protocol):
     """Protocol for type checking transaction interface."""
 
     @contextlib.contextmanager
-    def undoWith(self, name: str, undoFunc: Callable, *args: Any, **kwargs: Any) -> Iterator[None]:
-        ...
+    def undoWith(self, name: str, undoFunc: Callable, *args: Any, **kwargs: Any) -> Iterator[None]: ...
 
 
 def makeTestTempDir(default_base: str | None = None) -> str:

requirements.txt

@@ -5,7 +5,7 @@ importlib_resources
 backoff >= 1.10
 boto3 >= 1.13
 botocore >= 1.15
-moto >= 1.3
+moto >= 1.3,!=5.0.0
 responses >= 0.12.0
 urllib3 >= 1.25.10
 requests >= 2.26.0

setup.cfg

@@ -1,5 +1,5 @@
 [flake8]
 max-line-length = 110
 max-doc-length = 79
-ignore = N802, N803, N806, N812, N815, N816, W503, E203
+ignore = N802, N803, N806, N812, N815, N816, W503, E203, E704
 exclude = __init__.py

tests/test_s3.py

@@ -24,12 +24,16 @@
 try:
     import boto3
     import botocore
-    from moto import mock_s3
+
+    try:
+        from moto import mock_aws  # v5
+    except ImportError:
+        from moto import mock_s3 as mock_aws
 except ImportError:
     boto3 = None
 
-    def mock_s3(cls):
-        """No-op decorator in case moto mock_s3 can not be imported."""
+    def mock_aws(cls):
+        """No-op decorator in case moto mock_aws can not be imported."""
         return cls
 
 
@@ -47,13 +51,13 @@ class S3ReadWriteTestCase(GenericReadWriteTestCase, unittest.TestCase):
     scheme = "s3"
     netloc = "my_2nd_bucket"
 
-    mock_s3 = mock_s3()
+    mock_aws = mock_aws()
     """The mocked s3 interface from moto."""
 
     def setUp(self):
         self.enterContext(clean_test_environment_for_s3())
         # Enable S3 mocking of tests.
-        self.mock_s3.start()
+        self.mock_aws.start()
 
         # MOTO needs to know that we expect Bucket bucketname to exist
         s3 = boto3.resource("s3")
@@ -77,7 +81,7 @@ def tearDown(self):
         bucket.delete()
 
         # Stop the S3 mock.
-        self.mock_s3.stop()
+        self.mock_aws.stop()
 
         S3ResourcePath.use_threads = None
 

tests/test_s3utils.py

@@ -26,7 +26,11 @@
 try:
     import boto3
     from botocore.exceptions import ParamValidationError
-    from moto import mock_s3
+
+    try:
+        from moto import mock_aws  # v5
+    except ImportError:
+        from moto import mock_s3 as mock_aws
 except ImportError:
     boto3 = None
 
@@ -44,7 +48,7 @@ class S3UtilsTestCase(unittest.TestCase):
 
     def setUp(self):
         self.enterContext(clean_test_environment_for_s3())
-        self.enterContext(mock_s3())
+        self.enterContext(mock_aws())
 
         self.client = getS3Client()
         try: