Hide keyboard shortcuts

Hot-keys on this page

r m x p   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

# This file is part of verify. 

# 

# Developed for the LSST Data Management System. 

# This product includes software developed by the LSST Project 

# (https://www.lsst.org). 

# See the COPYRIGHT file at the top-level directory of this distribution 

# for details of code ownership. 

# 

# This program is free software: you can redistribute it and/or modify 

# it under the terms of the GNU General Public License as published by 

# the Free Software Foundation, either version 3 of the License, or 

# (at your option) any later version. 

# 

# This program is distributed in the hope that it will be useful, 

# but WITHOUT ANY WARRANTY; without even the implied warranty of 

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 

# GNU General Public License for more details. 

# 

# You should have received a copy of the GNU General Public License 

# along with this program. If not, see <https://www.gnu.org/licenses/>. 

 

"""Print the measurements and metadata in lsst.verify JSON files. 

 

This script takes as arguments one or more lsst.verify JSON files, and prints 

the top-level metadata and a summary of any measurements. 

 

This script does not print information about metrics or specifications. 

""" 

 

__all__ = ["main", "inspect_job"] 

 

import argparse 

import json 

 

from lsst.verify import Job 

 

 

def _is_measurement_metadata(key, metrics): 

"""Test whether a job-level metadata key is really measurement metadata. 

 

Parameters 

---------- 

key : `str` 

The metadata key to test. 

metrics : iterable of `lsst.verify.Name` or of `str` 

The metrics recorded in the job. 

 

Returns 

------- 

result : `bool` 

`True` if ``key`` represents measurement metadata, `False` if it 

represents purely job-level metadata. 

""" 

for metric in metrics: 

if str(metric) in key: 

return True 

return False 

 

 

def _simplify_key(key, prefix): 

"""Remove a prefix from a key, if it's present. 

 

Parameters 

---------- 

key : `str` 

The key to simplify. 

prefix : `str` 

The prefix to remove from ``key``. 

 

Returns 

------- 

simplifiedKey : `str` 

``key`` with any initial ``prefix`` removed 

""" 

if key.startswith(prefix): 

return key.replace(prefix, "", 1) 

else: 

return key 

 

 

def inspect_job(job): 

"""Present the measurements in a Job object. 

 

The measurements and any metadata are printed to standard output. 

 

Parameters 

---------- 

job : `lsst.verify.Job` 

The Job to examine. 

""" 

# Leave enough space for output so that all '=' characters are aligned 

max_metric_length = max([len(str(metric)) for metric in job.measurements]) 

 

print("Common metadata:") 

for key, value in job.meta.items(): 

if _is_measurement_metadata(key, job.measurements.keys()): 

continue 

print("%*s = %s" % (max_metric_length, key, value)) 

 

print("\nMeasurements:") 

for metric, measurement in job.measurements.items(): 

pretty_quantity = measurement.quantity.round(4) 

if measurement.notes: 

prefix = str(measurement.metric_name) + "." 

# Raw representation of measurement.notes hard to read 

simple_notes = {_simplify_key(key, prefix): value 

for key, value in measurement.notes.items()} 

print("%*s = %10s (%s)" 

% (max_metric_length, metric, pretty_quantity, simple_notes)) 

else: 

print("%*s = %10s" % (max_metric_length, metric, pretty_quantity)) 

 

 

def build_argparser(): 

"""Construct an argument parser for the ``inspect_job.py`` script. 

 

Returns 

------- 

argparser : `argparse.ArgumentParser` 

The argument parser that defines the ``inspect_job.py`` command-line 

interface. 

""" 

parser = argparse.ArgumentParser( 

description=__doc__, 

formatter_class=argparse.RawDescriptionHelpFormatter, 

epilog='More information is available at https://pipelines.lsst.io.') 

parser.add_argument( 

'json_paths', 

nargs='+', 

metavar='json', 

help='lsst.verify JSON file, or files (``*verify.json``).') 

return parser 

 

 

def main(filenames): 

"""Present all Job files. 

 

Parameters 

---------- 

filenames : `list` of `str` 

The Job files to open. Must be in JSON format. 

""" 

args = build_argparser().parse_args() 

for filename in args.json_paths: 

if len(filenames) > 1: 

print("\n%s:" % filename) 

with open(filename) as f: 

job = Job.deserialize(**json.load(f)) 

inspect_job(job)