Companion PR for datalad/datalad#6706

In response to #17

Author: adswa

datalad_next/create_sibling_webdav.py

@@ -25,6 +25,7 @@
     datasetmethod,
     require_dataset,
 )
+from datalad.distribution.utils import _yield_ds_w_matching_siblings
 from datalad.interface.base import (
     Interface,
     build_doc,
@@ -654,85 +655,3 @@ def _create_storage_sibling(
         type='sibling',
         url=url,
     )
-
-
-def _yield_ds_w_matching_siblings(
-        ds, names, recursive=False, recursion_limit=None):
-    """(Recursively) inspect a dataset for siblings with particular name(s)
-
-    Parameters
-    ----------
-    ds: Dataset
-      The dataset to be inspected.
-    names: iterable
-      Sibling names (str) to test for.
-    recursive: bool, optional
-      Whether to recurse into subdatasets.
-    recursion_limit: int, optional
-      Recursion depth limit.
-
-    Yields
-    ------
-    str, str
-      Path to the dataset with a matching sibling, and name of the matching
-      sibling in that dataset.
-    """
-
-    def _discover_all_remotes(ds, refds, **kwargs):
-        """Helper to be run on all relevant datasets via foreach
-        """
-        # Note, that `siblings` doesn't tell us about not enabled special
-        # remotes. There could still be conflicting names we need to know
-        # about in order to properly deal with the `existing` switch.
-
-        repo = ds.repo
-        # list of known git remotes
-        if isinstance(repo, AnnexRepo):
-            remotes = repo.get_remotes(exclude_special_remotes=True)
-            remotes.extend([v['name']
-                            for k, v in repo.get_special_remotes().items()]
-                           )
-        else:
-            remotes = repo.get_remotes()
-        return remotes
-
-    if not recursive:
-        for name in _discover_all_remotes(ds, ds):
-            if name in names:
-                yield ds.path, name
-        return
-
-    # in recursive mode this check could take a substantial amount of
-    # time: employ a progress bar (or rather a counter, because we don't
-    # know the total in advance
-    pbar_id = 'check-siblings-{}'.format(id(ds))
-    log_progress(
-        lgr.info, pbar_id,
-        'Start checking pre-existing sibling configuration %s', ds,
-        label='Query siblings',
-        unit=' Siblings',
-    )
-
-    for res in ds.foreach_dataset(
-            _discover_all_remotes,
-            recursive=recursive,
-            recursion_limit=recursion_limit,
-            return_type='generator',
-            result_renderer='disabled',
-    ):
-        # unwind result generator
-        if 'result' in res:
-            for name in res['result']:
-                log_progress(
-                    lgr.info, pbar_id,
-                    'Discovered sibling %s in dataset at %s',
-                    name, res['path'],
-                    update=1,
-                    increment=True)
-                if name in names:
-                    yield res['path'], name
-
-    log_progress(
-        lgr.info, pbar_id,
-        'Finished checking pre-existing sibling configuration %s', ds,
-    )