Convert deprecation warnings to errors

doc/source/example_notebooks/IS2_DEM_comparison_WIP.ipynb

@@ -176,9 +176,7 @@
    },
    "source": [
     "```{admonition} Important Authentication Update\n",
-    "Previously, icepyx required you to explicitly use the `.earthdata_login()` function to login. Running this function is no longer required, as icepyx will call the login function as needed. The user will still need to provide their credentials using one of the three methods decribed in the [ICESat-2 Data Access Notebook](https://icepyx.readthedocs.io/en/latest/example_notebooks/IS2_data_access.html) example. The `.earthdata_login()` function is still available for backwards compatibility.\n",
-    "\n",
-    "If you are unable to remove `earthdata_login()` calls from your workflow, note that certain inputs, such as `earthdata_uid` and `email`, are no longer required. e.g. `region_a.earthdata_login(earthdata_uid, email)` becomes `region_a.earthdata_login()`\n",
+    "Previously, icepyx required you to explicitly use the `.earthdata_login()` function to login. Running this function is deprecated and will result in an error, as icepyx will call the login function as needed. The user will still need to provide their credentials.\n",
     "```"
    ]
   },

doc/source/example_notebooks/IS2_cloud_data_access.ipynb

@@ -229,9 +229,7 @@
    },
    "source": [
     "```{admonition} Important Authentication Update\n",
-    "Previously, icepyx required you to explicitly use the `.earthdata_login()` function to login. Running this function is no longer required, as icepyx will call the login function as needed. The user will still need to provide their credentials using one of the three methods decribed in the [ICESat-2 Data Access Notebook](https://icepyx.readthedocs.io/en/latest/example_notebooks/IS2_data_access.html) example. The `.earthdata_login()` function is still available for backwards compatibility.\n",
-    "\n",
-    "If you are unable to remove `earthdata_login()` calls from your workflow, note that certain inputs, such as `earthdata_uid` and `email`, are no longer required. e.g. `region_a.earthdata_login(earthdata_uid, email)` becomes `region_a.earthdata_login()`\n",
+    "Previously, icepyx required you to explicitly use the `.earthdata_login()` function to login. Running this function is deprecated and will result in an error, as icepyx will call the login function as needed. The user will still need to provide their credentials.\n",
     "```"
    ]
   },
@@ -386,7 +384,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.13"
+   "version": "3.10.10"
   }
  },
  "nbformat": 4,

doc/source/example_notebooks/IS2_data_access.ipynb

@@ -485,9 +485,7 @@
    },
    "source": [
     "```{admonition} Important Authentication Update\n",
-    "Previously, icepyx required you to explicitly use the `.earthdata_login()` function to login. Running this function is no longer required, as icepyx will call the login function as needed. The user will still need to provide their credentials using one of the three methods decribed above. The `.earthdata_login()` function is still available for backwards compatibility.\n",
-    "\n",
-    "If you are unable to remove `earthdata_login()` calls from your workflow, note that certain inputs, such as `earthdata_uid` and `email`, are no longer required. e.g. `region_a.earthdata_login(earthdata_uid, email)` becomes `region_a.earthdata_login()`\n",
+    "Previously, icepyx required you to explicitly use the `.earthdata_login()` function to login. Running this function is deprecated and will result in an error, as icepyx will call the login function as needed. The user will still need to provide their credentials using one of the three methods decribed above.\n",
     "```"
    ]
   },
@@ -626,9 +624,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "icepyx-dev",
+   "display_name": "icepyx",
    "language": "python",
-   "name": "icepyx-dev"
+   "name": "python3"
   },
   "language_info": {
    "codemirror_mode": {
@@ -640,7 +638,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.11.4"
+   "version": "3.10.10"
   }
  },
  "nbformat": 4,

doc/source/example_notebooks/IS2_data_access2-subsetting.ipynb

@@ -77,9 +77,7 @@
    },
    "source": [
     "```{admonition} Important Authentication Update\n",
-    "Previously, icepyx required you to explicitly use the `.earthdata_login()` function to login. Running this function is no longer required, as icepyx will call the login function as needed. The user will still need to provide their credentials using one of the three methods decribed in the [ICESat-2 Data Access Notebook](https://icepyx.readthedocs.io/en/latest/example_notebooks/IS2_data_access.html) example. The `.earthdata_login()` function is still available for backwards compatibility.\n",
-    "\n",
-    "If you are unable to remove `earthdata_login()` calls from your workflow, note that certain inputs, such as `earthdata_uid` and `email`, are no longer required. e.g. `region_a.earthdata_login(earthdata_uid, email)` becomes `region_a.earthdata_login()`\n",
+    "Previously, icepyx required you to explicitly use the `.earthdata_login()` function to login. Running this function is deprecated and will result in an error, as icepyx will call the login function as needed. The user will still need to provide their credentials.\n",
     "```"
    ]
   },

doc/source/example_notebooks/IS2_data_read-in.ipynb

@@ -157,9 +157,7 @@
    },
    "source": [
     "```{admonition} Important Authentication Update\n",
-    "Previously, icepyx required you to explicitly use the `.earthdata_login()` function to login. Running this function is no longer required, as icepyx will call the login function as needed. The user will still need to provide their credentials using one of the three methods decribed in the [ICESat-2 Data Access Notebook](https://icepyx.readthedocs.io/en/latest/example_notebooks/IS2_data_access.html) example. The `.earthdata_login()` function is still available for backwards compatibility.\n",
-    "\n",
-    "If you are unable to remove `earthdata_login()` calls from your workflow, note that certain inputs, such as `earthdata_uid` and `email`, are no longer required. e.g. `region_a.earthdata_login(earthdata_uid, email)` becomes `region_a.earthdata_login()`\n",
+    "Previously, icepyx required you to explicitly use the `.earthdata_login()` function to login. Running this function is deprecated and will result in an error, as icepyx will call the login function as needed. The user will still need to provide their credentials.\n",
     "```"
    ]
   },
@@ -330,7 +328,7 @@
     "```{admonition} Read Module Update\n",
     "Previously, icepyx required two additional conditions: 1) a `product` argument and 2) that your files either matched the default `filename_pattern` or that the user provided their own `filename_pattern`. These two requirements have been removed. `product` is now read directly from the file metadata (the root group's `short_name` attribute). Flexibility to specify multiple files via the `filename_pattern` has been replaced with the [glob string](https://docs.python.org/3/library/glob.html) feature, and by allowing a list of filepaths as an argument.\n",
     "\n",
-    "The `product` and `filename_pattern` arguments have been maintained for backwards compatibility, but will be fully removed in icepyx version 1.0.0.\n",
+    "The `product` and `filename_pattern` arguments are now deprecated and were removed in icepyx version 1.0.0.\n",
     "```"
    ]
   },

doc/source/example_notebooks/IS2_data_variables.ipynb

@@ -347,9 +347,7 @@
    },
    "source": [
     "```{admonition} Important Authentication Update\n",
-    "Previously, icepyx required you to explicitly use the `.earthdata_login()` function to login. Running this function is no longer required, as icepyx will call the login function as needed. The user will still need to provide their credentials using one of the three methods decribed in the [ICESat-2 Data Access Notebook](https://icepyx.readthedocs.io/en/latest/example_notebooks/IS2_data_access.html) example. The `.earthdata_login()` function is still available for backwards compatibility.\n",
-    "\n",
-    "If you are unable to remove `earthdata_login()` calls from your workflow, note that certain inputs, such as `earthdata_uid` and `email`, are no longer required. e.g. `region_a.earthdata_login(earthdata_uid, email)` becomes `region_a.earthdata_login()`\n",
+    "Previously, icepyx required you to explicitly use the `.earthdata_login()` function to login. Running this function is deprecated and will result in an error, as icepyx will call the login function as needed. The user will still need to provide their credentials.\n",
     "```"
    ]
   },

doc/source/example_notebooks/IS2_data_visualization.ipynb

@@ -210,9 +210,7 @@
    },
    "source": [
     "```{admonition} Important Authentication Update\n",
-    "Previously, icepyx required you to explicitly use the `.earthdata_login()` function to login. Running this function is no longer required, as icepyx will call the login function as needed. The user will still need to provide their credentials using one of the three methods decribed in the [ICESat-2 Data Access Notebook](https://icepyx.readthedocs.io/en/latest/example_notebooks/IS2_data_access.html) example. The `.earthdata_login()` function is still available for backwards compatibility.\n",
-    "\n",
-    "If you are unable to remove `earthdata_login()` calls from your workflow, note that certain inputs, such as `earthdata_uid` and `email`, are no longer required. e.g. `region_a.earthdata_login(earthdata_uid, email)` becomes `region_a.earthdata_login()`\n",
+    "Previously, icepyx required you to explicitly use the `.earthdata_login()` function to login. Running this function is deprecated and will result in an error, as icepyx will call the login function as needed. The user will still need to provide their credentials.\n",
     "```"
    ]
   },

icepyx/core/auth.py

@@ -3,6 +3,7 @@
 import warnings
 
 import earthaccess
+from icepyx.core.exceptions import DeprecationError
 
 
 class AuthenticationError(Exception):
@@ -15,20 +16,23 @@ class AuthenticationError(Exception):
 
 class EarthdataAuthMixin:
     """
-    This mixin class generates the needed authentication sessions and tokens, including for NASA Earthdata cloud access.
+    This mixin class generates the needed authentication sessions and tokens,
+    including for NASA Earthdata cloud access.
     Authentication is completed using the [earthaccess library](https://nsidc.github.io/earthaccess/).
     Methods for authenticating are:
         1. Storing credentials as environment variables ($EARTHDATA_LOGIN and $EARTHDATA_PASSWORD)
         2. Entering credentials interactively
         3. Storing credentials in a .netrc file (not recommended for security reasons)
     More details on using these methods is available in the [earthaccess documentation](https://nsidc.github.io/earthaccess/tutorials/restricted-datasets/#auth).
 
-    This class can be inherited by any other class that requires authentication. For
-    example, the `Query` class inherits this one, and so a Query object has the
-    `.session` property. The method `earthdata_login()` is included for backwards compatibility.
+    This class can be inherited by any other class that requires authentication.
+    For example, the `Query` class inherits this one, and so a Query object has the
+    `.session` property.
+    The method `earthdata_login()` is included for backwards compatibility.
 
     The class can be created without any initialization parameters, and the properties will
-    be populated when they are called. It can alternately be initialized with an
+    be populated when they are called.
+    It can alternately be initialized with an
     earthaccess.auth.Auth object, which will then be used to create a session or
     s3login_credentials as they are called.
 
@@ -90,8 +94,8 @@ def session(self):
     @property
     def s3login_credentials(self):
         """
-        A dictionary which stores login credentials for AWS s3 access. This property is accessed
-        if using AWS cloud data.
+        A dictionary which stores login credentials for AWS s3 access.
+        This property is accessed if using AWS cloud data.
 
         Because s3 tokens are only good for one hour, this function will automatically check if an
         hour has elapsed since the last token use and generate a new token if necessary.
@@ -115,9 +119,12 @@ def set_s3_creds():
     def earthdata_login(self, uid=None, email=None, s3token=None, **kwargs) -> None:
         """
         Authenticate with NASA Earthdata to enable data ordering and download.
-        Credential storage details are described in the EathdataAuthMixin class section.
+        Credential storage details are described in the
+        EathdataAuthMixin class section.
 
-        **Note:** This method is maintained for backward compatibility. It is no longer required to explicitly run `.earthdata_login()`. Authentication will be performed by the module as needed when `.session` or `.s3login_credentials` are accessed.
+        **Note:** This method is deprecated and will be removed in a future release.
+        It is no longer required to explicitly run `.earthdata_login()`.
+        Authentication will be performed by the module as needed.
 
         Parameters
         ----------
@@ -126,7 +133,8 @@ def earthdata_login(self, uid=None, email=None, s3token=None, **kwargs) -> None:
         email : string, default None
             Deprecated keyword for backwards compatibility.
         s3token : boolean, default None
-            Deprecated keyword to generate AWS s3 ICESat-2 data access credentials
+            Deprecated keyword to generate AWS s3 ICESat-2
+            data access credentials
         kwargs : key:value pairs
             Keyword arguments to be passed into earthaccess.login().
 
@@ -140,15 +148,7 @@ def earthdata_login(self, uid=None, email=None, s3token=None, **kwargs) -> None:
         No .netrc found in /Users/username
 
         """
-        warnings.warn(
-            "It is no longer required to explicitly run the `.earthdata_login()` method. Authentication will be performed by the module as needed.",
-            DeprecationWarning,
-            stacklevel=2,
+        raise DeprecationError(
+            "It is no longer required to explicitly run the `.earthdata_login()` method."
+            "Authentication will be performed by the module as needed.",
         )
-
-        if uid != None or email != None or s3token != None:
-            warnings.warn(
-                "The user id (uid) and/or email keyword arguments are no longer required.",
-                DeprecationWarning,
-                stacklevel=2,
-            )

icepyx/core/icesat2data.py

@@ -1,12 +1,10 @@
-import warnings
+from icepyx.core.exceptions import DeprecationError
 
 
 class Icesat2Data:
     def __init__(
         self,
     ):
-        warnings.filterwarnings("always")
-        warnings.warn(
+        DeprecationError(
             "DEPRECATED. Please use icepyx.Query to create a download data object (all other functionality is the same)",
-            DeprecationWarning,
         )

icepyx/core/query.py

@@ -2,10 +2,10 @@
 import matplotlib.pyplot as plt
 from pathlib import Path  # used in docstring tests
 import pprint
-import warnings
 
 import icepyx.core.APIformatting as apifmt
 from icepyx.core.auth import EarthdataAuthMixin
+from icepyx.core.exceptions import DeprecationError
 import icepyx.core.granules as granules
 from icepyx.core.granules import Granules
 import icepyx.core.is2ref as is2ref
@@ -455,10 +455,8 @@ def dataset(self):
         --------
         product
         """
-        warnings.filterwarnings("always")
-        warnings.warn(
+        DeprecationError(
             "In line with most common usage, 'dataset' has been replaced by 'product'.",
-            DeprecationWarning,
         )
 
     @property