colrev.search_file.ExtendedSearchFile
- class colrev.search_file.ExtendedSearchFile(search_string, platform, search_results_path, search_type, version, **kwargs)[source]
- Bases: - SearchFile- Extended SearchFile with search_results_path and derived search_history_path. - Methods - get_origin_prefix- Get the corresponding origin prefix - get_search_history_path- Get the search history path. - is_curated_source- Check whether the source is a curated source (for preparation) - is_md_source- Check whether the source is a metadata source (for preparation) - save- Save the search file to a JSON file. - set_search_history_file_path- Set or clear the explicit search-history file path (stored privately). - set_search_results_path- Set or clear the explicit search-results file path. - setup_for_load- Set the SearchSource up for the load process (initialize statistics) - to_dict- Extend parent to_dict with search_results_path and search_history_path. - Attributes - version- get_search_history_path(search_history_path=None)[source]
- Get the search history path. - Return type:
- Path
 
 - is_curated_source()[source]
- Check whether the source is a curated source (for preparation) - Return type:
- bool
 
 - is_md_source()[source]
- Check whether the source is a metadata source (for preparation) - Return type:
- bool
 
 - save(search_history_path=None, git_repo=None)[source]
- Save the search file to a JSON file. - Return type:
- None
 
 - set_search_history_file_path(path)
- Set or clear the explicit search-history file path (stored privately). Passing None clears the override so the derived path is used again. - Return type:
- None
 
 - set_search_results_path(path)
- Set or clear the explicit search-results file path. Passing None clears the path. - Return type:
- None