Generate a reference to a keyword by name. This function is entirely syntactic sugar, and designed for more readable dialects.

Combine another subsequent match onto this one. NOTE: Because MatchResult is frozen, this returns a new match.

Extend the parent class method with the surrogate types.

Allows access to sets belonging to this dialect. These sets belong to the dialect and are copied for sub dialects. These are used in

Return a copy of self with a separate register.

Get a particular value from the config. Args: val (str): The name of the config value to get. section (str or iterabl

Replace supplied anchor segment with the edit segments.

Return configured value for ``recursion_limit``; else default.

Write message to stdout.

Retrieve the first of the children of this segment with matching type.

Children could be CTEs, subselects or Others.

Return specified item. Returns default if index out of range.

Allow access to grammars pre-expansion. This is typically for dialect inheritance. This method also validates that the result is a gr

Recursively crawl for segments of a given type.

Lint a string. Returns: :obj:`LintedFile`: an object representing that linted file.

Add a timing dictionary to the summary.

Invoke a command and check return code.

Retrieve range/subset. NOTE: Iterates the segments BETWEEN start_seg and stop_seg, i.e. those segments are not included in the loop.

Match a list of segments against this segment. Matching can be done from either the raw or the segments. This raw function can be ove

Delete supplied anchor segment.

Return just the violations from lintfix when we're only linting.

Create TemplatedFile from a string.

Parse a string.

Insert new records into an existing lexer struct. Used to edit the lexer of a sub-dialect. The patch is inserted *before* whichever e

Add string to table (deduplicated). Returns string_id.

Take a string or TemplatedFile and return segments. If we fail to match the *whole* string, then we must have found something that we

Returns the first segment (if any) that satisfies the predicates.

Optionally use ANSI colour codes to colour a string.

Dynamically load a dialect.

Create an empty match at a particular index.

Use regex to find a substring.

Copy this dialect and create a new one with a different name. This is the primary method for inheritance, after which, the `replace`

Return the fixed tree and violations from lintfix when we're fixing.

Return a list of violations in the path.

Pop a block from the stack.

Return a whole section of config as a dict. If the element found at the address is a value and not a section, it is still returned an

Special function to update a keywords set from a multi-line string.

Return the number of newlines in this element. These newlines are either newline segments or contained within consumed sections of wh

Returns a normalized string of the raw content. E.g. This removes leading and trailing quote characters, removes escapes, optionally

Use indentation to render this segment and its children as a string. Args: ident (int, optional): The indentation level. Defaults

Fetch a description of this violation.

Given a root segment, find the first appropriate selectable and analyse.

Roughly generate test segments. This is a factory function so that it works as a fixture, but when actually used, this will return the inner

Return a tuple structure from this segment.

Obtain the changes to a path as a string. We use the source mapping features of TemplatedFile to generate a list of "patches" which c

Retrieve the all of the children of this segment with matching type.

Infer literalness from context. is_literal should return True if a fix can be applied across this area in the templated file while be

Compress all the tuples into one list. NB: This is a little crude, as you can't tell which file the violations are from. Good for tes

Instantiate a config from a subset of common options. Args: dialect (str, optional): The name of the dialect to use.

Fetch the code of the rule which cause this error.

Construct a raw segment as a fixture.

Patch an existing lexer struct. Used to edit the lexer of a sub-dialect.

Given a segment which is assumed within self, get the intermediate segments. Returns: :obj:`list` of :obj:`PathStep`, not includi

Returns index if found, -1 if not found.

Returns the type of this segment as a string.

Returns the last segment (if any) that satisfies the predicates.

Lint a path.

Construct a raw segment as a fixture.

Create a new segment, with exactly the same position but different content. Args: raw (Optional[str]): The new content for the se

Coerce a point to have a particular indent. If the point currently contains no newlines, one will be introduced and any trailing whit

Lint an iterable of paths.

Create edit segments after the supplied anchor segment.

Increment match depth. Args: name (:obj:`str`): Name of segment we are starting to parse. NOTE: This value is ent

Parse the up/down blocks.

Create edit segments before the supplied anchor segment.

Return a set of sql file paths from a potentially more ambiguous path string. Here we also deal with the any ignore files file if present, whethe

Add a segment to the dialect directly. This is the alternative to the decorator route, most useful for segments defined using `make`.

Do any of the segments match?

Apply function to every item.

Allows access to bracket sets belonging to this dialect.

Make a crude ascii table. Assume that `fields` is an iterable of (label, value) pairs.

Generate a readout of available dialects.

Get a point marker from the end.

Initializes the PluginManager. NOTE: We cache the plugin manager as a global to avoid reloading all the plugins each time.

Increment the number of materialized parse nodes. Args: count (int): Number of nodes to add to the current budget.

Dispatch a string to the callback. This method is designed as a point for subclassing.

Flatten list of grammars. Returns list of GrammarIds.

Return the result as a list of dictionaries. Each record contains a key specifying the filepath, and a list of violations. This metho

Get a config object from kwargs.

Process a string and return the new string. Note that the arguments are enforced as keywords because Templaters can have differences

Build flags bitfield from grammar attributes.

Do all the segments match?

Is this segment class (or its parent) of the given type.

Recursively flatten Grammar tree to tables. Returns GrammarId for this node.

Loads a config object given a particular path. Args: path (str): The target path to load config files from. Files

Recursively generate a query from an appropriate segment.

Generate a list of reference strings and elements. Each reference is an ObjectReferencePart. If some are split, then a segment may ap

Returns a new :obj:`ReflowSequence` with `edit` elements replaced. This generates appropriate replacement :obj:`LintFix` objects to direct

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

Precompute and add simple hint. Returns hint_id (0 = None).

Return the segment as a structurally simplified record. This is useful for serialization to yaml or json. kwargs passed to to_tuple

Return a dialect given its name.

Context manager that sets the level for capturing of logs. After the end of the 'with' statement the level is restored to its original value.

Get hold of a set of rules.

Return true if this is a zero slice.