From 43f8ac62046d1916e463d651f20fa4240e346015 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Henrik=20tom=20W=C3=B6rden?= <h.tomwoerden@indiscale.com>
Date: Thu, 14 Jul 2022 17:22:41 +0200
Subject: [PATCH] FIX: fix test and doc which were broken in previous commit
---
integrationtests/test_realworld_example.py | 2 +-
src/caoscrawler/crawl.py | 21 ++++++++++++++-------
2 files changed, 15 insertions(+), 8 deletions(-)
diff --git a/integrationtests/test_realworld_example.py b/integrationtests/test_realworld_example.py
index feb9893f..cffb8494 100644
--- a/integrationtests/test_realworld_example.py
+++ b/integrationtests/test_realworld_example.py
@@ -137,7 +137,7 @@ def test_event_update(clear_database, usemodel):
identifiable_path,
True,
os.path.join(DATADIR, "provenance.yml"),
- True,
+ False,
""
)
diff --git a/src/caoscrawler/crawl.py b/src/caoscrawler/crawl.py
index ac1bba3b..3458b32b 100644
--- a/src/caoscrawler/crawl.py
+++ b/src/caoscrawler/crawl.py
@@ -367,12 +367,19 @@ class Crawler(object):
"""
Start point of the crawler recursion.
- items: A list of structure elements (or a single StructureElemen) that is used for
- generating the initial items for the crawler. This could e.g. be a Directory.
- crawler_definition: A dictionary representing the crawler definition, possibly from a yaml
- file.
-
- Return the final update list.
+ Parameters
+ ----------
+ items: list
+ A list of structure elements (or a single StructureElemen) that is used for
+ generating the initial items for the crawler. This could e.g. be a Directory.
+ crawler_definition : dict
+ A dictionary representing the crawler definition, possibly from a yaml
+ file.
+
+ Returns
+ -------
+ targetData : list
+ the final list with the target state of Records.
"""
# This function builds the tree of converters out of the crawler definition.
@@ -760,7 +767,7 @@ class Crawler(object):
if commit_changes is True, the changes are synchronized to the CaosDB server.
For debugging in can be useful to set this to False.
- Return the final insertList and targetData as tuple.
+ Return the final to_be_inserted and to_be_updated as tuple.
"""
if self.identifiableAdapter is None:
--
GitLab