Package base classes

class ReviewTypePackageBaseClass(*, operation, settings)[source]

Bases: ABC

The base class for ReviewType packages

abstract initialize(settings)[source]

Initialize the review type

Return type:

dict

class SearchSourcePackageBaseClass(*, source_operation, settings=None)[source]

Bases: ABC

The base class for SearchSource packages

abstract classmethod add_endpoint(operation, params)[source]

Add the SearchSource as an endpoint.

Return type:

SearchSource

abstract classmethod heuristic(filename, data)[source]

Heuristic to identify which SearchSource a search file belongs to.

Return type:

dict

abstract load(load_operation)[source]

Load records from the SearchSource.

Return type:

dict

Retrieve masterdata from the SearchSource.

Return type:

Record

abstract prepare(record, source)[source]

Run the custom source-prep operation.

Return type:

Record

abstract search(rerun)[source]

Run a search of the SearchSource.

Return type:

None

class PrepPackageBaseClass(*, prep_operation, settings)[source]

Bases: ABC

The base class for Prep packages.

abstract prepare(record)[source]

Run the prep operation.

Return type:

Record

class PrepManPackageBaseClass(*, prep_man_operation, settings)[source]

Bases: ABC

The base class for PrepMan packages.

abstract prepare_manual(records)[source]

Run the prep-man operation.

Return type:

dict

class DedupePackageBaseClass(*, dedupe_operation, settings)[source]

Bases: ABC

The base class for Dedupe packages.

abstract run_dedupe()[source]

Run the dedupe operation.

Return type:

None

class PrescreenPackageBaseClass(*, prescreen_operation, settings)[source]

Bases: ABC

The base class for Prescreen packages.

abstract run_prescreen(records, split)[source]

Run the prescreen operation.

Return type:

dict

class PDFGetPackageBaseClass(*, pdf_get_operation, settings)[source]

Bases: ABC

The base class for PDFGet packages.

abstract get_pdf(record)[source]

Run the pdf-get operation.

Return type:

Record

class PDFGetManPackageBaseClass(*, pdf_get_man_operation, settings)[source]

Bases: ABC

The base class for PDFGetMan packages.

abstract pdf_get_man(records)[source]

Run the pdf-get-man operation.

Return type:

dict

class PDFPrepPackageBaseClass(*, pdf_prep_operation, settings)[source]

Bases: ABC

The base class for PDFPrep packages.

abstract prep_pdf(record, pad)[source]

Run the prep-pdf operation.

Return type:

Record

class PDFPrepManPackageBaseClass(*, pdf_prep_man_operation, settings)[source]

Bases: ABC

The base class for PDFPrepMan packages.

abstract pdf_prep_man(records)[source]

Run the pdf-prep-man operation.

Return type:

dict

class ScreenPackageBaseClass(*, screen_operation, settings)[source]

Bases: ABC

The base class for Screen packages.

abstract run_screen(records, split)[source]

Run the screen operation.

Return type:

dict

class DataPackageBaseClass(*, data_operation, settings)[source]

The base class for Data packages.

abstract get_advice()[source]

Get advice on how to operate the data package endpoint.

Return type:

dict

abstract update_data(records, synthesized_record_status_matrix, silent_mode)[source]

Update the data by running the data operation.

Return type:

None

abstract update_record_status_matrix(synthesized_record_status_matrix, endpoint_identifier)[source]

Update the record status matrix.

Return type:

None