search_query.search_file

SearchFile parser.

Functions

load_search_file(search_history_path)

Load a search file from a JSON file.

Classes

SearchFile(search_string, platform[, ...])

SearchFile class.

class search_query.search_file.SearchFile(search_string: str, platform: str, authors: list[dict] | None = None, record_info: dict | None = None, date: dict | None = None, search_results_path: str | Path | None = None, **kwargs: dict)

Bases: object

SearchFile class.

get_search_history_path(search_history_path: str | Path | None = None) → Path

Get the search history path.

save(search_history_path: str | Path | None = None) → None

Save the search file to a JSON file.

set_search_history_file_path(path: str | Path | None) → None

Set or clear the explicit search-history file path (stored privately). Passing None clears the override so the derived path is used again.

set_search_results_path(path: str | Path | None) → None

Set or clear the explicit search-results file path. Passing None clears the path.

to_dict() → dict

Convert the search file to a dictionary.

search_query.search_file.load_search_file(search_history_path: str | Path) → SearchFile

Load a search file from a JSON file.