swh.search package

Subpackages:

• swh.search.api package
  • swh.search.api.client module
    • RemoteSearch
  • swh.search.api.server module
    • search_error_handler()
    • my_error_handler()
    • index()
    • load_and_check_config()
    • make_app_from_configfile()

Submodules:

• swh.search.cli module
• swh.search.elasticsearch module
  • token_encode()
  • token_decode()
  • ElasticSearch
    • ElasticSearch.check()
    • ElasticSearch.deinitialize()
    • ElasticSearch.initialize()
    • ElasticSearch.flush()
    • ElasticSearch.origin_update()
    • ElasticSearch.origin_get()
    • ElasticSearch.origin_delete()
    • ElasticSearch.origin_search()
    • ElasticSearch.visit_types_count()
• swh.search.exc module
  • SearchException
  • SearchQuerySyntaxError
• swh.search.in_memory module
  • InMemorySearch
    • InMemorySearch.check()
    • InMemorySearch.deinitialize()
    • InMemorySearch.initialize()
    • InMemorySearch.flush()
    • InMemorySearch.origin_update()
    • InMemorySearch.origin_search()
    • InMemorySearch.origin_get()
    • InMemorySearch.origin_delete()
    • InMemorySearch.visit_types_count()
• swh.search.interface module
  • MinimalOriginDict
    • MinimalOriginDict.url
  • OriginDict
    • OriginDict.visit_types
    • OriginDict.has_visits
    • OriginDict.nb_visits
    • OriginDict.snapshot_id
    • OriginDict.last_visit_date
    • OriginDict.last_eventful_visit_date
    • OriginDict.url
  • SearchInterface
    • SearchInterface.check()
    • SearchInterface.flush()
    • SearchInterface.origin_update()
    • SearchInterface.origin_search()
    • SearchInterface.origin_get()
    • SearchInterface.origin_delete()
    • SearchInterface.visit_types_count()
• swh.search.journal_client module
  • fetch_last_revision_release_date()
  • convert_origin()
  • convert_origin_visit_status()
  • convert_from_origin_metadata_dict()
  • convert_journal_object()
  • SearchJournalClient
    • SearchJournalClient.object_types
    • SearchJournalClient.process_one_object()
• swh.search.metrics module
  • timed()
  • send_metric()
• swh.search.query_language_binding module
  • language()
• swh.search.translator module
  • Translator
    • Translator.RANGE_OPERATOR_MAP
    • Translator.parse_query()
• swh.search.utils module
  • get_expansion()
  • parse_and_format_date()
  • escape()
  • unescape()

Module contents:

swh.search.get_search(cls: str, **kwargs: Dict[str, Any]) → SearchInterface

Get an search object of class cls with arguments args.

Parameters:

• cls – search’s class, either ‘local’ or ‘remote’

• args – dictionary of arguments passed to the search class constructor

Returns:

an instance of swh.search’s classes (either local or remote)

Raises:

ValueError if passed an unknown search class. –