cli/discover: remove/add local collections if the remote collection is deleted/created

This works when the destination backend is 'filesystem'.

-- add a new parameter to storage section:
   implicit = ["create", "delete"]

Changes cli/utils.py:save_status(): when data is None, remove the
underlaying file.

Author: dilyanpalauzov

CHANGELOG.rst

@@ -75,6 +75,10 @@ Version 0.19.0
   use that as a reference.
 
 .. _etesync-dav: https://github.com/etesync/etesync-dav
+- Add ``implicit`` option to storage section.  It creates/deletes implicitly
+  collections in the destinations, when new collections are created/deleted
+  in the source. The deletion is implemented only for the "filesystem" storage.
+  See :ref:`storage_config`.
 
 Changes to SSL configuration
 ----------------------------

docs/config.rst

@@ -407,9 +407,9 @@ Local
         The command will be called with the path of the deleted file.
     :param fileeignoreext: The file extention to ignore. It is only useful
         if fileext is set to the empty string. The default is ``.tmp``.
-    :param implicit: When a new collection is created on the source,
-        create it in the destination without asking questions, when
-        the value is "create".  When the value is "delete" and a collection
+    :param implicit: When a new collection is created on the source, and the
+        value is "create", create the collection in the destination without
+        asking questions.  When the value is "delete" and a collection
         is removed on the source, remove it in the destination.  The value
         can be a string or an array of strings.  The deletion is implemented
         only for the "filesystem" storage.

tests/system/cli/test_config.py

@@ -64,7 +64,11 @@ def test_read_config(read_config):
             "instance_name": "bob_a",
             "implicit": [],
         },
-        "bob_b": {'type': "carddav", "instance_name": "bob_b", "implicit": []},
+        "bob_b": {
+            "type": "carddav",
+            "instance_name": "bob_b",
+            "implicit": [],
+        },
     }
 
 

tests/system/utils/test_main.py

@@ -22,7 +22,7 @@ def test_get_storage_init_args():
     from vdirsyncer.storage.memory import MemoryStorage
 
     all, required = utils.get_storage_init_args(MemoryStorage)
-    assert all == {"fileext", "collection", "read_only", "instance_name", "no_delete", "implicit"}
+    assert all == {"fileext", "collection", "read_only", "instance_name", "implicit"}
     assert not required
 
 

vdirsyncer/cli/config.py

@@ -122,10 +122,11 @@ def _parse_section(
             if "implicit" not in options:
                 options["implicit"] = []
             elif isinstance(options["implicit"], str):
-                options["implicit"] = [options['implicit']]
+                options["implicit"] = [options["implicit"]]
             elif not isinstance(options["implicit"], list):
                 raise ValueError(
-                    "`implicit` parameter must be a list, string or absent.")
+                    "`implicit` parameter must be a list, string or absent."
+                )
             self._storages[name] = options
         elif section_type == "pair":
             self._pairs[name] = options

vdirsyncer/cli/discover.py

@@ -11,6 +11,7 @@
 
 from . import cli_logger
 from .. import exceptions
+from . import cli_logger
 from .utils import handle_collection_not_found
 from .utils import handle_collection_was_removed
 from .utils import handle_storage_init_error
@@ -144,6 +145,33 @@ async def collections_for_pair(
             "cache_key": cache_key,
         },
     )
+
+    if "from b" in (pair.collections or []):
+        only_in_a = set(a_discovered.get_self().keys()) - set(
+            b_discovered.get_self().keys()
+        )
+        if only_in_a and "delete" in pair.config_a["implicit"]:
+            for a in only_in_a:
+                try:
+                    handle_collection_was_removed(pair.config_a, a)
+                    save_status(status_path, pair.name, a, data_type="metadata")
+                    save_status(status_path, pair.name, a, data_type="items")
+                except NotImplementedError as e:
+                    cli_logger.error(e)
+
+    if "from a" in (pair.collections or []):
+        only_in_b = set(b_discovered.get_self().keys()) - set(
+            a_discovered.get_self().keys()
+        )
+        if only_in_b and "delete" in pair.config_b["implicit"]:
+            for b in only_in_b:
+                try:
+                    handle_collection_was_removed(pair.config_b, b)
+                    save_status(status_path, pair.name, b, data_type="metadata")
+                    save_status(status_path, pair.name, b, data_type="items")
+                except NotImplementedError as e:
+                    cli_logger.error(e)
+
     return rv
 
 

vdirsyncer/cli/utils.py

@@ -242,6 +242,7 @@ def save_status(
     data: dict[str, Any],
     collection: str | None = None,
 ) -> None:
+    assert data_type is not None
     status_name = get_status_name(pair, collection)
     path = expand_path(os.path.join(base_path, status_name)) + "." + data_type
     prepare_status_path(path)
@@ -370,7 +371,8 @@ async def handle_collection_not_found(config, collection, e=None):
     )
 
     if "create" in config["implicit"] or click.confirm(
-            "Should vdirsyncer attempt to create it?"):
+        "Should vdirsyncer attempt to create it?"
+    ):
         storage_type = config["type"]
         cls, config = storage_class_from_config(config)
         config["collection"] = collection

vdirsyncer/storage/base.py

@@ -85,18 +85,12 @@ def __init__(
         self,
         instance_name=None,
         read_only=None,
-        no_delete=None,
         collection=None,
-        implicit=None
+        implicit=None,
     ):
         if read_only is None:
             read_only = self.read_only
-        if implicit is None:
-            self.implicit = []
-        elif isinstance(implicit, str):
-            self.implicit = [implicit]
-        else:
-            self.implicit = implicit
+        self.implicit = implicit  # unused from within the Storage classes
         if self.read_only and not read_only:
             raise exceptions.UserError("This storage can only be read-only.")
         self.read_only = bool(read_only)
@@ -146,14 +140,14 @@ async def create_collection(cls, collection, **kwargs):
 
     @classmethod
     def delete_collection(cls, collection, **kwargs):
-        '''
+        """
         Delete the specified collection and return the new arguments.
 
         ``collection=None`` means the arguments are already pointing to a
         possible collection location.
 
         The returned args should contain the collection name, for UI purposes.
-        '''
+        """
         raise NotImplementedError()
 
     def __repr__(self):

vdirsyncer/storage/filesystem.py

@@ -85,7 +85,7 @@ async def create_collection(cls, collection, **kwargs):
     @classmethod
     def delete_collection(cls, collection, **kwargs):
         kwargs = dict(kwargs)
-        path = kwargs['path']
+        path = kwargs["path"]
 
         if collection is not None:
             path = os.path.join(path, collection)