Skip to content

Commit 69cf0b3

Browse files
pcaspersjenkins
authored andcommitted
QPR-12276 update read me
1 parent ffa706f commit 69cf0b3

1 file changed

Lines changed: 2 additions & 0 deletions

File tree

Tools/PythonTools/Readme.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ Each object under a given key, `file_name`, has the following format (note that
2222
"optional_cols": [
2323
"col4"
2424
]
25+
"require_equal_optional_cols": false,
2526
"rename_cols": {
2627
"A": "a",
2728
"B": "b",
@@ -84,6 +85,7 @@ For `csv_settings`:
8485
- The `keys` specify which columns will be used as keys for the comparison. The comparison fails if all of these keys are not in both files to be compared.
8586
- The `use_cols` specifies on which columns the actual comparisons are evaluated.
8687
- The `optional_cols`, as with `use_cols` above, specifies columns on which comparisons are evaluated, but these columns are only included if they are present in both files. If they are not present in either file or if present in one file nad not the other, the corresponding comparison defined in `column_settings` below will not be evaluated for the missing column/s.
88+
- The 'require_equal_optional_cols' specifies whether the test is failed if the optional columns are not all present in both files or not all absent in both files. It defaults to true if not given. In this case it is not allowed that an optional column is present in one file but not the other.
8789
- The `rename_cols` object specifies columns that should be renamed before the comparison is performed. In the example above, `A` would be renamed to `a` etc.
8890
- The `col_types` object allows you to explicitly specify the type of a given set of columns if necessary.
8991
- The `drop_rows` object allows you to specify a threshold for the values in a given set of columns. If the absolute value for a given row, in one of the specified columns, is below the threshold, the row is dropped from the comparison.

0 commit comments

Comments
 (0)