MAIN: changed name and name of a parameter of main scanner function

src/caoscrawler/scanner.py

@@ -224,9 +224,9 @@ def initialize_converters(crawler_definition: dict, converter_registry: dict):
 # Main scanner function:
 # --------------------------------------------------------------------------------
 
-def _crawl(self,
+def scanner(self,
             items: list[StructureElement],
-           local_converters: list[Converter],
+            converters: list[Converter],
             generalStore: GeneralStore,
             recordStore: RecordStore,
             structure_elements_path: list[str],
@@ -235,8 +235,10 @@ def _crawl(self,
     """
     Crawl a list of StructureElements and apply any matching converters.
 
+    Formerly known as "_crawl".
+
     items: structure_elements (e.g. files and folders on one level on the hierarchy)
-    local_converters: locally defined converters for
+    converters: locally defined converters for
                         treating structure elements. A locally defined converter could be
                         one that is only valid for a specific subtree of the originally
                         cralwed StructureElement structure.
@@ -257,7 +259,7 @@ def _crawl(self,
         restricted_path = None
 
     for element in items:
-        for converter in local_converters:
+        for converter in converters:
 
             # type is something like "matches files", replace isinstance with "type_matches"
             # match function tests regexp for example
@@ -302,7 +304,7 @@ def _crawl(self,
                             structure_elements_path + [element.get_name()],
                             converters_path + [converter.name])
 
-                self._crawl(children, converter.converters,
+                self.scanner(children, converter.converters,
                             generalStore_copy, recordStore_copy,
                             structure_elements_path + [element.get_name()],
                             converters_path + [converter.name],
@@ -411,9 +413,9 @@ def scan_structure_elements(items: Union[list[StructureElement], StructureElemen
     self.run_id = uuid.uuid1()
     converters = initialize_converters(crawler_definition, converter_registry)
 
-    return _crawl(
+    return scanner(
         items=items,
-        local_converters=converters,
+        converters=converters,
         generalStore=self.generalStore,
         recordStore=self.recordStore,
         structure_elements_path=[],