Added an exists= option to list_registered_directories.

Author: LTLA

src/sewerrat/list_registered_directories.py

@@ -3,7 +3,13 @@
 import urllib
 
 
-def list_registered_directories(url: str, user: Optional[Union[str, bool]] = None, contains: Optional[str] = None, prefix: Optional[str] = None) -> List[Dict]:
+def list_registered_directories(
+    url: str,
+    user: Optional[Union[str, bool]] = None,
+    contains: Optional[str] = None,
+    prefix: Optional[str] = None,
+    exists: Optional[bool] = None,
+) -> List[Dict]:
     """
     List all registered directories in the SewerRat instance.
 
@@ -25,6 +31,10 @@ def list_registered_directories(url: str, user: Optional[Union[str, bool]] = Non
             None, results are filtered to directories starting with this
             string.
 
+        exists:
+            Whether to only report directories that exist on the filesystem.
+            If ``False``, only non-existent directories are reported, and if ``None``, no filtering is applied based on existence.
+
     Returns:
         List of objects where each object corresponds to a registered directory
         and contains the `path` to the directory, the `user` who registered it,
@@ -41,6 +51,12 @@ def list_registered_directories(url: str, user: Optional[Union[str, bool]] = Non
         query.append("contains_path=" + urllib.parse.quote_plus(contains))
     if not prefix is None:
         query.append("path_prefix=" + urllib.parse.quote_plus(prefix))
+    if exists is not None:
+        if exists:
+            qstr = "true"
+        else:
+            qstr = "false"
+        query.append("exists=" + qstr)
 
     url += "/registered"
     if len(query) > 0:

src/sewerrat/start_sewerrat.py

@@ -9,7 +9,7 @@
 test_api_port = None
 
 
-def start_sewerrat(db: Optional[str] = None, port: Optional[int] = None, wait: float = 1, version: str = "1.1.1", overwrite: bool = False) -> Tuple[bool, int]:
+def start_sewerrat(db: Optional[str] = None, port: Optional[int] = None, wait: float = 1, version: str = "1.1.3", overwrite: bool = False) -> Tuple[bool, int]:
     """
     Start a test SewerRat service.
 

tests/test_list_registered_directories.py

@@ -41,3 +41,19 @@ def test_list_registered_directories(basic_config):
     # Multiple filters work.
     filtered  = sewerrat.list_registered_directories(url, prefix=os.path.dirname(mydir), user=True, contains=os.path.join(mydir, "metadata.json"))
     assert regged == filtered
+
+    # Existence filter works.
+    tmp = str(tempfile.mkdtemp())
+    sewerrat.register(tmp, names="metadata.json", url=url)
+    try:
+        filtered = sewerrat.list_registered_directories(url, prefix=tmp, exists=True)
+        assert filtered[0]["path"] == tmp
+
+        os.rmdir(tmp)
+        filtered2 = sewerrat.list_registered_directories(url, prefix=tmp, exists=False)
+        assert filtered == filtered2
+
+        filtered = sewerrat.list_registered_directories(url, prefix=tmp, exists=True)
+        assert len(filtered) == 0
+    finally:
+        sewerrat.deregister(tmp, url=url)