Merge pull request #96 from lsst/tickets/DM-42091

DM-42091: Remove long deprecated s3 utilities

Author: timj

.pre-commit-config.yaml

@@ -22,7 +22,7 @@ repos:
         name: isort (python)
   - repo: https://github.com/astral-sh/ruff-pre-commit
     # Ruff version.
-    rev: v0.5.7
+    rev: v0.6.8
     hooks:
       - id: ruff
   - repo: https://github.com/numpy/numpydoc

pyproject.toml

@@ -21,7 +21,6 @@ classifiers = [
 keywords = ["lsst"]
 dependencies = [
     "lsst-utils",
-    "deprecated"
 ]
 dynamic = ["version"]
 requires-python = ">=3.11.0"

python/lsst/resources/s3utils.py

@@ -12,12 +12,9 @@
 from __future__ import annotations
 
 __all__ = (
-    "clean_test_environment",
     "getS3Client",
     "s3CheckFileExists",
     "bucketExists",
-    "setAwsEnvCredentials",
-    "unsetAwsEnvCredentials",
     "backoff",
     "all_retryable_errors",
     "max_retry_time",
@@ -35,19 +32,14 @@
 from contextlib import contextmanager
 from http.client import HTTPException, ImproperConnectionState
 from types import ModuleType
-from typing import TYPE_CHECKING, Any, NamedTuple, cast
+from typing import Any, NamedTuple, cast
 from unittest.mock import patch
 
 from botocore.exceptions import ClientError
 from botocore.handlers import validate_bucket_name
-from deprecated.sphinx import deprecated
 from urllib3.exceptions import HTTPError, RequestError
 from urllib3.util import Url, parse_url
 
-if TYPE_CHECKING:
-    from unittest import TestCase
-
-
 try:
     import boto3
 except ImportError:
@@ -124,33 +116,6 @@ class _TooManyRequestsError(Exception):
 max_retry_time = 60
 
 
-@deprecated(
-    reason="This has been replaced by a new function, clean_test_environment_for_s3()."
-    " Will be removed after v26.2023.5000",
-    version="26.2023.5000",
-    category=FutureWarning,
-)
-def clean_test_environment(testcase: TestCase) -> None:
-    """Clear S3_ENDPOINT_URL then restore it at the end of a test.
-
-    Parameters
-    ----------
-    testcase : `unittest.TestCase`
-        Reference to the test being run; used to add a cleanup function.
-    """
-    endpoint = os.environ.get("S3_ENDPOINT_URL")
-
-    if not endpoint:
-        return
-    os.environ["S3_ENDPOINT_URL"] = ""
-
-    def cleanup() -> None:
-        if endpoint is not None:
-            os.environ["S3_ENDPOINT_URL"] = endpoint
-
-    testcase.addCleanup(cleanup)
-
-
 @contextmanager
 def clean_test_environment_for_s3() -> Iterator[None]:
     """Reset S3 environment to ensure that unit tests with a mock S3 can't
@@ -446,62 +411,6 @@ def bucketExists(bucketName: str, client: boto3.client | None = None) -> bool:
         return False
 
 
-@deprecated(
-    reason="This function could accidentally leave real credentials in the environment during testing."
-    " A new function, clean_test_environment_for_s3(), can be used to set up mock credentials."
-    " Will be removed after v26.2023.5000",
-    version="26.2023.5000",
-    category=FutureWarning,
-)
-def setAwsEnvCredentials(
-    accessKeyId: str = "dummyAccessKeyId", secretAccessKey: str = "dummySecretAccessKey"
-) -> bool:
-    """Set AWS credentials environmental variables.
-
-    Parameters
-    ----------
-    accessKeyId : `str`
-        Value given to AWS_ACCESS_KEY_ID environmental variable. Defaults to
-        `dummyAccessKeyId`.
-    secretAccessKey : `str`
-        Value given to AWS_SECRET_ACCESS_KEY environmental variable. Defaults
-        to `dummySecretAccessKey`.
-
-    Returns
-    -------
-    setEnvCredentials : `bool`
-        True when environmental variables were set, False otherwise.
-
-    Notes
-    -----
-    If either AWS_ACCESS_KEY_ID or AWS_SECRET_ACCESS_KEY are not set, both
-    values are overwritten to ensure that the values are consistent.
-    """
-    if "AWS_ACCESS_KEY_ID" not in os.environ or "AWS_SECRET_ACCESS_KEY" not in os.environ:
-        os.environ["AWS_ACCESS_KEY_ID"] = accessKeyId
-        os.environ["AWS_SECRET_ACCESS_KEY"] = secretAccessKey
-        return True
-    return False
-
-
-@deprecated(
-    reason="This has been replaced by a new function, clean_test_environment_for_s3()."
-    " Will be removed after v26.2023.5000",
-    version="26.2023.5000",
-    category=FutureWarning,
-)
-def unsetAwsEnvCredentials() -> None:
-    """Unset AWS credential environment variables.
-
-    Unsets the AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY environmental
-    variables.
-    """
-    if "AWS_ACCESS_KEY_ID" in os.environ:
-        del os.environ["AWS_ACCESS_KEY_ID"]
-    if "AWS_SECRET_ACCESS_KEY" in os.environ:
-        del os.environ["AWS_SECRET_ACCESS_KEY"]
-
-
 def translate_client_error(err: ClientError, uri: ResourcePath) -> None:
     """Translate a ClientError into a specialist error if relevant.
 

requirements.txt

@@ -9,4 +9,3 @@ responses >= 0.12.0
 urllib3 >= 1.25.10
 requests >= 2.26.0
 defusedxml
-deprecated