Findings : finding

Each validation test of an object in the NeXus data file should produce a finding.

source code documentation

document each item during validation

Finding(h5_address, test_name, status, comment) a single reported observation while validating
VALID_STATUS_DICT dictionary (by names) of all available validations
class punx.finding.Finding(h5_address, test_name, status, comment)[source]

a single reported observation while validating

Parameters:
  • h5_address (str) – address of h5py item
  • test_name (str) – short description of the test
  • status (obj) – one of: OK NOTE WARN ERROR TODO COMMENT OPTIONAL UNUSED
  • comment (str) – description
make_md5()[source]

make a unique hash for this finding

punx.finding.VALID_STATUS_DICT = {'COMMENT': <punx.finding.ValidationResultStatus object>, 'ERROR': <punx.finding.ValidationResultStatus object>, 'NOTE': <punx.finding.ValidationResultStatus object>, 'OK': <punx.finding.ValidationResultStatus object>, 'OPTIONAL': <punx.finding.ValidationResultStatus object>, 'TODO': <punx.finding.ValidationResultStatus object>, 'UNUSED': <punx.finding.ValidationResultStatus object>, 'WARN': <punx.finding.ValidationResultStatus object>}

dictionary (by names) of all available validations

class punx.finding.ValidationResultStatus(key, value, color, description)[source]

summary result of a Finding

Parameters:
  • key (str) – short name
  • color (str) – suggested color for GUI
  • description (str) – one-line summary