Scripts

Facet Scanner CMD

usage: facet_scanner [-h] [--rerun] [--num-files NUM_FILES] [--conf CONF]
                     path processing_path

Process path for facets and update the index

positional arguments:
  path                  Path to process
  processing_path       Path to output intermediate files

optional arguments:
  -h, --help            show this help message and exit
  --rerun               Disable paging to disk on rerun
  --num-files NUM_FILES
                        Number of files per lotus job
  --conf CONF

Facet Scanner CMD MRO

1. facet_scanner.scripts.facet_scanner_cmd.FacetExtractor.process_path

2. facet_scanner.core.facet_scanner.FacetScanner.get_handler

3. facet_scanner.collection_handlers.utils.facet_factory.FacetFactory.get_handler

4. facet_scanner.collection_handlers.base.CollectionHandler.export_facets

5. facets_scanner.core.elasticsearch_connection.ElasticsearchConnection.get_query

6. facets_scanner.core.elasticsearch_connection.ElasticsearchConnection.get_hits

7. facet_scanner.collection_handlers.base.CollectionHandler.lotus_submit

class facet_scanner.scripts.facet_scanner_cmd.FacetExtractor(conf)

classmethod main()

Main routine. Extracts the command line options, loads the configuration file and initiaises the scanner before calling cls.process_path

process_path(cmd_args)

Main routine for processing a path from the command line arguments

Parameters

cmd_args (argparse.Namespace) – Arguments from the command line

Lotus Facet Scanner

usage: -c [-h] [--conf CONF] path

Process path for facets and update the index. This script is designed to be
run as a batch process on lotus

positional arguments:
  path         Path to page file for processing

optional arguments:
  -h, --help   show this help message and exit
  --conf CONF

Lotus Facet Scanner MRO

1. facet_scanner.scripts.lotus_facet_scanner.LotusFacetScanner.process_path

2. facet_scanner.core.facet_scanner.FacetScanner.get_handler

3. facet_scanner.collection_handlers.utils.facet_factory.FacetFactory.get_handler

4. facet_scanner.collection_handlers.base.CollectionHandler.update_facets

5. facet_scanner.collection_handlers.base.CollectionHandler._facet_generator

6. facet_scanner.collection_handlers.base.CollectionHandler.get_facets

class facet_scanner.scripts.lotus_facet_scanner.LotusFacetScanner(conf)

process_path(cmd_args)

Open the page file, extract the list of file paths and process each one to extract the facets.

Parameters

cmd_args (argparse.Namespace) – Arguments from the command line