reference_functions.rst

Black functions

Contents are subject to change.

black

Assertions and checks

black.assert_equivalent

black.assert_stable

black.lines.can_be_split

black.lines.can_omit_invisible_parens

black.nodes.is_empty_tuple

black.nodes.is_import

black.lines.is_line_short_enough

black.nodes.is_multiline_string

black.nodes.is_one_tuple

black.brackets.is_split_after_delimiter

black.brackets.is_split_before_delimiter

black.nodes.is_stub_body

black.nodes.is_stub_suite

black.nodes.is_vararg

black.nodes.is_yield

Formatting

black.format_file_contents

black.format_file_in_place

black.format_stdin_to_stdout

black.format_str

black.reformat_one

black.schedule_formatting

File operations

black.dump_to_file

black.find_project_root

black.gen_python_files

black.read_pyproject_toml

Parsing

black.decode_bytes

black.parsing.lib2to3_parse

black.parsing.lib2to3_unparse

Split functions

black.linegen.bracket_split_build_line

black.linegen.bracket_split_succeeded_or_raise

black.linegen.delimiter_split

black.linegen.left_hand_split

black.linegen.right_hand_split

black.linegen.standalone_comment_split

black.linegen.transform_line

Caching

black.cache.filter_cached

black.cache.get_cache_dir

black.cache.get_cache_file

black.cache.get_cache_info

black.cache.read_cache

black.cache.write_cache

Utilities

black.concurrency.cancel

black.nodes.child_towards

black.nodes.container_of

black.comments.convert_one_fmt_off_pair

black.diff

black.linegen.dont_increase_indentation

black.numerics.format_float_or_int_string

black.nodes.ensure_visible

black.lines.enumerate_reversed

black.comments.generate_comments

black.comments.generate_ignored_nodes

black.comments.is_fmt_on

black.comments.contains_fmt_on_at_column

black.nodes.first_leaf_column

black.linegen.generate_trailers_to_omit

black.get_future_imports

black.comments.list_comments

black.comments.make_comment

black.linegen.maybe_make_parens_invisible_in_atom

black.brackets.max_delimiter_priority_in_atom

black.normalize_fmt_off

black.numerics.normalize_numeric_literal

black.linegen.normalize_prefix

black.strings.normalize_string_prefix

black.strings.normalize_string_quotes

black.linegen.normalize_invisible_parens

black.patch_click

black.nodes.preceding_leaf

black.re_compile_maybe_verbose

black.linegen.should_split_line

black.shutdown

black.strings.sub_twice

black.nodes.whitespace