]> git.madduck.net Git - etc/vim.git/blob - docs/reference/reference_functions.rst

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

40d9665138cd6de9919ee2814d8571c4e2df8a1a
[etc/vim.git] / docs / reference / reference_functions.rst
1 *Black* functions
2 =================
3
4 *Contents are subject to change.*
5
6 .. currentmodule:: black
7
8 Assertions and checks
9 ---------------------
10
11 .. autofunction:: black.assert_equivalent
12
13 .. autofunction:: black.assert_stable
14
15 .. autofunction:: black.is_split_after_delimiter
16
17 .. autofunction:: black.is_split_before_delimiter
18
19 .. autofunction:: black.is_empty_tuple
20
21 .. autofunction:: black.is_import
22
23 .. autofunction:: black.is_one_tuple
24
25 .. autofunction:: black.is_python36
26
27 .. autofunction:: black.is_vararg
28
29 Formatting
30 ----------
31
32 .. autofunction:: black.format_file_contents
33
34 .. autofunction:: black.format_file_in_place
35
36 .. autofunction:: black.format_stdin_to_stdout
37
38 .. autofunction:: black.format_str
39
40 .. autofunction:: black.reformat_one
41
42 .. autofunction:: black.schedule_formatting
43
44 File operations
45 ---------------
46
47 .. autofunction:: black.dump_to_file
48
49 .. autofunction:: black.gen_python_files_in_dir
50
51 Parsing
52 -------
53
54 .. autofunction:: black.lib2to3_parse
55
56 .. autofunction:: black.lib2to3_unparse
57
58 Split functions
59 ---------------
60
61 .. autofunction:: black.delimiter_split
62
63 .. autofunction:: black.left_hand_split
64
65 .. autofunction:: black.right_hand_split
66
67 .. autofunction:: black.standalone_comment_split
68
69 .. autofunction:: black.split_line
70
71 .. autofunction:: black.bracket_split_succeeded_or_raise
72
73 Caching
74 -------
75
76 .. autofunction:: black.filter_cached
77
78 .. autofunction:: black.get_cache_info
79
80 .. autofunction:: black.read_cache
81
82 .. autofunction:: black.write_cache
83
84 Utilities
85 ---------
86
87 .. py:function:: black.DebugVisitor.show(code: str) -> None
88
89     Pretty-print the lib2to3 AST of a given string of `code`.
90
91 .. autofunction:: black.diff
92
93 .. autofunction:: black.ensure_visible
94
95 .. autofunction:: black.generate_comments
96
97 .. autofunction:: black.make_comment
98
99 .. autofunction:: black.max_delimiter_priority_in_atom
100
101 .. autofunction:: black.normalize_prefix
102
103 .. autofunction:: black.normalize_string_quotes
104
105 .. autofunction:: black.normalize_invisible_parens
106
107 .. autofunction:: black.preceding_leaf
108
109 .. autofunction:: black.sub_twice
110
111 .. autofunction:: black.whitespace