Index

Symbols

--colour snippet-fmt command line option --config-file <config_file> snippet-fmt command line option --diff snippet-fmt command line option --exclude <PATTERN> snippet-fmt command line option --no-colour snippet-fmt command line option --traceback snippet-fmt command line option

--verbose snippet-fmt command line option -c snippet-fmt command line option -e snippet-fmt command line option -T snippet-fmt command line option -v snippet-fmt command line option

_

__call__() (Formatter method)

__repr__() (CodeBlockError method)

C

CodeBlockError (namedtuple in snippet_fmt) exc (namedtuple field) offset (namedtuple field)

compile_regex() (Reformatter method) config (Reformatter attribute)

D

directives TOML configuration field

DocstringReformatter (class in snippet_fmt)

E

exc (namedtuple field) CodeBlockError (namedtuple in snippet_fmt)

F

file_to_format (RSTReformatter attribute) FILENAME snippet-fmt command line option filename (Reformatter attribute)

format_ini() (in module snippet_fmt.formatters) format_json() (in module snippet_fmt.formatters) format_python() (in module snippet_fmt.formatters) format_toml() (in module snippet_fmt.formatters) Formatter (protocol in snippet_fmt.formatters)

G

get_diff() (DocstringReformatter method) (Reformatter method)

I

indent (DocstringReformatter attribute)

ini.reformat TOML configuration field

J

json.allow_nan TOML configuration field json.ensure_ascii TOML configuration field json.indent TOML configuration field

json.reformat TOML configuration field json.separators TOML configuration field json.sort_keys TOML configuration field

L

languages TOML configuration field

load_extra_formatters() (Reformatter method) load_toml() (in module snippet_fmt.config)

M

MIT License, [1] module snippet_fmt snippet_fmt.config snippet_fmt.formatters

N

noformat() (in module snippet_fmt.formatters)

O

offset (namedtuple field) CodeBlockError (namedtuple in snippet_fmt)

P

prefix_char (DocstringReformatter attribute) process_match() (Reformatter method) PyReformatter (class in snippet_fmt) Python Enhancement Proposals PEP 517

python.config-file TOML configuration field python.reformat TOML configuration field

Q

quote_char (DocstringReformatter attribute)

R

reformat_docstrings() (in module snippet_fmt) reformat_file() (in module snippet_fmt) Reformatter (class in snippet_fmt) report_error() (DocstringReformatter method) (Reformatter method)

RSTReformatter (class in snippet_fmt) run() (DocstringReformatter method) (PyReformatter method) (Reformatter method)

S

snippet-fmt command line option --colour --config-file <config_file> --diff --exclude <PATTERN> --no-colour --traceback --verbose -c -e -T -v FILENAME

snippet_fmt module snippet_fmt.config module snippet_fmt.formatters module SnippetFmtConfigDict (typeddict in snippet_fmt.config)

T

to_file() (RSTReformatter method) to_string() (DocstringReformatter method) (Reformatter method) to_token() (DocstringReformatter method) token (DocstringReformatter attribute) TOML configuration field directives ini.reformat json.allow_nan json.ensure_ascii json.indent json.reformat json.separators json.sort_keys languages python.config-file python.reformat toml.reformat

toml.reformat TOML configuration field TOML: Array TOML: Boolean, [1], [2], [3], [4], [5], [6] TOML: Integer TOML: String TOML: string, [1]