Skip to content

modes.md

Latest commit

 

History

History
36 lines (26 loc) · 2.26 KB

modes.md

File metadata and controls

36 lines (26 loc) · 2.26 KB
Raw

Mode Settings

Metadata fields can be used to control several run modes. These include:

  • logic-mode - Sets the CsvPath instance to operate in AND or OR mode
  • return-mode - Instructs the CsvPath instance to return matches or lines that did not match
  • print-mode - Determines if the printouts from print() go to the terminal's standard out, or not
  • validation-mode - Sets the validation reporting actions and channels
  • run-mode - Indicates if a csvpath should be run by its CsvPath instance
  • unmatched-mode - Instructs CsvPath Framework to save unmatched lines, or not
  • explain-mode - If set, an explanation of the match results is dumped to INFO for each line processed

The values for each are:

  • logic-mode = OR or AND (AND is the default)
  • return-mode = no-matches or matches (matches is the default)
  • print-mode = no-default or default (default is the default)
  • run-mode = no-run or run (run is the default)
  • explain-mode = no-explain or explain (no-explain is the default)
  • unmatched-mode = keep or no-keep (no-keep is the default)
  • validation-mode = (one or more of the following separated by commas)
    • print or no-print (print is on by default) and/or
    • raise or no-raise and/or
    • stop or no-stop
    • fail or no-fail
    • collect or no-collect

For more modes and more details about each, see csvpath.org.

The metadata settings happen after the parse() method and before collect(), fast_forward(), or next() evaluates the file. If neither the positive mode setting (e.g. print) or the negative (e.g. no-print) is found the fallback is the setting in config.ini, if applicable and there is one; otherwise, the default.

It is also possible, though not common, to set the modes programmatically.

Metadata-driven mode settings are effective only for the csvpath they are declared in. When you are using a CsvPaths instance to run multiple CsvPath instances, these mode fields give you a way to configure different behavior for each CsvPath in the run. Likewise, a production operator can configure a project-wide default setting in config.ini, while csvpath writers still have the option to override it on a csvpath-by-csvpath basis.