job.configuration.results.results_manifest package¶

Submodules¶

job.configuration.results.results_manifest.results_manifest module¶

This module is concerned with the scale output manifest. Scale jobs are expected to produce an output manifest. Scale needs to parse this manifest to bring the information into the system. The output files should match the job interface

class job.configuration.results.results_manifest.results_manifest.ResultsManifest(json_manifest=None)¶

Bases: object

Represents the interface for executing a job

add_files(files_array)¶: adds the files to the manifest if they are not already in the manifest. If there is already an entry for that file name it will be ignored :param files_array: an array of files that should be added to the manifest :type files_array: an array of the format RESULTS_MANIFEST_SCHEMA[“definitions”][“files”]

get_files()¶: gets the output files associated with this manifest :return: an array of dictionaries. Each dictionary describes a file in the manifest. The format of the dict is described by results_manifest.RESULTS_MANIFEST_SCHEMA[“definitions”][“files”] :rtype: array of dict

get_json_dict()¶

Return the json dictionary associated with this manifest

Returns:	json dict representing this manifest
Return type:	dict

get_parse_results()¶: gets the parsed input files associated with this manifest :return: an array of dictionaries. Each dictionary describes the location of a geojson associated with an input filein the manifest. The format of the dict is descibed by results_manifest.RESULTS_MANIFEST_SCHEMA[“definitions”][“parse_results”] :rtype: array of dict

validate(output_file_definitions)¶

Validates the results manifest against given output file definitions. This does not validate that the parse_data matches the job data inputs.

Parameters:	output_file_definitions (dict of tuples) – A dictionary with each output param name mapped to a tuple with (is_multiple (bool), required(bool))

job.configuration.results.results_manifest.results_manifest_1_0 module¶