]> 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:

ccea313be20cdee83546b85316b768f8d1af92b1
[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.can_be_split
16
17 .. autofunction:: black.can_omit_invisible_parens
18
19 .. autofunction:: black.is_empty_tuple
20
21 .. autofunction:: black.is_import
22
23 .. autofunction:: black.is_line_short_enough
24
25 .. autofunction:: black.is_multiline_string
26
27 .. autofunction:: black.is_one_tuple
28
29 .. autofunction:: black.is_python36
30
31 .. autofunction:: black.is_split_after_delimiter
32
33 .. autofunction:: black.is_split_before_delimiter
34
35 .. autofunction:: black.is_stub_body
36
37 .. autofunction:: black.is_stub_suite
38
39 .. autofunction:: black.is_vararg
40
41 .. autofunction:: black.is_yield
42
43
44 Formatting
45 ----------
46
47 .. autofunction:: black.format_file_contents
48
49 .. autofunction:: black.format_file_in_place
50
51 .. autofunction:: black.format_stdin_to_stdout
52
53 .. autofunction:: black.format_str
54
55 .. autofunction:: black.reformat_one
56
57 .. autofunction:: black.schedule_formatting
58
59 File operations
60 ---------------
61
62 .. autofunction:: black.dump_to_file
63
64 .. autofunction:: black.find_project_root
65
66 .. autofunction:: black.gen_python_files_in_dir
67
68 .. autofunction:: black.read_pyproject_toml
69
70 Parsing
71 -------
72
73 .. autofunction:: black.decode_bytes
74
75 .. autofunction:: black.lib2to3_parse
76
77 .. autofunction:: black.lib2to3_unparse
78
79 Split functions
80 ---------------
81
82 .. autofunction:: black.bracket_split_succeeded_or_raise
83
84 .. autofunction:: black.delimiter_split
85
86 .. autofunction:: black.left_hand_split
87
88 .. autofunction:: black.right_hand_split
89
90 .. autofunction:: black.standalone_comment_split
91
92 .. autofunction:: black.split_line
93
94 Caching
95 -------
96
97 .. autofunction:: black.filter_cached
98
99 .. autofunction:: black.get_cache_file
100
101 .. autofunction:: black.get_cache_info
102
103 .. autofunction:: black.read_cache
104
105 .. autofunction:: black.write_cache
106
107 Utilities
108 ---------
109
110 .. py:function:: black.DebugVisitor.show(code: str) -> None
111
112     Pretty-print the lib2to3 AST of a given string of `code`.
113
114 .. autofunction:: black.cancel
115
116 .. autofunction:: black.child_towards
117
118 .. autofunction:: black.container_of
119
120 .. autofunction:: black.convert_one_fmt_off_pair
121
122 .. autofunction:: black.diff
123
124 .. autofunction:: black.dont_increase_indentation
125
126 .. autofunction:: black.format_float_or_int_string
127
128 .. autofunction:: black.format_int_string
129
130 .. autofunction:: black.ensure_visible
131
132 .. autofunction:: black.enumerate_reversed
133
134 .. autofunction:: black.enumerate_with_length
135
136 .. autofunction:: black.generate_comments
137
138 .. autofunction:: black.generate_ignored_nodes
139
140 .. autofunction:: black.generate_trailers_to_omit
141
142 .. autofunction:: black.get_future_imports
143
144 .. autofunction:: black.list_comments
145
146 .. autofunction:: black.make_comment
147
148 .. autofunction:: black.maybe_make_parens_invisible_in_atom
149
150 .. autofunction:: black.max_delimiter_priority_in_atom
151
152 .. autofunction:: black.normalize_fmt_off
153
154 .. autofunction:: black.normalize_numeric_literal
155
156 .. autofunction:: black.normalize_prefix
157
158 .. autofunction:: black.normalize_string_prefix
159
160 .. autofunction:: black.normalize_string_quotes
161
162 .. autofunction:: black.normalize_invisible_parens
163
164 .. autofunction:: black.patch_click
165
166 .. autofunction:: black.preceding_leaf
167
168 .. autofunction:: black.re_compile_maybe_verbose
169
170 .. autofunction:: black.should_explode
171
172 .. autofunction:: black.shutdown
173
174 .. autofunction:: black.sub_twice
175
176 .. autofunction:: black.whitespace