Fix CMR-related type hints

There were a number of type hints in `search.py` and `api.py` related to
CMR queries that were incorrect. These were fixed. In addition, there
were a number of other static type errors that were masked because of
ignored `cmr` imports. Added type stubs for `python_cmr` library to
unmask and address these additional type errors.

Limited static type changes as much as possible to only functions and
methods dealing with CMR queries and results to keep this PR manageable.

Fixes #508

.gitignore

@@ -20,7 +20,78 @@ docs/tutorials/data
 tests/integration/data
 .ruff_cache
 
-# OS X
+notebooks/data/
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Created by https://www.toptal.com/developers/gitignore/api/macos
+# Edit at https://www.toptal.com/developers/gitignore?templates=macos
+
+### macOS ###
+# General
 .DS_Store
+.AppleDouble
+.LSOverride
 
-notebooks/data/
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### macOS Patch ###
+# iCloud generated files
+*.icloud
+
+# End of https://www.toptal.com/developers/gitignore/api/macos
+
+# Created by https://www.toptal.com/developers/gitignore/api/visualstudiocode
+# Edit at https://www.toptal.com/developers/gitignore?templates=visualstudiocode
+
+### VisualStudioCode ###
+.vscode/
+
+# Local History for Visual Studio Code
+.history/
+
+# Built Visual Studio Code Extensions
+*.vsix
+
+### VisualStudioCode Patch ###
+# Ignore all local history of files
+.history
+.ionide
+
+# End of https://www.toptal.com/developers/gitignore/api/visualstudiocode
+
+# Created by https://www.toptal.com/developers/gitignore/api/direnv
+# Edit at https://www.toptal.com/developers/gitignore?templates=direnv
+
+### direnv ###
+.direnv
+.envrc
+
+# End of https://www.toptal.com/developers/gitignore/api/direnv

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## [Unreleased]
 
+* Enhancements:
+  * Corrected and enhanced static type hints for functions and methods that make
+    CMR queries or handle CMR query results (#508)
+
 ## [v0.9.0] 2024-02-28
 
 * Bug fixes:

earthaccess/api.py

@@ -1,15 +1,14 @@
-from typing import Any, Dict, List, Optional, Type, Union
-
 import requests
 import s3fs
 from fsspec import AbstractFileSystem
 
 import earthaccess
 
 from .auth import Auth
-from .results import DataGranule
+from .results import DataCollection, DataGranule
 from .search import CollectionQuery, DataCollections, DataGranules, GranuleQuery
 from .store import Store
+from .typing_ import Any, Dict, List, Optional, Union
 from .utils import _validation as validate
 
 
@@ -28,9 +27,7 @@ def _normalize_location(location: Optional[str]) -> Optional[str]:
     return location
 
 
-def search_datasets(
-    count: int = -1, **kwargs: Any
-) -> List[earthaccess.results.DataCollection]:
+def search_datasets(count: int = -1, **kwargs: Any) -> List[DataCollection]:
     """Search datasets using NASA's CMR.
 
     [https://cmr.earthdata.nasa.gov/search/site/docs/search/api.html](https://cmr.earthdata.nasa.gov/search/site/docs/search/api.html)
@@ -78,9 +75,7 @@ def search_datasets(
     return query.get_all()
 
 
-def search_data(
-    count: int = -1, **kwargs: Any
-) -> List[earthaccess.results.DataGranule]:
+def search_data(count: int = -1, **kwargs: Any) -> List[DataGranule]:
     """Search dataset granules using NASA's CMR.
 
     [https://cmr.earthdata.nasa.gov/search/site/docs/search/api.html](https://cmr.earthdata.nasa.gov/search/site/docs/search/api.html)
@@ -194,7 +189,7 @@ def download(
 
 
 def open(
-    granules: Union[List[str], List[earthaccess.results.DataGranule]],
+    granules: Union[List[str], List[DataGranule]],
     provider: Optional[str] = None,
 ) -> List[AbstractFileSystem]:
     """Returns a list of fsspec file-like objects that can be used to access files
@@ -216,7 +211,7 @@ def open(
 def get_s3_credentials(
     daac: Optional[str] = None,
     provider: Optional[str] = None,
-    results: Optional[List[earthaccess.results.DataGranule]] = None,
+    results: Optional[List[DataGranule]] = None,
 ) -> Dict[str, Any]:
     """Returns temporary (1 hour) credentials for direct access to NASA S3 buckets. We can
     use the daac name, the provider, or a list of results from earthaccess.search_data().
@@ -239,7 +234,7 @@ def get_s3_credentials(
     return earthaccess.__auth__.get_s3_credentials(daac=daac, provider=provider)
 
 
-def collection_query() -> Type[CollectionQuery]:
+def collection_query() -> CollectionQuery:
     """Returns a query builder instance for NASA collections (datasets).
 
     Returns:
@@ -252,7 +247,7 @@ def collection_query() -> Type[CollectionQuery]:
     return query_builder
 
 
-def granule_query() -> Type[GranuleQuery]:
+def granule_query() -> GranuleQuery:
     """Returns a query builder instance for data granules
 
     Returns:
@@ -311,7 +306,7 @@ def get_requests_https_session() -> requests.Session:
 def get_s3fs_session(
     daac: Optional[str] = None,
     provider: Optional[str] = None,
-    results: Optional[earthaccess.results.DataGranule] = None,
+    results: Optional[DataGranule] = None,
 ) -> s3fs.S3FileSystem:
     """Returns a fsspec s3fs file session for direct access when we are in us-west-2.