Merge branch 'f-loadfiles-doc' into f-xlsx-json

src/caosadvancedtools/loadFiles.py

@@ -129,7 +129,14 @@ def create_re_for_file_list(files, localroot, remoteroot):
 
 
 def loadpath(path, include, exclude, prefix, dryrun, forceAllowSymlinks, caosdbignore=None,
-             localpath=None):
+             localpath=None) -> dict:
+    """
+Returns
+-------
+
+inserted: dict
+  A dict with the files to be included for each of the ``include`` elements.
+    """
 
     if caosdbignore:
         # create list of files and create regular expression for small chunks
@@ -146,6 +153,7 @@ def loadpath(path, include, exclude, prefix, dryrun, forceAllowSymlinks, caosdbi
     else:
         includes = [include]
 
+    inserted = {}
     # if no caosdbignore file is used, this iterates over a single include
     for include in includes:
         if dryrun:
@@ -177,8 +185,9 @@ def loadpath(path, include, exclude, prefix, dryrun, forceAllowSymlinks, caosdbi
 
         logger.info(
             f"Made new files accessible: {len(files)}, combined size: {convert_size(totalsize)} ")
+        inserted[include] = files
 
-    return
+    return inserted
 
 
 def main(argv=None):