Skip to content

Commit

Permalink
Add docstrings to fmt checking functions, add to docs
Browse files Browse the repository at this point in the history
Follow up from #1325

Adds docstrings to the fmt checking functions.
Renames fmt_on to is_fmt_on.
Adds the functions to the autodocs.
  • Loading branch information
autophagy committed May 8, 2020
1 parent 1382eab commit a94c663
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 7 deletions.
19 changes: 12 additions & 7 deletions black.py
Expand Up @@ -5156,7 +5156,7 @@ def generate_ignored_nodes(leaf: Leaf) -> Iterator[LN]:
"""
container: Optional[LN] = container_of(leaf)
while container is not None and container.type != token.ENDMARKER:
if fmt_on(container):
if is_fmt_on(container):
return

# fix for fmt: on in children
Expand All @@ -5170,31 +5170,36 @@ def generate_ignored_nodes(leaf: Leaf) -> Iterator[LN]:
container = container.next_sibling


def fmt_on(container: LN) -> bool:
is_fmt_on = False
def is_fmt_on(container: LN) -> bool:
"""Determine whether formatting is switched on within a container.
Determined by whether the last `# fmt:` comment is `on` or `off`.
"""
fmt_on = False
for comment in list_comments(container.prefix, is_endmarker=False):
if comment.value in FMT_ON:
is_fmt_on = True
fmt_on = True
elif comment.value in FMT_OFF:
is_fmt_on = False
return is_fmt_on
fmt_on = False
return fmt_on


def contains_fmt_on_at_column(container: LN, column: int) -> bool:
"""Determine if children at a given column have formatting switched on."""
for child in container.children:
if (
isinstance(child, Node)
and first_leaf_column(child) == column
or isinstance(child, Leaf)
and child.column == column
):
if fmt_on(child):
if is_fmt_on(child):
return True

return False


def first_leaf_column(node: Node) -> Optional[int]:
"""Returns the column of the first leaf child of a node."""
for child in node.children:
if isinstance(child, Leaf):
return child.column
Expand Down
6 changes: 6 additions & 0 deletions docs/reference/reference_functions.rst
Expand Up @@ -135,6 +135,12 @@ Utilities

.. autofunction:: black.generate_ignored_nodes

.. autofunction:: black.is_fmt_on

.. autofunction:: black.contains_fmt_on_at_column

.. autofunction:: black.first_leaf_column

.. autofunction:: black.generate_trailers_to_omit

.. autofunction:: black.get_future_imports
Expand Down

0 comments on commit a94c663

Please sign in to comment.