Handle the initial signature of the node. This formats the header of the section.

Words that the rule should ignore. Cached so that it's only evaluated on the first pass.

Invalidate the cached properties. This should be called whenever the segments within this segment is mutated.

Returns a function that checks if segment is code.

Return True if this segment contains any code.

Returns a function that checks if segment is comment.

Return True if this is entirely made of comments.

Returns a function that checks if segment is meta.

Return whether this element is optional.

Return whether this element is optional. This is mostly set in the init method, but also in this case, if min_times is zero then this

Not optional. NOTE: The NonCodeMatcher is only normally only used as a terminator or other special instance matcher. As such the `.si

Return whether this element is optional. A lookbehind matcher is never optional — it must always be evaluated.

Returns False because Segments are never optional. This is used _only_ in the `Sequence` & `Bracketed` grammars to indicate optional

Returns a function that checks if segment is raw.

Does this segment match the relevant criteria. We use the _direct_ child set here so that if any of the direct child segments match a

Returns a function that determines if segment is one of the types.

Returns a function that determines if segment is one the types.

Returns a function that checks if segment is templated.

Returns True if the segment includes any templated code. This is a simple, very efficient check that doesn't require looking up the R

Returns True if valid combination of fixes for anchor. Cases: * 0-1 fixes of any type: Valid * 2 fixes: Valid if and only if

Return True if this segment is entirely whitespace.

Generate a list of reference strings and elements. Each element is a tuple of (str, segment). If some are split, then a segment may a

Iterate through any unparsables. As this is an unparsable, it should yield itself.

Raise an exception if the file is over a defined size. Designed to be implemented as a decorator on `.process()` methods. If no config is pr

Return the line number in the source.

Return the line position in the source.

Add lint operation options to commands via a decorator. These are cli commands that do linting, i.e. `lint` and `fix`.

Return a list of available rule tuples.

Load a config resource. NOTE: Deprecated classmethod maintained because it was in our example plugin for a long while. Remove once th

Loads the default configuration for the plugin.

Loads the default configuration for the plugin.

Load a yaml structure and process it into a tuple.

This gracefully handles logging issues at session teardown. Removes handlers from all loggers. Autouse applies this to all tests in this file

Make a comparison tuple for test matching.

Match against this matcher.

Matches... Anything. Most useful in match grammars, where a later parse grammar will work out what's inside. NOTE: This gram

Always return a failed (empty) match.

Match a bracketed sequence of elements. This implementation matches a bracketed expression without recursion or seeking ahead.

If enabled, return a single insert of the new segment.

Match against any of the elements a relevant number of times. If it matches multiple, it returns the longest, and if any are the same

Match any starting non-code segments.

Only useful as a terminator. NOTE: Coverage of this method is poor, because in typical use as a terminator - the `.simple()` method c

Return match success rate.

Convert a segment class name to a token name.

Return list of the lines in src_path that were measured.

Sets the XDG_CONFIG_HOME variable.

Return parse time per token in ms.

Test normalising paths. NB Paths on difference platforms might look different, so this makes them comparable.

Returns a function that computes: not fn().

Count the number of violations in the result.

Returns a function that computes the functions or-ed together.

Returns a Segments object for context.parent_stack.

Parse SQL files and just spit out the result. PATH is the path to a sql file or directory to lint. This can be either a file ('path/to/file.s

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

Parse report output. Not used by SQLFluff.

Patch for os.path.exists which depends on test parameters. Returns: True, unless `default_exists` is `False` and the path passed

Run all the fixes for all the files and return a dict.

Get the first position marker of the element.

Add the code element to the logging message before emit.

Yield the same templated file twice with duplicate errors.

Returns the dbt project directory.

Returns the dbt project directory.

Return pruning rate (% of options dropped).

Generate yaml test cases from file. This is a predefined pytest hook which allows us to parametrize all other test cases defined in this modu

Return a list of strings to be displayed in the header of the report.

Re-presenter which always double quotes string values needing escapes.

Raises errors that break the Fix process. These errors are otherwise swallowed to allow the lint messages to reach the end user.

Get the current raw representation.

Returns the raw segment.

Make a string from the segments of this segment.

Returns a function that determines if segment matches one of the raw inputs.

Construct a raw segment as a fixture.

Construct a list of raw segments as a fixture.

Construct a list of raw segments as a fixture.

Returns a Segments object for all the raw segments in the file.

Get raw segments underlying the segments.

Returns self to be compatible with calls to its superclass.

Returns a list of raw segments in this segment.

Returns a list of raw segments in this segment with the ancestors.

Returns raw slices for a segment.

Raw slices of the segments, sorted in source file order.

Returns a Segments object for context.raw_stack.

Returns the raw segment in uppercase.

Make an uppercase string from the segments of this segment.

Recursively crawl all descendant segments.

Change version number in the cfg files. NOTE: For fine grained personal access tokens, this requires _write_ access to the "contents" scope.