Coverage for python / lsst / afw / table / testUtils.py: 0%

1# This file is part of afw. 

2# 

3# Developed for the LSST Data Management System. 

4# This product includes software developed by the LSST Project 

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

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

7# for details of code ownership. 

8# 

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

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

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

12# (at your option) any later version. 

13# 

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

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

16# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 

17# GNU General Public License for more details. 

18# 

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

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

21 

22import lsst.utils.tests 

23import difflib 

24from ._schema import Schema 

25 

26__all__ = ["assertSchemasEqual", "diffSchemas", "joinWords"] 

27 

28 

29def joinWords(items): 

30 """Join a sequence of words into a comma-separated, 'and'-finalized 

31 string with correct English syntax. 

32 

33 Parameters 

34 ---------- 

35 items : Array of `str` 

36 Sequence to be joined. 

37 

38 Returns 

39 ------- 

40 result : `str` 

41 Correct English Oxford-comma terminated string. 

42 """ 

43 if len(items) == 1: 

44 result = items[0] 

45 elif len(items) == 2: 

46 result = f"{items[0]} and {items[1]}" 

47 else: 

48 allButLast = ", ".join(items[:-1]) 

49 result = f"{allButLast}, and items{[-1]}" 

50 return result 

51 

52 

53def diffSchemas(schema1, schema2, flags=Schema.IDENTICAL): 

54 """Return a string diff of two schemas. 

55 

56 Parameters 

57 ---------- 

58 schema1 : :py:class:`lsst.afw.table.Schema` 

59 First schema to diff. Items appearing only in this schema 

60 will be prefixed with "-" in the diff. 

61 schema2 : :py:class:`lsst.afw.table.Schema` 

62 Second schema to diff. Items appearing only in this schema 

63 will be prefixed with "-" in the diff. 

64 flags : `int` 

65 A bitwise OR of :py:class:`lsst.afw.table.Schema.ComparisonFlags` 

66 indicating which features of schema items to compare. The returned 

67 diff will always show all differences, but no diff will be shown if 

68 the only differences are not included in the flags. Default is 

69 `lsst.afw.table.Schema.IDENTICAL`, which checks everything. 

70 

71 Returns 

72 ------- 

73 diff : `str` 

74 A "unified diff" string representation of the difference between the 

75 schemas, or an empty string if there is no difference. 

76 """ 

77 result = schema1.compare(schema2, flags) 

78 if result == flags: 

79 return "" 

80 components = [] 

81 if not result & Schema.EQUAL_KEYS: 

82 components.append("keys") 

83 if not result & Schema.EQUAL_NAMES: 

84 components.append("names") 

85 if not result & Schema.EQUAL_DOCS: 

86 components.append("docs") 

87 if not result & Schema.EQUAL_UNITS: 

88 components.append("units") 

89 if not result & Schema.EQUAL_ALIASES: 

90 components.append("aliases") 

91 diff = "\n".join(difflib.unified_diff( 

92 str(schema1).split("\n"), str(schema2).split("\n"))) 

93 return f"{joinWords(components).capitalize()} differ:\n{diff}" 

94 

95 

96@lsst.utils.tests.inTestCase 

97def assertSchemasEqual(testCase, schema1, schema2, flags=Schema.IDENTICAL): 

98 """Assert that two Schemas are equal. 

99 

100 Generates a message from the difference between the schemas; see 

101 :py:func:`diffSchemas` for more information. 

102 

103 Parameters 

104 ---------- 

105 testCase : 

106 Comparison test case that should fail is schemas differ. 

107 schema1 : :py:class:`lsst.afw.table.Schema` 

108 First input schema. 

109 schema2 : :py:class:`lsst.afw.table.Schema` 

110 Second input schema. 

111 flags : `int` 

112 A bitwise OR of :py:class:`lsst.afw.table.Schema.ComparisonFlags` 

113 indicating which features of schema items to compare. 

114 """ 

115 msg = diffSchemas(schema1, schema2, flags=flags) 

116 if msg: 

117 testCase.fail(msg)