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

Ignore symbolic links pointing outside of the root directory (#339)
[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_omit_invisible_parens
16
17 .. autofunction:: black.is_empty_tuple
18
19 .. autofunction:: black.is_import
20
21 .. autofunction:: black.is_line_short_enough
22
23 .. autofunction:: black.is_multiline_string
24
25 .. autofunction:: black.is_one_tuple
26
27 .. autofunction:: black.is_python36
28
29 .. autofunction:: black.is_split_after_delimiter
30
31 .. autofunction:: black.is_split_before_delimiter
32
33 .. autofunction:: black.is_stub_body
34
35 .. autofunction:: black.is_stub_suite
36
37 .. autofunction:: black.is_vararg
38
39 .. autofunction:: black.is_yield
40
41
42 Formatting
43 ----------
44
45 .. autofunction:: black.format_file_contents
46
47 .. autofunction:: black.format_file_in_place
48
49 .. autofunction:: black.format_stdin_to_stdout
50
51 .. autofunction:: black.format_str
52
53 .. autofunction:: black.reformat_one
54
55 .. autofunction:: black.schedule_formatting
56
57 File operations
58 ---------------
59
60 .. autofunction:: black.dump_to_file
61
62 .. autofunction:: black.gen_python_files_in_dir
63
64 Parsing
65 -------
66
67 .. autofunction:: black.decode_bytes
68
69 .. autofunction:: black.lib2to3_parse
70
71 .. autofunction:: black.lib2to3_unparse
72
73 Split functions
74 ---------------
75
76 .. autofunction:: black.delimiter_split
77
78 .. autofunction:: black.left_hand_split
79
80 .. autofunction:: black.right_hand_split
81
82 .. autofunction:: black.standalone_comment_split
83
84 .. autofunction:: black.split_line
85
86 .. autofunction:: black.bracket_split_succeeded_or_raise
87
88 Caching
89 -------
90
91 .. autofunction:: black.filter_cached
92
93 .. autofunction:: black.get_cache_info
94
95 .. autofunction:: black.read_cache
96
97 .. autofunction:: black.write_cache
98
99 Utilities
100 ---------
101
102 .. py:function:: black.DebugVisitor.show(code: str) -> None
103
104     Pretty-print the lib2to3 AST of a given string of `code`.
105
106 .. autofunction:: black.diff
107
108 .. autofunction:: black.ensure_visible
109
110 .. autofunction:: black.enumerate_reversed
111
112 .. autofunction:: black.enumerate_with_length
113
114 .. autofunction:: black.generate_comments
115
116 .. autofunction:: black.make_comment
117
118 .. autofunction:: black.maybe_make_parens_invisible_in_atom
119
120 .. autofunction:: black.max_delimiter_priority_in_atom
121
122 .. autofunction:: black.normalize_prefix
123
124 .. autofunction:: black.normalize_string_quotes
125
126 .. autofunction:: black.normalize_invisible_parens
127
128 .. autofunction:: black.preceding_leaf
129
130 .. autofunction:: black.sub_twice
131
132 .. autofunction:: black.whitespace