Creates a new object derived from JinjaAnalyzer. Derived classes can provide their own analyzers (e.g. to support custom Jinja tags).

Get the list of macros paths from the provided config object. This method searches for a config section specified by the templater_se

Get a dbt profile name from the configuration.

Get the dbt profiles directory from the configuration. The default is `~/.dbt` but we use the default_profiles_dir from the dbt libra

Get the dbt threads value from the configuration. If not set, returns ``None`` which lets dbt use the value from ``profiles.yml``.

Return whether a cast expression wraps a simple expression.

Return whether a segment should be treated as a simple expression.

Yield any source patches as fixes now. NOTE: This yields source fixes for the segment and any of its children, so it's important to call it a

Linter with max_parse_nodes set, forcing the Python parser path.

Load the ignore spec from an iterable of lines. Raises SQLFluffUserError if unparsable for any reason.

A helper function for the return values of AnyNumberOf. This method creates UnparsableSegments as appropriate depending on the parse mode and

Return the line number in the chosen coordinate space.

Refresh positions of segments within a span. This does two things: - Assign positions to any segments without them. - Updates

Replace `regex` with `replacement` twice on `original`. This is used by string normalization to perform replaces on overlapping matches.

Sort a dict of occurrences into a sorted list of tuples.

Unpack a spacing constraint. Used as a helper function in `determine_constraints`.

Validate the indentation config section of the config. We check for valid values for enum-like config options.

Validate and normalize the max_parse_depth config value. The parser convention is that ``0`` disables the limit. We also normalize missing/No

Validate and normalize the max_parse_nodes config value. The parser convention is that ``0`` disables the limit. We also normalize missing/No

Add a file to this path. This function _always_ updates the metadata tracking, but may or may not persist the `file` object itself de

Generate a noqa rule reference map.

Test that the class remains the same through copying and pickling.

Assert a ReflowSequence has the defined structure.

Get the cache key for this grammar. For grammars these are unique per-instance.

Clean up docstring formatting by removing excess indentation. Args: text: Raw docstring text Returns: Cleaned text with norm

Try to coerce to a more specific type.

Prints message when SQLFluff is finished.

Group and count fixes by anchor, return dictionary.

Construct a single indent unit.

Create a copy of this ``FluffConfig``. Copies created using this method can safely be modified without those changes propagating back

Run the rule on a given tree. Returns: A tuple of (vs, raw_stack, fixes, memory)

Given a raw segment, deduce the indent of its line.

Fixture to check specific segments of a dialect.

Dispatch the header displayed before linting.

Return the closing index of this slice.

Expand any callable references to concrete ones. This must be called before using the dialect. But allows more flexible definitions t

Extract a block of text. Extracts from the input string starting at the given marker and ending at the next occurrence of '];'. Raises Runtim

Extract information from a function for documentation. Args: func: Function object to document module_name: Name of the module co

Construct a ReflowSequence from a sequence of raw segments. This is intended as a base constructor, which others can use. In particul

Create a PositionMarker from an RsPositionMarker.

Parse noqa directives from raw source using a dialect's comment matcher. If a dialect does not define an ``inline_comment`` lexer matcher, re

A test for roundtrip testing, take a file buffer, lint, fix and lint. This is explicitly different from the linter version of this, in that i

Given the class types of a ReflowBlock return spacing config. When fetching the config for a single class type for a simple block we

Rehydrate the bracket segments in question.

Get the config from core sqlfluff and sqlfluff plugins and merges them. NOTE: This should be the entry point into getting config info rather than

Return the config lookup ref for this rule. If a `name` is defined, it's the name - otherwise the code. The name is a much more unde

Return the eventual table name referred to by this table expression. Returns: :obj:`tuple` of (:obj:`str`, :obj:`BaseSegment`, :o

Return the eventual table name referred to by this join clause.

Get the identifier of this CTE. Note: it blindly gets the first identifier it finds which given the structure of a CTE definition is

Iterate through any indent segments and extract their values.

Get the current version of the sqlfluff package.

Reads all of the Rule classes from a path into a list.

Get a config object from simple API arguments.

Get a location tuple at the start of this segment.

Find wildcard (*) targets in the SELECT.

Match anything up to some defined terminator.

Ignore this violation if it matches the iterable.

Mutate the config based on additional information.

Using the raw string provided to infer the position of the next. NB: Line position in 1-indexed.

Return whether this element is all unrendered. Returns True if contains only whitespace, indents, template loops or placeholders.

Check whether this looks like a dbt exception.

Return whether this a valid source only edit. Args: single_source_fix (:obj:`bool`): Check for a single source_fixes.

Find the indices of all newlines in a string.

Take a string or TemplatedFile and return segments.

Iteratively match strings using the selection of submatchers.

Lint a ParsedString and return a LintedFile.

Load the given config file into a dict and validate. This method is cached to mitigate being called multiple times. This doesn't manage the

Load a config resource from a python package. Args: package (str): The name of the python package to load the resource from.

Load a config from a string in ini format. Args: config_string (str): The raw config file as a string. The content is assumed

Load a file.

Load rule test cases from YAML files. Args: test_cases_path (str): A glob string specifying the files containing test cases t

Return longest match from a selection of matchers. Priority is: 1. The first total match, which means we've matched all available segments or

Look up a CTE by name, in the current or any parent scope.

Given a string, match what we can and return the rest. Returns: :obj:`LexMatch`

Merge source patches from multiple variants. Patches are deduplicated in source space. Conflicting patches are skipped so that the non-confli

Look ahead for matches beyond the first element of the segments list. NOTE: Returns *only clean* matches. This function also contains the pe

The opening indent balance of the line. NOTE: We use the first point for the starting balance rather than the line starting balance b

Parse an ansi sql string for testing.

Add the specified (default: current) location to the trace. Args: target_slice_length (int): The length of the target slice.

Recursively crawl for segments of a given type. Args: seg_type: :obj:`str`: one or more type of segment to look f

Dummy method that renders the tag.

Load and render a file with relevant config.

Reraise the encapsulated exception.

Recursive match to resolve an opened bracket. If `nested_match` is True, then inner bracket matches are also returned as child matches. Other

This is the entry method into parsing a file lexed segments. For single pass matching, this trims any non code off the start, matches

Save benchmark results to JSON file. Args: results: Benchmark results dictionary output_file: Path to output JSON file

Retrieve subset of children based on range and filters. Often useful by linter rules when generating fixes, e.g. to find whitespace s

Set this segment as parent for child all segments.

Set the lexer struct for the dialect. This is what is used for base dialects. For derived dialects (which don't exist yet) the assump

Set the weak reference to the parent. We keep a reference to the index within the parent too as that is often used at the same point

Set a value at a given path. Args: config_path: An iterable of strings. Each should be a one of the elements whic

Returns True if text output should be plain (not colored).

Move an index backward through segments until segments[index - 1] is code.