Slice the file to determine regions where we can fix. Args: raw_str (str): The raw string to be sliced. render_func (

Returns a RawSliceInfo for a literal. In the alternate template, literals are replaced with a uniquely numbered, easy-to-parse litera

Check whether two slices overlap. NOTE: This is designed only for use with *closed* and *positive* slices.

Return a slice object for this slice.

Take the keys of two dictionaries and add their values.

Return a dict of properties. This is useful in the API for outputting violations.

Create a segment from this lexed element.

Update the progress bar if configured. If progress isn't configured, we do nothing. If `track_progress` is false we do nothing.

Checks correctness of new segment by re-parsing it.

Warning only for this violation if it matches the iterable. Designed for rule codes so works with L001, LL0X but also TMP or PRS for

Location tuple for the working position.

Wrap a string into a list of strings all less than <width>.

Write UTF-8 text content with a trailing newline.

Resolve the number of columns in a single Selectable. The selectable may or may not have wildcard (*) expressions. If it does, we att

Add regex pattern to table (deduplicated). Returns regex_id.

Makes simple fixes to the anchor position for fixes. Some rules return fixes where the anchor is too low in the tree. These are most

Given info on a list of SELECTs, determine whether to warn.

Check if dbt builtins should be applied from the provided config object. This method searches for a config section specified by the t

Use patches and raw file to fix the source file. This assumes that patches and slices have already been coordinated. If they haven't

Clear out files matching the provided glob expression.

Generate list of fixes to convert CASE statement to COALESCE function.

Collapse multiline rst list-table cell content to a single markdown cell.

Generate list of fixes to reduce CASE statement to a single column.

Construct alignment whitespace using tabs or spaces. Args: width: Number of whitespace characters needed. indent_unit: Either 'ta

Crawl through a reflow sequence, mapping existing indents. This is where *most* of the logic for smart indentation happens. The values return

Construct reflow elements from raw segments. NOTE: ReflowBlock elements should only ever have one segment which simplifies iteration

Multiple select targets. Ensure each is on a separate line.

Expand a list of rule references into a list of rule codes. Returns: :obj:`set` of :obj:`str` rule codes.

Load macros directly in a config and from load_macros_from_path. Args: config: The config to extract macros from. env

Take a template string and extract any macros from it. Lovingly inspired by http://codyaray.com/2015/05/auto-load-jinja2-macros Rais

If a segment is present and is a literal, return it's source length.

Filter a dict of occurrences to just those within a slice.

Helper method to find an element within a segment. Note: This method is currently excluded from test coverage because it is not

Get the actual object we're referencing.

Return parse and templating violations after applying ignore settings.

Calculate the indentation level for rebuilding nested struct. This is only a best attempt as the input may not be equally indented. The layou

Get the last statement from a file segment.

Get the SQLFluff package version from importlib. NOTE: At the stage of loading plugins, SQLFluff isn't fully initialised and so we can't use

Get the user config dir for this system. Args: sys_platform (str): The result of ``sys.platform()``. Provided as an argument

Adjust segments to not move preceding inline comments. We don't want to move inline comments that are on the same line as the precedi

Handles the treatment of files with templating and parsing issues. By default, any files with templating or parsing errors shouldn't have fix

Generate placeholders and loop segments from a zero length slice. This method checks for: 1. Backward jumps (inserting :obj:`TemplateLoop`).

Initializes any global state. May be overridden by subclasses to apply global configuration, initialize logger state in child process

Check if the statement containing the provided segment is one line.

Return whether a function segment is considered simple.

Return whether a raw slice is a Jinja tag with whitespace trimming.

Iterate along a list of valid alias targets.

Extract the elements of a reference and yield.

Loads a single plugin with a bit of error handling.

Load the config from the user's OS specific appdir config directory.

Match file path against extensions. Assumes that valid_extensions is already all lowercase. Returns: True if the file has an extensi

Normalise newlines to unix-style line endings.

Pad a table row to the expected number of columns.

Helper function for select crawlers. Given a SQL statement this crawls the SQL and instantiates a Query on the outer relevant segment.

Handle fixing from paths.

Returns the preamble to any logging.

Record _class_types for a grammar entry's Python segment class. Populates ``segment_class_types_sparse`` and ``segment_class_types_data``

Seek in a direction, looking for newlines. Args: segments: A sequence of segments to seek within. idx: The index of t

Apply casing and convert strings to Keywords.

Helper function to set up config consistently for pass & fail functions.

Use patches to safely slice up the file before fixing. This uses source only slices to avoid overwriting sections of templated code i

Slice a templated python string into token tuples. This uses Formatter() as per: https://docs.python.org/3/library/string.html#string

Split a sliced file on its invariant literals. We prioritise the _longest_ invariants first as they are more likely to be the anchors

Within each of the compound sections split on unique literals. For everything else we coalesce to the dominant type. Returns:

Handle fixing from stdin.

Trim the ends of a intermediate segment.

Given a string, trim if we are allowed to. Returns: :obj:`tuple` of LexedElement

Update the tracking of untaken indents and balances. This is an internal helper function for `_crawl_indent_points`.

Ensure that all config options are valid. Config options can also be checked for a specific rule e.g CP01.

Validate the layout config section of the config. We check for valid key values and for the depth of the structure. NOTE: For now we don

Add a new `LintedDir` to this result.

Apply a dictionary of fixes to this segment. Used in to apply fixes found in linting. If a segment remains unchanged then the original is ret

Dict representation for logging/testing.

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

Assert that a matcher does or doesn't work on a string. The optional `matchstring` argument, which can optionally be None, allows to either t

Assert that a given rule raises given errors in specific positions of a file. Args: rule (str): The rule we're looking for. fpath

The closing indent balance of the line.

Coalesce this whole slice into a single one. Brutally.

Take any set of dictionaries and combine them.

Get the common depth and hashes with the other.

Given a parse tree, compute a consistent hash value for it.

Copy the depth info for one segment and apply to another. This mutates the existing depth map. That's ok because it's an idempotent o