colrev.ops.search.Search

class colrev.ops.search.Search(*, review_manager, notify_state_transition_operation=True)

Bases: Operation

Search for new records.

Initialize the instance.

Methods

add_most_likely_sources	Get the most likely SearchSources.
add_source_and_search	Add a SearchSource and run the search.
check_precondition	Check the operation precondition.
conclude	Conclude the operation (stop Docker containers).
decorate	Decorator for operations.
get_new_search_files	Retrieve new search files (not yet registered in settings).
get_new_source_heuristic	Get the heuristic result list of SearchSources candidates.
main	rtype: Callable
notify	Notify the review_manager about the next operation.

Attributes

type

add_most_likely_sources()

Get the most likely SearchSources.

returns a dictionary: {“filepath”: [SearchSource1,..]}

Return type:

None

add_source_and_search(search_file)

Add a SearchSource and run the search.

Return type:

None

check_precondition()

Check the operation precondition.

Return type:

None

conclude()

Conclude the operation (stop Docker containers).

Return type:

None

classmethod decorate()

Decorator for operations.

Return type:

Callable

get_new_search_files()

Retrieve new search files (not yet registered in settings).

Return type:

list[Path]

get_new_source_heuristic(filename)

Get the heuristic result list of SearchSources candidates.

returns a dictionary: {“filepath”: ({“search_source”: SourceCandidate1”, “confidence”: 0.98},..]}

Return type:

list

notify(*, state_transition=True)

Notify the review_manager about the next operation.

Return type:

None