Format the a set of rules given a `Linter`.

Create a parent marker from it's children.

Create IndentStats from two consecutive IndentStats. This is mostly used for combining the effects of indent and dedent tokens either

Make a TemplateElement from a LexedElement.

Constructs a ReflowConfig from a FluffConfig.

Interpret a PathStep to construct a StackPosition. The reason we don't just use the same object is partly to interpret it a little mo

Construct a position marker from the section between two points.

Construct from a raw and its stack.

Create a RawSegment from result segments.

Loads a config object based on the root directory. Args: extra_config_path (str, optional): An optional additional path

Create a SQLLexError from a RsSQLLexerError.

Convert a Rust RsParseError to SQLParseError. Args: rs_error: The RsParseError exception from Rust parser segments: T

Create a RawSegment from an RSQL token. Args: token: The Rust token to create the segment from tf: The TemplatedFile

Look for inline ignore comments and return NoQaDirectives. Very similar to .from_tree(), but can be run on raw source (i.e. does not

Replaces (via monkeypatch) the jinja2.Environment function.

Gather the list of files to generate fixtures for. Apply filters as required.

Generate markdown content for a single command. Args: cmd_info: Command information dictionary Returns: Markdown content

Generate the dialect enum and associated functions.

Generate dialect documentation markdown files. Returns: Dictionary with sidebar configuration for VitePress

This function handles nested block comments. Since this function is now shared across all dialects, we just need to generate a wrapper that p

Generate the index markdown with API overview. Args: modules: List of module information dicts Returns: Markdown content for

Generate the index markdown with command summary. Args: commands: List of command information dictionaries Returns: Markdown

Generate the lexers for all dialects.

Generate markdown content for a module. Args: name: Display name of the module module_name: Name of the module functions:

Generate fixture or a subset based on dialect or filename glob match.

Generate the table-driven parser for a dialect.

Generate the keywords for a dialects.

Generate rule documentation markdown files. Returns: Dictionary with sidebar configuration for VitePress

Generate Rust static table initialization code.

Generate VitePress sidebar configuration. Args: modules: List of module information dicts Returns: Sidebar configuration dic

Generate VitePress sidebar configuration. Args: commands: List of command information dictionaries Returns: Sidebar configur

Generates the `use` statements.

Generates the `use` statements.

Generates the `use` statements.

Generates warnings for any unused NoQaDirectives.

Run a roundtrip test given a sql file and a rule. We take a file buffer, lint, fix and lint, finally checking that the file fails initially b

Get info on alias within SELECT clause element.

Gets the aliases referred to in the FROM clause. Returns a tuple of two lists: - Table aliases - Value table function aliases

Get rule config validations and descriptions.

Get the templating context from the config.

Get the templating context from the config. This function retrieves the templating context from the config by loading the config and

Return a valid list of CTES with required padding segments.

Get a point marker at the end of this segment.

Returns rightmost & lowest descendant and its "parent stack".

Get the appropriate lexer class based on availability. Returns PyRsLexer if the Rust extension is available, otherwise returns PyLexer.

Hook to get all the rules.

Get formatted option names (e.g., '-v, --verbose'). Args: param: Click parameter object Returns: Comma-separated option name

Get the current python implementation as a string. This is useful if testing in pypy or similar.

Get the current python version as a string.

Generate a summary to total time in each rule. This is primarily for csv export.

Dynamically create a map of segment types to their subclasses.

Use parsed tree to extract table references.

Returns list of trailing newlines in the tree.

r"""Returns the trailing whitespace from a string. Designed to work with source strings of placeholders. >>> get_trailing_whitespace_from_st

If block open uses whitespace stripping, record it. When a "begin" tag (whether block, comment, or data) uses whitespace stripping

Check inline spacing is the right size. This forms one of the cases handled by .respace_point(). This code assumes: - a ReflowPoint with

Ensure spacing is the right size. This forms one of the cases handled by .respace_point(). This code assumes: - a ReflowPoint with no ne

Based on the fix slices, should we discard the fix?

Identify keyword areas in file to rebreak. A span here is a block, or group of blocks which have explicit configs for their keyword's line po

Infer a python type from a string and convert. Given a string value, convert it to a more specific built-in Python type (e.g. int, fl

Check if SQLFluff is installed.

Instrument Python parser to collect metrics.

Overwrite superclass functionality.

Is this line made up of just comments?

Is this line made up of just template elements?

A match is better compared on length.

Does the character have differing lower and upper-case versions?

Return True if there are no ignorable violations.

Evaluate conditionals and return whether enabled.

Return whether this element is optional.

A marker is a point if it has zero length in templated and source file.

Does this segment match the relevant criteria.

Returns a function that checks if segment is whitespace.

Iterate through partials or deferred tasks for parallel linting. When the active templater supports worker-side rendering (``template

Iterate through rendered files ready for linting.

Iterate through any unparsables this segment may contain.

Loop over each element as a fresh Segments.

Run a roundtrip test path and rule. We take a file buffer, lint, fix and lint, finally checking that the file fails initially but not after f

Lint SQL files via passing a list of files or using stdin. PATH is the path to a sql file or directory to lint. This can be either a file ('p

Lint a SQL string. Args: sql (:obj:`str`): The SQL to be linted. dialect (:obj:`Optional[str]`, optional): A reference to the dia

Lint the sequence to lines over the configured length. NOTE: This assumes that `lint_indent_points` has already been run. The method won't ne

Return a list of available dialect info.

Loads the default configuration for the plugin.

Load the existing manifest if present, otherwise return defaults.

Read the SQLFluff config section of a pyproject.toml file. We don't need to change any key names here, because the root section of the toml f

Main benchmark runner.

Run benchmarks.

Run the parser comparison.

Main entry point. Parses arguments, reads the Rust grammar file, extracts tables, and writes the output JSON file with grammar instructions,

Generate API documentation.

Main entry point.

Main entry point.

Main entry point.

Generate CLI documentation.

Main entry point.

Find all example SQL files, parse and create YAML files.

Work out how to find paths given a dialect and a file name.

Work out how to find paths given a dialect and a file name.