[GitHub] [incubator-tvm] areusch commented on a change in pull request #6437: [RFC][Formatting] Add scripts for applying Black to the Python code.

[GitBox <gi...@apache.org>]

areusch commented on a change in pull request #6437:
URL: https://github.com/apache/incubator-tvm/pull/6437#discussion_r486617414



##########
File path: pyproject.toml
##########
@@ -0,0 +1,46 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+[tool.black]
+line-length = 100
+target-version = ['py36']
+include = '\.pyi?$'
+exclude = '''
+
+(
+  /(
+      \.github
+    | \.tvm
+    | \.tvm_test_data
+    | \.vscode
+    | \.venv
+    | cmake\/
+    | conda\/
+    | docker\/
+    | golang\/
+    | include\/
+    | jvm\/
+    | licenses\/
+    | nnvm\/
+    | rust\/
+    | src\/
+    | tests\/
+    | vta\/
+    | web\/
+  )/|tests/lint/add_asf_header.py|tests/lint/check_file_type.py|python/tvm/topi/testing/pool3d_python.py|python/topi/python/test_topi_pooling.py

Review comment:
       can you break these line by line and sort?

##########
File path: python/tvm/relay/frontend/mxnet_qnn_op_utils.py
##########
@@ -277,6 +277,8 @@ def quantize_conv_weights_bias_channel_mkldnn_from_var(weights_var,
 def get_mkldnn_requantize_scale_outDtype(min_output_range,
                                          max_output_range,
                                          out_dtype):
+    """Get the MKLDNN requantized scale."""
+    quantized_out_range = (

Review comment:
       what's up with this line?

##########
File path: tests/lint/git-black.sh
##########
@@ -0,0 +1,72 @@
+#!/bin/bash
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+set -e
+set -u
+set -o pipefail
+
+if [[ "$1" == "-i" ]]; then
+    INPLACE_FORMAT=1
+    shift 1
+else
+    INPLACE_FORMAT=0
+fi
+
+if [[ "$#" -lt 1 ]]; then
+    echo "Usage: tests/lint/git-black.sh [-i] <commit>"
+    echo ""
+    echo "Run black-format on files that changed since <commit>"
+    echo "Examples:"
+    echo "- Compare last one commit: tests/lint/git-black.sh HEAD~1"
+    echo "- Compare against upstream/master: tests/lint/git-black.sh upstream/master"
+    echo "You can also add -i option to do inplace format"

Review comment:
       right now `-i` does both inplace format and check, do we want that?

##########
File path: python/tvm/te/hybrid/calls.py
##########
@@ -27,7 +27,7 @@
 
 from .util import _internal_assert
 
-# pylint: disable=redefined-builtin
+# pylint: disable=redefined-builtin,invalid-name

Review comment:
       same question here--do we need to update pylint?

##########
File path: python/tvm/contrib/hexagon.py
##########
@@ -14,8 +14,8 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-
-'''Utility for Hexagon backend'''
+# pylint: disable=invalid-name

Review comment:
       how come we need this?

##########
File path: python/tvm/support.py
##########
@@ -27,6 +27,7 @@ def libinfo():
         The dictionary of compile-time info.
     """
     return {k: v for k, v in GetLibInfo().items()}  # pylint: disable=unnecessary-comprehension
+    }

Review comment:
       there are a lot of these extra closing braces or insertions that look like `function_call(` with no close `)` added. merge mistake? seems like nothing can possibly pass til they're deleted...

##########
File path: tests/lint/git-black.sh
##########
@@ -0,0 +1,72 @@
+#!/bin/bash
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+set -e
+set -u
+set -o pipefail
+
+if [[ "$1" == "-i" ]]; then
+    INPLACE_FORMAT=1
+    shift 1
+else
+    INPLACE_FORMAT=0
+fi
+
+if [[ "$#" -lt 1 ]]; then
+    echo "Usage: tests/lint/git-black.sh [-i] <commit>"
+    echo ""
+    echo "Run black-format on files that changed since <commit>"
+    echo "Examples:"
+    echo "- Compare last one commit: tests/lint/git-black.sh HEAD~1"
+    echo "- Compare against upstream/master: tests/lint/git-black.sh upstream/master"
+    echo "You can also add -i option to do inplace format"
+    exit 1
+fi
+
+cleanup()
+{
+  rm -rf /tmp/$$.black-format.txt
+}
+trap cleanup 0
+
+
+if [ -x "$(command -v black)" ]; then
+    BLACK=black
+else
+    echo "Cannot find black"
+    exit 1
+fi
+
+# Print out specific version
+
+echo "Version Information: $(${BLACK} --version)"
+
+
+IFS=$'\n' read -a FILES -d'\n' < <(git diff --name-only HEAD $1 -- "*.py" "*.pyi") || true
+echo "read returned $?"
+echo "Files: $FILES"
+
+if [[ ${INPLACE_FORMAT} -eq 1 ]]; then
+    echo "Running black on Python files against revision" $1):
+    CMD=( "black" "${FILES[@]}" )
+    echo "${CMD[@]}"
+    "${CMD[@]}"
+    exit 0
+fi
+
+echo "Running black in checking mode"
+black --diff --check

Review comment:
       I think you either want --diff and assert on an empty output or --check, I don't know what both do?




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org