Merge pull request #832 from itcarroll/earthaccessfile-patch

restore AbstractBaseClass inheritance
nsidc · Oct 1, 2024 · e38dcc3 · e38dcc3
2 parents 412e947 + fb78806
commit e38dcc3
Show file tree

Hide file tree

Showing 5 changed files with 7 additions and 12 deletions.
diff --git a/docs/user-reference/store/earthaccessfile.md b/docs/user-reference/store/earthaccessfile.md
diff --git a/earthaccess/api.py b/earthaccess/api.py
@@ -242,7 +242,7 @@ def download(
 def open(
     granules: Union[List[str], List[DataGranule]],
     provider: Optional[str] = None,
-) -> List[EarthAccessFile]:
+) -> List[AbstractFileSystem]:
     """Returns a list of file-like objects that can be used to access files
     hosted on S3 or HTTPS by third party libraries like xarray.
 

diff --git a/earthaccess/store.py b/earthaccess/store.py
@@ -26,7 +26,7 @@
 logger = logging.getLogger(__name__)
 
 
-class EarthAccessFile:
+class EarthAccessFile(fsspec.spec.AbstractBufferedFile):
     """Handle for a file-like object pointing to an on-prem or Earthdata Cloud granule."""
 
     def __init__(
@@ -64,7 +64,7 @@ def _open_files(
     url_mapping: Mapping[str, Union[DataGranule, None]],
     fs: fsspec.AbstractFileSystem,
     threads: Optional[int] = 8,
-) -> List[EarthAccessFile]:
+) -> List[fsspec.spec.AbstractBufferedFile]:
     def multi_thread_open(data: tuple) -> EarthAccessFile:
         urls, granule = data
         return EarthAccessFile(fs.open(urls), granule)
@@ -336,7 +336,7 @@ def open(
         self,
         granules: Union[List[str], List[DataGranule]],
         provider: Optional[str] = None,
-    ) -> List[EarthAccessFile]:
+    ) -> List[fsspec.spec.AbstractBufferedFile]:
         """Returns a list of file-like objects that can be used to access files
         hosted on S3 or HTTPS by third party libraries like xarray.
 

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -101,7 +101,6 @@ nav:
               - "Granule Queries": "user-reference/granules/granules-query.md"
               - "Granule Results": "user-reference/granules/granules.md"
           - Store:
-              - "EarthAccessFile": "user-reference/store/earthaccessfile.md"
               - "Store": "user-reference/store/store.md"
           - Auth:
               - "Auth": "user-reference/auth/auth.md"

diff --git a/tests/unit/test_store.py b/tests/unit/test_store.py
@@ -129,6 +129,9 @@ def test_store_can_create_s3_fsspec_session(self):
         return None
 
 
+@pytest.mark.xfail(
+    reason="This test reproduces a bug (#610) which has not yet been fixed."
+)
 def test_earthaccess_file_getattr():
     fs = fsspec.filesystem("memory")
     with fs.open("/foo", "wb") as f: