colrev.package_manager.package_base_classes.SearchSourcePackageBaseClass
- class colrev.package_manager.package_base_classes.SearchSourcePackageBaseClass(*, search_file, logger=None, verbose_mode=False)[source]
Bases:
ABC
The base class for SearchSource packages
The following cli commands call specific methods of a SearchSource package:
colrev search --add package_name
-> callspackage.add_endpoint()
colrev search
-> callssearch
operation -> callspackage.search()
colrev load
-> callsload
operation -> callspackage.load()
colrev prep
-> callsprep
operation -> callspackage.prep()
Methods
add_endpoint
Add the SearchSource as an endpoint.
ensure_append_only
Ensure that the SearchSource is append-only (override this method if needed).
heuristic
Heuristic to identify which SearchSource a search file belongs to.
load
Load records from the SearchSource.
prep_link_md
Retrieve masterdata from the SearchSource.
prepare
Run the custom source-prep operation.
search
Run a search of the SearchSource.
Attributes
CURRENT_SYNTAX_VERSION
ci_supported
source_identifier
search_types
heuristic_status
search_source
- abstract classmethod add_endpoint(params, path, logger=None)[source]
Add the SearchSource as an endpoint.
- Return type:
- classmethod ensure_append_only(filename)[source]
Ensure that the SearchSource is append-only (override this method if needed).
- Return type:
bool
- abstract classmethod heuristic(filename, data)[source]
Heuristic to identify which SearchSource a search file belongs to.
- Return type:
dict