csvpath 0.0.483

A declarative language for data extraction and validation of CSV files

About CsvPath

CsvPath defines a declarative syntax for inspecting and validating CSV files.

CsvPath' goal is to make it easy to:

• Analyze the content and structure of a CSV
• Validate that the file matches expectations
• Report on the content or validity
• Create new derived CSV files

And do it all in an automation-friendly way.

Though much simpler, it is inspired by:

• XPath. CsvPath is to CSV files like XPath is to XML files.
• Validation of XML using Schematron rules

CsvPath is intended to fit with other DataOps and data quality tools. Files are streamed. The interface is simple. New functions are easy to create.

Read more about CsvPath and see realistic CSV validation examples at https://www.csvpath.org.

Contents

• Motivation
• High-level Description
• Running CsvPath
  • Validation
  • Creating new files
• Comments
• Scanning
• Matching
  • Match Components
    • Terms
    • Functions
    • Headers
    • Variables
    • Equalities
    • References
  • Comments Within Match
  • The When Operator
  • Qualifiers
  • Error Handling
• More Examples
• Grammar

Motivation

CSV files are everywhere!

A surprisingly large number of companies depend on CSV processing for significant amounts of revenue. Research organizations are awash in CSV. And everyone's favorite issue tracker, database GUI, spreadsheet, APM platform, and most any other type of tool we use day to day uses CSV for sharing. CSV is the lowest of common dominators. Many CSVs are invalid or broken in some way. Often times a lot of manual effort goes into finding problems and fixing them.

CsvPath is first and foremost a validation language. It is intended to describe CSV files in simple declarative rules that indicate if a file is as expected. CsvPath can also extract data, create reports, and in other ways have useful side effects.

CsvPath's goal is to make simple validations almost trivial and more complex situations more manageable. It is a library, not a system, so it relies on being easy to integrate with other DataOps tools.

Description

CsvPath paths have three parts:

• a "root" file name
• a scanning part
• a matching part

The root of a csvpath starts with $. The match and scan parts are enclosed by brackets. Newlines are ignored.

A very simple csvpath might look like this:

    $filename[*][yes()]

This csvpath says open the file named filename, scan all the lines, and match every line scanned.

A slightly more functional csvpath could look like this:

    $people.csv[*][
        @two_names = count(not(#middle_name))
        last() -> print("There are $.variables.two_names people with only two names")]

This csvpath reads people.csv, counting the people without a middle name and printing the result after the last row is read.

A csvpath doesn't have to point to a specific file. As shown above, it can point to a specific file or it can instead use a logical name associated with a physical file or have no specific file indicator.

    $[*][
        @two_names = count(not(#middle_name))
        last() -> print("There are $.variables.two_names people with only two names")]

This version of the example has its file chosen at runtime.

See more examples here.

There is no limit to the amount of functionality you can include in a single csvpath. However, different functions run with their own performance characteristics. You should plan to test both the performance and functionality of your paths.

CsvPath was conceived as a data testing and extraction tool. Running it in production typically involves testing the paths in advance and automating the runs.

Interactive use of csvpaths can be valuable, too, of course. There is a trivial REPL (read–eval–print loop) script at the project's root (repl.py) that you can use to explore and test csvpaths.

Running CsvPath

CsvPath is available on Pypi here. The git repo is here.

Two classes provide the functionality: CsvPath and CsvPaths. Each has only a few external methods.

CsvPath

(code) The CsvPath class is the basic entry point for running csvpaths.

method	function
parse(csvpath)	applies a csvpath
next()	iterates over matched rows returning each matched row as a list
fast_forward()	iterates over the file collecting variables and side effects
advance(n)	skips forward n rows from within a for row in path.next() loop
collect(n)	processes n rows and collects the lines that matched as lists

CsvPaths

(code) The CsvPaths class helps you manage validations of multiple files and/or multiple csvpaths. It coordinates the work of multiple CsvPath instances.

method	function
csvpath()	gets a CsvPath object that knows all the file names available
collect_paths()	Same as CsvPath.collect() but for all paths sequentially
fast_forward_paths()	Same as CsvPath.fast_forward() but for all paths sequentially
next_paths()	Same as CsvPath.next() but for all paths sequentially
collect_by_line()	Same as CsvPath.collect() but for all paths breadth first
fast_forward_by_line()	Same as CsvPath.fast_forward() but for all paths breadth first
next_by_line()	Same as CsvPath.next() but for all paths breadth first

To be clear, the purpose of CsvPaths is to apply multiple csvpaths per CSV file. Its breadth-first versions of the collect(), fast_forward(), and next() methods attempt to match each csvpath to each row of a CSV file before continuing to the next row. As you can imagine, for very large files this approach is a must.

There are several ways to set up CSV file references. Read more about managing CSV files.

You also have important options for managing csvpaths. Read about named csvpaths here.

This is a very basic programmatic use of CsvPath.

    path = CsvPath()
    path.parse("""
            $test.csv[5-25][
                #firstname == "Frog"
                @lastname.onmatch = "Bat"
                count() == 2
            ]
    """)

    for i, line in enumerate( path.next() ):
        print(f"{i}: {line}")
    print(f"The varibles collected are: {path.variables}")

The csvpath says:

• Open test.csv
• Scan lines 5 through 25
• Match the second time we see a line where the first header equals Frog and set the variable called lastname to "Bat"

Another path that does the same thing a bit more simply might look like:

    $test[5-25][
        #firstname == "Frog"
        @lastname.onmatch = "Bat"
        count()==2 -> print( "$.csvpath.match_count: $.csvpath.line")
    ]

In this case, we're using the "when" operator, ->, to determine when to print.

For lots more ideas see the unit tests and more examples here.

There are a small number of configuration options. Read more about those here.

The print function

Before we get into the details of scanning and matching, let's look at what CsvPath can print. The print function has several important uses, including:

• Validating CSV files
• Debugging csvpaths
• Creating new CSV files based on an existing file

You can read more about the mechanics of printing here.

Validating CSV

CsvPath paths can be used for rules based validation. Rules based validation checks a file against content and structure rules but does not validate the file's structure against a schema. This validation approach is similar to XML's Schematron validation, where XPath rules are applied to XML.

There is no "standard" way to do CsvPath validation. The simplest way is to create csvpaths that print a validation message when a rule fails. For example:

    $test.csv[*][@failed = equals(#firstname, "Frog")
                 @failed.asbool -> print("Error: Check line $.csvpath.line_count for a row with the name Frog")]

Several rules can exist in the same csvpath for convenience and/or performance. Alternatively, you can run separate csvpaths for each rule. You can read more about managing csvpaths here.

Creating new CSV files

Csvpaths can also use the print function to generate new file content on system out. Redirecting the output to a file is an easy way to create a new CSV file based on an existing file. For e.g.

    $test.csv[*][ line_count()==0 -> print("lastname, firstname, say")
                  above(line_count(), 0) -> print("$.headers.lastname, $.headers.firstname, $.headers.say")]

This csvpath reorders the headers of the test file at tests/test_resources/test.csv. The output file will have a header row.

Comments

CsvPaths have file scanning instructions, match components, and comments. Comments exist at the top level, outside the CsvPath's brackets, as well as in the matching part of the path. Comments within the match part are covered below.

As well as documentation, comments outside the csvpath can:

• Contribute to a collection of metadata fields associated with a csvpath
• Switch on/off certain validation settings
• Set the identity of a csvpath within a group of csvpaths

A comment starts and ends with a ~ character. Within the comment, any word that has a colon after it is considered a metadata key. The metadata value is anything following the key up till a new metadata key word is seen or the comment ends.

For example, this comment says that the csvpath has the name Order Validation:

    ~ name: Order Validation
      developer: Abe Sheng
    ~
    $[*][ count(#order) == 10 ]

The name Order Validation is available in CsvPath's metadata property along with the developer's name. You can use any metadata keys you like. All the metadata is available during and after a run, giving you an easy way to name, describe, attribute, etc. your csvpaths.

You can read more about comments and metadata here.

Scanning

The scanning part of a csvpath enumerates selected lines. For each line returned, the line number, the scanned line count, and the match count are available. The set of line numbers scanned is also available.

The scan part of the path starts with a dollar sign to indicate the root, meaning the file from the top. After the dollar sign comes the file path. The scanning instructions are in a bracket. The rules are:

• [*] means all
• [3*] means starting from line 3 and going to the end of the file
• [3] by itself means just line 3
• [1-3] means lines 1 through 3
• [1+3] means lines 1 and line 3
• [1+3-8] means line 1 and lines 3 through eight

Matching

The match part is also bracketed. Matches have space separated components or "values" that are ANDed together. The components' order is important. A match component is one of several types:

• Term
• Function
• Variable
• Header
• Equality
• Reference

Term

A string, number, or regular expression value.

Returns	Matches	Examples
A value	Always true	"a value"

Read about terms here.

Function

A composable unit of functionality called once for every row scanned.

Returns	Matches	Examples
Calculated	Calculated	count()

Read about functions here.

Variable

A stored value that is set or retrieved once per row scanned.

Returns	Matches	Examples
A value	True when set. (Unless the onchange qualifier is used). Alone it is an existence test.	@firstname

Read about variables here.

Header

A named header or a header identified by 0-based index. (CsvPath avoids the word "column" for reasons we'll go into later in the docs).

Returns	Matches	Examples
A value	Calculated. Used alone it is an existence test.	#area_code

Read about headers here.

Equality

Two of the other types joined with an "=" or "==".

Returns	Matches	Examples
Calculated	True at assignment, otherwise calculated.	#area_code == 617

Reference

References are a way of pointing to data generated by other csvpaths. Referenced data is held by a CvsPaths instance. It is stored in its named-results. The name is the one that identified the paths that generated it.

References can point to:

• Variables
• Headers

The form of a reference is:

    $named_path.variables.firstname

This reference looks in the results named for its CSV file. The qualifier variables indicates the value is a variable named firstname.

Returns	Matches	Examples
Calculated	True at assignment, otherwise calculated.	@q = $orders.variables.quarter

Read more about references here.

Comments

You can comment out match components by wrapping them in ~. Comments can be multi-line. At the moment the only limitations are:

• Comments cannot include the ~ (tilde) and ] (right bracket) characters
• Comments cannot go within match components, only between them

Examples:

    [ count() ~this is a comment~ ]

    [    ~this csvpath is
          just for testing.
          use at own risk~
       any()
    ]

The when operator

->, the "when" operator, is used to act on a condition. -> can take an equality, header, variable, or function on the left and trigger an assignment or function on the right. For e.g.

    [ last() -> print("this is the last line") ]

Prints this is the last line just before the scan ends.

    [ exists(#0) -> @firstname = #0 ]

Says to set the firstname variable to the value of the first column when the first column has a value. (Note that this could be achieved other simpler ways, including using the notnone qualifier on the variable.)

Qualifiers

Qualifiers are tokens added to variable, header, and function names. They are separated from the names and each other with . characters. Each qualifier causes the qualified match component to behave in a different way than it otherwise would.

Qualifiers are quite powerful and deserve a close look. Read about qualifiers here.

Error Handling

The CsvPath library handles errors according to policies set for the CsvPath and CsvPaths classes. Each class can have multiple approaches to errors configured together. The options are:

• Collect - an error collector collects errors for later inspection
• Raise - an exception is (re)raised that may halt the CsvPath process
• Stop - the CsvPath instance containing the offending problem is stopped; any others continue
• Fail - the CsvPath instance containing the offending problem is failed; processing continues
• Quiet - minimal error information is logged but otherwise handling is quiet

Raise and quiet are not useful together, but the others combine well. You can set the error policy in the config.ini that lives by default in the ./config directory.

Because of this nuanced approach to errors, the library will tend to raise data exceptions rather than handle them internally at the point of error. This is particularly true of matching, and especially the functions. When a function sees a problem, or fails to anticipate a problem, the exception is bubbled up to the top Expression within the list of Expressions held by the Matcher. From there it is routed to an error handler to be kept with other results of the run, or an exception is re-raised, or other actions are taken.

More Examples

There are more examples scattered throughout the documentation. Good places to look include:

• Here are a few more real-looking examples
• Try the Getting Started examples on https://www.csvpath.org
• The individual function descriptions
• The unit tests and their match parts are not realistic, but a good source of ideas.

To create example CsvPaths from your own data, try CsvPath AutoGen. The huge caveat is that AutoGen uses AI so your results will not be perfect. You will need to adjust, polish, and test them.

Grammar

Read more about the CsvPath grammar definition here.

More Info

Visit https://www.csvpath.org

Sponsors