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 -> calls package.add_endpoint()

colrev search -> calls search operation -> calls package.search()

colrev load -> calls load operation -> calls package.load()

colrev prep -> calls prep operation -> calls package.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:

ExtendedSearchFile

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

abstract load()[source]

Load records from the SearchSource.

Return type:

dict

Retrieve masterdata from the SearchSource.

Return type:

Record

abstract prepare(record)[source]

Run the custom source-prep operation.

Return type:

Record

abstract search(rerun)[source]

Run a search of the SearchSource.

Return type:

None