add lint to oss (pytorch#1427)

Summary:
Pull Request resolved: pytorch#1427

Pull Request resolved: pytorch#1417

Enforce format check to fbgemm OSS.

Leave this to Airidas Korolkovas as the starter rampup task.

Differential Revision: https://internalfb.com/D40620055

fbshipit-source-id: 4bb8519abc1f6ee8445ff4c22cb6589e34a84080

.github/workflows/pylint.yaml

@@ -0,0 +1,42 @@
+name: Lint
+
+on:
+  push:
+    branches:
+      - main
+
+  pull_request:
+    branches:
+      - main
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.8"]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install ufmt
+        pip install click
+        pip install flake8
+    - name: Analyzing the code with flake8
+      run: |
+        echo "::add-matcher::fbgemm_gpu/test/lint/flake8_problem_matcher.json"
+        flake8 --ignore=E501 .  # Ignore line too long issue
+    - name: Analyzing the code with ufmt
+      run: |
+        ufmt diff fbgemm_gpu/fbgemm_gpu
+        ufmt diff fbgemm_gpu/test
+        ufmt diff fbgemm_gpu/bench
+    - name: Check Meta copyright header
+      run: |
+        python fbgemm_gpu/test/lint/check_meta_header.py --path=./fbgemm_gpu/fbgemm_gpu --fixit=False
+        python fbgemm_gpu/test/lint/check_meta_header.py --path=./fbgemm_gpu/test --fixit=False
+        python fbgemm_gpu/test/lint/check_meta_header.py --path=./fbgemm_gpu/bench --fixit=False

fbgemm_gpu/fbgemm_gpu/docs/__init__.py

@@ -0,0 +1,6 @@
+#!/usr/bin/env python3
+
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+# All rights reserved.
+# This source code is licensed under the BSD-style license found in the
+# LICENSE file in the root directory of this source tree.

fbgemm_gpu/test/lint/check_meta_header.py

@@ -0,0 +1,111 @@
+#!/usr/bin/env python3
+
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+# All rights reserved.
+# This source code is licensed under the BSD-style license found in the
+# LICENSE file in the root directory of this source tree.
+
+# pyre-unsafe
+
+"""Check Python source code contains Meta copyright header
+"""
+
+from __future__ import annotations
+
+import os
+import sys
+
+import click
+
+
+def process_header(header, comment):
+    lines = header.split("\n")
+    new_lines = []
+    for line in lines:
+        if line is None or line == "":
+            new_lines.append(comment)
+        else:
+            new_lines.append(comment + " " + line)
+    return "\n".join(new_lines) + "\n"
+
+
+HEADER = """Copyright (c) Meta Platforms, Inc. and affiliates.
+All rights reserved.
+This source code is licensed under the BSD-style license found in the
+LICENSE file in the root directory of this source tree.
+"""
+HEADER_lines = HEADER.splitlines()[1:]
+PY_HEADER = process_header(HEADER, "#")
+CPP_HEADER = process_header(HEADER, "//")
+
+
+def dfs(root_path: str) -> list[str]:
+    """DFS source code tree to find python files missing header
+
+    Parameters
+    ----------
+    root_path : str
+        root source directory path
+
+    Returns
+    -------
+    list[str]
+        file list missing header
+    """
+    ret = []
+    for root, _, files in os.walk(root_path, topdown=False):
+        for name in files:
+            path = os.path.join(root, name)
+            if path.endswith(".py"):
+                with open(path) as fi:
+                    src = fi.read()
+                    flag = True
+                    for line in HEADER_lines:
+                        if line not in src:
+                            flag = False
+                            break
+                    if not flag:
+                        ret.append(path)
+    return ret
+
+
+def fix_header(file_list: list[str]) -> None:
+    """Adding Meta header to to source files
+
+    Parameters
+    ----------
+    file_list : list[str]
+        file list missing header
+    """
+    for path in file_list:
+        src = ""
+        with open(path) as fi:
+            src = fi.read()
+        with open(path, "w") as fo:
+            fo.write(PY_HEADER)
+            fo.write(src)
+
+
+@click.command()
+@click.option(
+    "--path", help="Root directory of source to be checked", required=True, type=str
+)
+@click.option(
+    "--fixit", default=False, help="Fix missing header", required=False, type=bool
+)
+def check_header(path, fixit):
+    ret = dfs(path)
+    if len(ret) == 0:
+        sys.exit(0)
+    print("Need to add Meta header to the following files.")
+    print("----------------File List----------------")
+    for line in ret:
+        print(line)
+    print("-----------------------------------------")
+    if fixit:
+        fix_header(ret)
+    sys.exit(1)
+
+
+if __name__ == "__main__":
+    check_header()

fbgemm_gpu/test/lint/flake8_problem_matcher.json

@@ -0,0 +1,17 @@
+{
+  "problemMatcher": [
+    {
+      "owner": "flake8",
+      "severity": "error",
+      "pattern": [
+        {
+          "regexp": "^([^:]+):(\\d+):(\\d+):\\s+(.*)$",
+          "file": 1,
+          "line": 2,
+          "column": 3,
+          "message": 4
+        }
+      ]
+    }
+  ]
+}