[test] Add Black for linting backend code #4
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Summary: Black doesn’t have many configuration options. The default line length is 88, but we’ll use 80 for consistency with Google style. By default, Black attempts to automatically detect the Python version on a per-file basis; we explicitly specify that we require Python 2.7 compatibility to avoid any surprises. Test Plan: Running `black --check .` successfully runs Black (with lots of failures, of course). wchargin-branch: pyproject-toml
…tensorboard_plugin_example
Summary:
The Black binary only runs Python 3.6 and up, so we only lint in the
Python 3 CI build, but that’s perfectly fine. I’ve moved that build to
be first so that we can fail fast.
The preceding large sequence of change commits was generated with:
```
#!/bin/sh
set -eu
black .
docformatter -i -r .
black . # should be a no-op
export GIT_AUTHOR_NAME="TensorBoard Gardener"
export GIT_AUTHOR_EMAIL="tensorboard-gardener@google.com"
# Commit each directory in order of longest-named directory to
# shortest-named, to force a topological ordering. Collapse some select
# subtrees to reduce the number of commits.
git diff --numstat \
| awk '{ print $3 }' \
| rev \
| cut -d / -f 2- \
| rev \
| sed -e 's#/\(test\|demo\)$##' \
| sed -e 's#^\(tensorboard/compat\)/.*#\1#' \
| sed -e 's#^\(tensorboard/plugins/interactive_inference\)/.*#\1#' \
| sed -e 's#^\(tensorboard/summary\)/.*#\1#' \
| sort -u \
| awk '{ print length($0), $0 }' \
| sort -nrs \
| awk '{ print $2 }' \
| while read -r dir
do
git add "${dir}"
if git commit -m "black: reformat directory ${dir}" >/dev/null 2>&1; then
printf 'reformat %s: ' "${dir}"
git show --oneline --shortstat | tail -n 1
else
printf 'skip %s (covered by subtrees)\n' "${dir}"
fi
done
```
Test Plan:
Running `black --check .` currently passes, as all files have been fixed
up. It takes about 0.3 seconds on my machine.
wchargin-branch: ci-black
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Test PR for tensorflow#2967.