Instantiate the configured templater.

Remove any violations specified by ignore_mask. This involves two steps: 1. Filter out violations affected by single-line "noqa" dire

Return if there is more than one element to the reference.

Loads a selection of config files from both the path and its parent paths. Args: path (str): The directory which is the target of the sea

Load a raw file and the associated config.

Make a child config at a path but pass on overrides and extra_config_path. Args: path (str): The path to load the new config obje

Create RawSliceInfo as given, or "empty" if in set/macro block.

Returns the normalized version of a string using the segment's rules. By default this uses the raw value of the segment. E.g. This re

Parse a path of sql files. NB: This a generator which will yield the result of each file within the path iteratively.

Parse a rendered file.

Merge keyword lists, giving priority to entries in later lists. *args is a list of keyword lists, these lists should be of tuples in the form

Process a full raw file for inline config and update self. Args: raw_str (str): The full SQL script to evaluate for inline config

Return a list of the raw slices spanning a set of indices.

Return a trimmed version of the raw content. Returns: str: The trimmed version of the raw content.

Returns a new :obj:`ReflowSequence` with points respaced. Args: strip_newlines (:obj:`bool`): Optionally strip newlines

A simple pass through to access the rule tuples of the rule set.

Set up logging for the CLI. We either set up global logging based on the verbosity or, if `logger` is specified, we only limit to a single

Test the structural function of a grammar in various parse modes. This helper fixture is designed to modularise grammar tests.

Return the line and position of this marker in the source.

Serialise this LintFix as a dict.

Validate a config dict. Currently we validate: - Removed and deprecated values. - Layout configuration structure. - Indentation confi

Wrap this result with an outer class. NOTE: Because MatchResult is frozen, this returns a new match.

Construct a zero slice from a single integer.

Overwrite BaseSegment's __setattr__ with BaseSegment's superclass.

Generate list of fixes to convert CONVERT and ShorthandCast to CAST.

Check to see whether we should pass the rule and shortcut. Args: segment: The target segment. parent: The parent segm

Choose the anchor point for a lint fix, i.e. where to apply the fix. From a grammar perspective, segments near the leaf of the tree are

Generate list of fixes to convert CAST and ShorthandCast to CONVERT.

Flatten optional grammar (e.g., exclude). Returns GrammarId or None.

Get a properly configured jinja environment. This method returns a properly configured jinja environment. It first checks if the 'ign

Get a dbt target name from the configuration.

Check if a segment is a semicolon statement terminator.

Construct a MatchResult at a given index. This is a helper function for reuse by other parsers.

Attempt to resolve any paths found in the config file. NOTE: This method is recursive to crawl the whole config object, and also mutates the

Generate list of fixes to convert CAST and CONVERT to ShorthandCast.

Find every occurrence of the given substrings.

Convert tokens to segments.

Return all parse errors, including unparsable nodes anywhere in the tree. Top-level parse failures surface in parsed.violations, but content that

Adds the fix and updates stats. We also allow potentially multiple source fixes on the same anchor by condensing them together here.

Slice template in jinja.

Actually this match to segments to instantiate. This turns a theoretical match into a nested structure of segments. We handle child

Set the Python recursion limit from CLI flag or config, with validation.

Assert that a given rule does fail on the given sql. Args: code (str): The code of the rule to test. sql (str): The SQL text to c

Assert that a given rule doesn't fail on the given sql.

Benchmark a list of SQL files. Args: sql_files: List of SQL files to benchmark use_rust: Whether to use Rust parser itera

Get a tuple representing this error. Mostly for testing.

Build config overrides for a fixture, including deep recursion cases.

Copy the segment recursively, with appropriate copying of references. Optionally provide child segments which have already been dealt

Returns the number of segments in this segment.

Work out the difference between two dictionaries. Returns a dictionary which represents elements in the `left` dictionary which aren't in the

Evaluate the test case. NOTE: This method is designed to be run in a pytest context and will call methods such as `pytest.skip()` as

Extract possible references of a given level. "level" may be (but is not required to be) a value from the ObjectReferenceLevel enum d

Generate a DepthMap from all the children of a segment. NOTE: This is the most efficient way to construct a DepthMap due to caching i

Use the fixed tree to generate source patches. Importantly here we deduplicate and sort the patches from their position in the templated file

A helper function to extract possible consumed whitespace. Args: segment (:obj:`RawSegment`, optional): A segment to test for

Get a location tuple at the end of this segment.

Get the current raw representation.

Returns the type of this segment as a string.

Get a list of violations, respecting filters and ignore options. Optionally now with filters.

Does `(un)quoted_identifiers_policy` apply to this segment? This method is used in CP02, RF04 and RF05.

Returns a new :obj:`ReflowSequence` with the new element inserted. Insertion is always relative to an existing element. Either before

Return True if this segment is a comment.

Return whether this segment is optional. The optional attribute is set in the __init__ method.

Walk a config dict and get config elements. >>> list( ... iter_records_from_nested_dict( ... {"foo":{"bar":{"baz": "a", "biz":

Lint and optionally fix a tree object.

Match against this matcher. NOTE: We check that the segment is also code to avoid matching unexpected comments.

Match against this matcher. NOTE: This method's case sensitivity is based on objects ignore_case property

Returns a new, unique slice ID.

Parse a series of lexed tokens using the current dialect.

Parse an ansi sql string for testing.

Returns true if this segment considered at all. This method is called during crawling but also in evaluating the anchors for linting

Persist changes to files in the given path. This also logs the output as we go using the formatter if present.

Persist changes to the given path.

Print benchmark results.

Decorate a class with this to add it to the ruleset. .. code-block:: python @myruleset.register class Rule_LT01(BaseRu

Run a command and report status. Args: cmd: Command and arguments as list description: Human-readable description Returns:

Return a dict containing linting stats about this path.

A basic timing function.

Serialise the source position.

Get the uuid on top of the stack.

Trim forward segments based on terminators. Given a forward set of segments, trim elements from `segments` to `tail` by using a `greedy_match

Validates a config dict against removed values. Where a value can be updated or translated, it mutates the config object. In general the `re

Wrap a field (label, val). Returns: A dict of {label_list, val_list, sep_char, lines}

Attempt to resolve a full query which may contain wildcards. NOTE: This requires a ``Query`` as input rather than just a ``Selectable

Shim function used in parallel mode.

Deduce the current indent string. This method accounts for both literal indents and indents consumed from the source as by potential templati

Ensure pytest logging components are available.

Extract RsToken objects from RawSegments. This extracts the cached _rstoken attribute from segments that came from the Rust l

Find a subset of the sliced file which touch this point. NB: the last_idx is exclusive, as the intent is to use this as a slice.

Build a user-facing TOML parsing error message.

Get the current indent segment (if there). NOTE: This only returns _untemplated_ indents. If templated newline or whitespace segments