Returns: string_idx such that @LL[string_idx] is equal to our target (i.e. matched) string, if this line matches the

Equivalent to 'node.children.append(child)'. This method also sets the child's parent attribute appropriately.

Append `leaf` to current line or to new line if appending impossible.

Return a new line with given `leaves` and respective comments from `original`. If it's the head component, brackets will be tracked so trailing c

Raise :exc:`CannotSplit` if the last left- or right-hand split failed. Do nothing otherwise. A left- or right-hand split is based on a pair

Perform stability and equivalence checks. Raise AssertionError if source and destination contents are not equivalent, or if a second pass of

Return a cloned (deep) copy of self. This must be implemented by the concrete subclass.

Returns: True iff one of the comments in @comment_list is a pragma used by one of the more common static analysis tools for pytho

Convert raw node information to a Node or Leaf instance. This is passed to the parser driver which calls it whenever a reduction of a gr

Count the number of characters in `line_str` that would fit in a terminal or editor of `max_width` (which respects Unicode East Asian Width).

Return the number of delimiters with the given `priority`. If no `priority` is passed, defaults to max priority on the line.

Dump `output` to a temporary file. Return path to the file.

Return a directory containing .git, .hg, or pyproject.toml. That directory will be a common parent of all files and directories passed in `sr

r"""Return the path to the top-level user configuration for black. This looks for ~\.black on Windows and ~/.config/black on Linux and other

Returns the first leaf of the node tree.

Format file under `src` path. Return True if changed. If `write_back` is DIFF, write a diff to stdout. If it is YES, write reformatted code t

Format file on stdin. Return True if changed. If content is None, it's read from sys.stdin. If `write_back` is YES, write reformatted code b

Reformat a string and return new contents. `mode` determines formatting options, such as how many characters per line are allowed. Example:

Generator yielding all matches for this pattern. Default implementation for non-wildcard patterns.

Get the cache directory used by black. Users can customize this directory on all systems using `BLACK_CACHE_DIR` environment variable. By def

Return a PathSpec matching gitignore content if present.

Return randomly generated token to mask IPython magic with. For example, if 'magic' was `%matplotlib inline`, then a possible token to mask i

Factory for a convenience function that is used to orphan @string_leaf and then insert multiple new leaves into the same part of the node

Determine whether formatting is switched on within a container. Determined by whether the last `# fmt:` comment is `on` or `off`.

Return True if content between `opening` and `closing` is a one-sequence.

Return True if `node` holds a tuple with one element, with or without parens.

Return True if `node` is a simple statement containing an ellipsis.

Return True if `node` is a suite with a stub body.

Given a string with source, return the lib2to3 Node.

Load the grammar (maybe from a pickle).

Mark `leaf` with bracket-related metadata. Keep track of delimiters. All leaves receive an int `bracket_depth` field that stores how deep

If our environment has uvloop installed we use it. This is called only from command-line entry points to avoid interfering with the parent pr

Make existing optional parentheses invisible or create new ones. `parens_after` is a set of string leaf values immediately after which parens

Make all string prefixes lowercase.

Parse a string and return the syntax tree.

Parse a series of tokens and return the syntax tree.

Compile a regular expression string in `regex`. If it contains newlines, use verbose mode.

Read the cache if it exists and is well formed. If it is not well formed, the call to write_cache later should resolve the issue.

Transform a `line`, potentially splitting it into many lines. They should fit in the allotted `line_length` but might not be able to. `featu

Wrap stream with colorama's wrap_stream so colors are shown on Windows. If `colorama` is unavailable, the original stream is returned unmodi

Update the cache file.

Constructor. The grammar argument is a grammar.Grammar instance; see the grammar module for more information. The parser is

Constructor that prevents Base from being instantiated.

You are in a twisty little maze of passages.

Returns: string_idx such that @LL[string_idx] is equal to our target (i.e. matched) string, if this line matches the

Returns: string_idx such that @LL[string_idx] is equal to our target (i.e. matched) string, if this line matches the

Special optimized matcher for bare_name.

See `can_omit_invisible_parens`.

See `can_omit_invisible_parens`.

Returns: string_idx such that @LL[string_idx] is equal to our target (i.e. matched) string, if this line matches the

Returns: string_idx such that @LL[string_idx] is equal to our target (i.e. matched) string, if this line matches the

Compare two nodes for equality. This is called by __eq__ and __ne__. It is only called if the two nodes have the same type.

Generate all leaves that should be ignored by the `# fmt: skip` from `leaf`.

This method contains the algorithm that StringSplitter uses to determine which character to split each string at. Args:

Calculates the max string length used when attempting to determine whether or not the target string is responsible for causing the li

Imitates get_normal_name in tokenizer.c.

Yields: All ranges of @string which, if @string were to be split there, would result in the splitting of an f-express

Yields: All ranges of @string which, if @string were to be split there, would result in the splitting of an \\N{...}

Helper to iteratively yield the matches.

When enabled and safe, wrap the multiple context managers in invisible parens. It is only safe when `features` contain Feature.PARENTHESIZED_CONT

Merges one string group where the first string in the group is `LL[string_idx]`. Returns: A tuple of `(num_of_st

Merges string groups (i.e. set of adjacent strings). Each index from `string_indices` designates one string group's first le

Inquire whether file a was written since file b.