colrev.ops.search.Search

class colrev.ops.search.Search(*, review_manager, notify_state_transition_operation=True)[source]

Search for new records

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()[source]

Get the most likely SearchSources

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

add_source_and_search(search_file)[source]

Add a SearchSource and run the search

check_precondition()

Check the operation precondition

conclude()

Conclude the operation (stop Docker containers)

classmethod decorate()

Decorator for operations

get_new_search_files()[source]

Retrieve new search files (not yet registered in settings)

get_new_source_heuristic(filename)[source]

Get the heuristic result list of SearchSources candidates

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

notify(*, state_transition=True)

Notify the review_manager about the next operation