actions/black
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Document how to use format_str()

Browse Source 
Closes #1064
This commit is contained in:
Łukasz Langa 2020-03-04 23:08:57 +01:00
parent e253f1260d
commit 0626c89a5a
No known key found for this signature in database
GPG Key ID: B26995E310250568
1 changed files with 24 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
black.py
View File

@ -746,7 +746,30 @@ def format_str(src_contents: str, *, mode: FileMode) -> FileContent:
"""Reformat a string and return new contents. """Reformat a string and return new contents.
`mode` determines formatting options, such as how many characters per line are `mode` determines formatting options, such as how many characters per line are
allowed. allowed. Example:
>>> import black
>>> print(black.format_str("def f(arg:str='')->None:...", mode=FileMode()))
def f(arg: str = "") -> None:
...
A more complex example:
>>> print(
... black.format_str(
... "def f(arg:str='')->None: hey",
... mode=black.FileMode(
... target_versions={black.TargetVersion.PY36},
... line_length=10,
... string_normalization=False,
... is_pyi=False,
... ),
... ),
... )
def f(
arg: str = '',
) -> None:
hey
""" """
src_node = lib2to3_parse(src_contents.lstrip(), mode.target_versions) src_node = lib2to3_parse(src_contents.lstrip(), mode.target_versions)
dst_contents = [] dst_contents = []