What's new and fix foc [skip-ci]

euroargodev · Dec 20, 2024 · 04eb43e · 04eb43e
1 parent c75dd80
commit 04eb43e
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 28 deletions.
diff --git a/argopy/stores/__init__.py b/argopy/stores/__init__.py
@@ -1,30 +1,30 @@
-from .spec import ArgoStoreProto
 from .implementations.local import filestore
 from .implementations.memory import memorystore
 from .implementations.http import httpstore
-from .implementations.http_erddap import httpstore_erddap, httpstore_erddap_auth
+from .implementations.http_erddap import httpstore_erddap
 from .implementations.ftp import ftpstore
 from .implementations.s3 import s3store
 from .implementations.gdac import gdacfs
-
 from .index.argo_index import ArgoIndex
-from .index.implementations.index_pyarrow import indexstore as indexstore_pa
-from .index.implementations.index_pandas import indexstore as indexstore_pd
+from .kerchunker import ArgoKerchunker
 
 from .filesystems import has_distributed, distributed  # noqa: F401
-from .kerchunker import ArgoKerchunker
+from .spec import ArgoStoreProto  # noqa: F401
+from .implementations.http_erddap import httpstore_erddap_auth  # noqa: F401
+from .index.implementations.index_pyarrow import (
+    indexstore as indexstore_pa,
+)  # noqa: F401
+from .index.implementations.index_pandas import (
+    indexstore as indexstore_pd,
+)  # noqa: F401
 
 
-#
 __all__ = (
     # Classes:
     "ArgoIndex",
-    "indexstore_pa",
-    "indexstore_pd",
     "filestore",
     "httpstore",
     "httpstore_erddap",
-    "httpstore_erddap_auth",
     "ftpstore",
     "memorystore",
     "s3store",

diff --git a/argopy/stores/implementations/__init__.py b/argopy/stores/implementations/__init__.py
@@ -1,11 +0,0 @@
-#!/bin/env python
-# -*coding: UTF-8 -*-
-#
-# HELP
-#
-# Created by gmaze on 19/12/2024
-__author__ = 'gmaze@ifremer.fr'
-
-import os
-import sys
-import xarray as xr

diff --git a/argopy/stores/spec.py b/argopy/stores/spec.py
@@ -17,15 +17,15 @@
 
 
 class ArgoStoreProto(ABC):
-    """Argo Abstract File System
+    """Argo File System Prototype
 
-    Provide a prototype for Argo file systems
+    All argopy file systems must inherit, directly or not, from this prototype.
 
     Should this class inherits from :class:`fsspec.spec.AbstractFileSystem` ?
     """
 
     protocol = ""
-    """str: File system name, one in fsspec.registry.known_implementations"""
+    """str: File system name, one in :class:`fsspec.registry.known_implementations`"""
 
     def __init__(self, cache: bool = False, cachedir: str = "", **kwargs):
         """Create a file storage system for Argo data

diff --git a/docs/api.rst b/docs/api.rst
@@ -286,15 +286,15 @@ File systems
 .. autosummary::
     :toctree: generated/
 
-    stores.argo_store_proto
+    stores.ArgoStoreProto
     stores.filestore
     stores.httpstore
     stores.httpstore_erddap
     stores.memorystore
     stores.ftpstore
     stores.s3store
-    stores.ArgoKerchunker
     stores.gdacfs
+    stores.ArgoKerchunker
 
 Argo index store
 ----------------
@@ -303,8 +303,6 @@ Argo index store
     :toctree: generated/
 
     ArgoIndex
-    stores.indexstore_pa
-    stores.indexstore_pd
 
 Fetcher sources
 ---------------

diff --git a/docs/whats-new.rst b/docs/whats-new.rst
@@ -25,6 +25,8 @@ Features and front-end API
 Internals
 ^^^^^^^^^
 
+- **argopy file systems refactoring**. Long due internal refactoring of :ref:`File systems`. The submodule now adopt a more readable specification vs implementation design.(:pr:`425`) by |gmaze|.
+
 - **Open netcdf files lazily**. We now provide low-level support for opening a netcdf Argo dataset lazily with `kerchunk <https://fsspec.github.io/kerchunk/>`_. Simply use the new option ``lazy=True`` with a :class:`stores.httpstore.open_dataset` or :class:`stores.s3store.open_dataset`. (:pr:`385`) by |gmaze|.
 
 .. code-block:: python