Code format with flake8

Author: shenxianpeng

.flake8

@@ -0,0 +1,4 @@
+[flake8]
+exclude = .git,__pycache__,build,dist,*env
+max-complexity = 10
+max-line-length = 127

.github/workflows/python-test.yml

@@ -26,12 +26,8 @@ jobs:
         python -m pip install --upgrade pip
         pip install .
         pip install -r requirements-dev.txt
-  #  - name: Lint with flake8
-  #    run: |
-  #      # stop the build if there are Python syntax errors or undefined names
-  #      flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
-  #      # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
-  #      flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+    - name: Lint with flake8
+      run: flake8 .
     - name: Run tests and collect coverage
       run: pytest --cov .
     - name: Upload coverage reports to Codecov

CONTRIBUTING.md

@@ -17,18 +17,25 @@ When you're finished with the changes, create a pull request, also known as a PR
 Install `clang-tools` from source code
 
 ```bash
-git clone git@github.com:shenxianpeng/clang-tools-pip.git
+$ git clone git@github.com:shenxianpeng/clang-tools-pip.git
 # Need root permission
-sudo python3 setup.py install
+$ sudo python3 setup.py install
 # Install clang-tools version 13
-sudo python3 main.py --install true --version 13
+$ sudo python3 main.py --install true --version 13
 ```
 
 ### Test
 
 ```bash
 # run test
-pytest
+$ pytest
 # run test with code covarege
-coverage run -m pytest
+$ coverage run -m pytest
+```
+
+## Code format
+
+```bash
+# check code format with flake8
+$ flake8 .
 ```

clang_tools/install.py

@@ -6,6 +6,7 @@
 from clang_tools.util import check_install_os
 from clang_tools.util import download_file
 
+
 def clang_format_exist(version) -> bool:
     if version:
         command = [f'clang-format-{version}', '--version']
@@ -18,6 +19,7 @@ def clang_format_exist(version) -> bool:
         exist = False
     return exist
 
+
 def clang_tidy_exist(version) -> bool:
     if version:
         command = [f'clang-tidy-{version}', '--version']
@@ -30,9 +32,12 @@ def clang_tidy_exist(version) -> bool:
         exist = False
     return exist
 
+
 def clang_tools_binary_url(tool, version) -> string:
     install_os = check_install_os()
-    return f"https://github.com/muttleyxd/clang-tools-static-binaries/releases/download/master-208096c1/{tool}-{version}_{install_os}-amd64"
+    return f"https://github.com/muttleyxd/clang-tools-static-binaries/ \
+    releases/download/master-208096c1/{tool}-{version}_{install_os}-amd64"
+
 
 def install_clang_format(version) -> None:
     if clang_format_exist(version):
@@ -42,6 +47,7 @@ def install_clang_format(version) -> None:
     download_file(clang_format_binary_url, clang_format_binary)
     install_clang_binary(clang_format_binary, f"clang-format-{version}")
 
+
 def install_clang_tidy(version) -> None:
     if clang_tidy_exist(version):
         return
@@ -50,6 +56,7 @@ def install_clang_tidy(version) -> None:
     download_file(clang_tidy_binary_url, clang_tidy_binary)
     install_clang_binary(clang_tidy_binary, f"clang-tidy-{version}")
 
+
 def install_clang_binary(old_file_name, new_file_name) -> None:
     """Move download clang-tools binary and move to bin dir with right permission."""
     install_os = check_install_os()
@@ -61,7 +68,8 @@ def install_clang_binary(old_file_name, new_file_name) -> None:
         raise Exception(f"Not support {install_os}")
     shutil.move(old_file_name, f"{clang_tools_dir}/{new_file_name}")
     os.chmod(os.path.join(clang_tools_dir, new_file_name), 0o777)
-    
+
+
 def install_clang_tools(version) -> None:
     install_clang_format(version)
     install_clang_tidy(version)

clang_tools/main.py

@@ -1,31 +1,22 @@
 import argparse
 from clang_tools.install import install_clang_tools
 
+
 def main() -> int:
     parser = argparse.ArgumentParser(prog='clang-tools')
-    # parser.add_argument(
-    #     "-b",
-    #     "--build",
-    #     default="false",
-    #     help="Build clang-tools.",
-    # )
+
     parser.add_argument(
         "-i",
         "--install",
         default="12",
         help="Install clang-tools with specific version. default is 12.",
     )
-    # parser.add_argument(
-    #     "-v",
-    #     "--version", 
-    #     default="12",
-    #     help="The version of clang-tools. default is 12.",
-    # )
+
     # parser.add_argument(
     #     "-d",
-    #     "--directory", 
+    #     "--directory",
     #     default="/usr/bin/",
-    #     help="The directory where is the clang-tools install.", 
+    #     help="The directory where is the clang-tools install.",
     # )
     args = parser.parse_args()
 
@@ -35,8 +26,6 @@ def main() -> int:
     if install_version:
         install_clang_tools(install_version)
 
-    # if build:
-        # TODO
 
 if __name__ == '__main__':
     raise SystemExit(main())

clang_tools/util.py

@@ -8,23 +8,26 @@ def check_install_os() -> string:
     os = platform.system().lower()
     return os
 
+
 def download_file(url, file_name) -> None:
     urllib.request.urlretrieve(url, file_name)
 
+
 def unpack_file(file_name) -> int:
     command = ["tar", "-xvf", file_name]
     result = subprocess.run(command, stdout=subprocess.PIPE)
     return result.returncode
 
+
 def cmake_and_build():
     command = [
-        "cmake", 
-        "-S" "llvm-project-12.0.1.src/llvm", 
-        "-B", "llvm-project-12.0.1.src/build", 
-        "-DBUILD_SHARED_LIBS=OFF", 
-        "-DLLVM_ENABLE_PROJECTS=\"clang;clang-tools-extra\"", 
-        "-DLLVM_BUILD_STATIC=ON", 
-        "-DCMAKE_CXX_FLAGS=\"-s -flto\"", 
+        "cmake",
+        "-S" "llvm-project-12.0.1.src/llvm",
+        "-B", "llvm-project-12.0.1.src/build",
+        "-DBUILD_SHARED_LIBS=OFF",
+        "-DLLVM_ENABLE_PROJECTS=\"clang;clang-tools-extra\"",
+        "-DLLVM_BUILD_STATIC=ON",
+        "-DCMAKE_CXX_FLAGS=\"-s -flto\"",
         "-DCMAKE_BUILD_TYPE=MinSizeRel",
         "-DCMAKE_CXX_COMPILER=g++-10",
         "-DCMAKE_C_COMPILER=gcc-10",

requirements-dev.txt

@@ -1,3 +1,4 @@
 pytest
 pytest-cov
-coverage
+coverage
+flake8

setup.py

@@ -5,15 +5,15 @@
 
 setup(
     name="clang_tools",
-    version = "0.0.1",
+    version="0.0.1",
     description="Install clang-tools (clang-format, clang-tidy) with pip",
     long_description=long_description,
     long_description_content_type="text/markdown",
     author="Peter Shen",
     author_email="xianpeng.shen@gmail.com",
     keywords=["clang", "clang-tools", "clang-extra", "clang-tidy", "clang-format"],
     license="MIT License",
-    packages = find_packages(),
+    packages=find_packages(),
     project_urls={
         "Source": "https://github.com/shenxianpeng/clang-tools-pip",
         "Tracker": "https://github.com/shenxianpeng/clang-tools-pip/issues"
@@ -34,4 +34,4 @@
             "clang-tools=clang_tools.main:main"
         ]
     },
-)
+)

tests/test_util.py

@@ -4,10 +4,12 @@
 
 TEST_REPO = "https://github.com/cpp-linter/cpp-linter-action"
 
+
 def test_check_install_os():
     install_os = check_install_os()
     assert install_os in ("linux", "windos", "macosx")
 
+
 def test_download_file():
     url = f"{TEST_REPO}/blob/master/README.md"
     file_name = "test_file"
@@ -16,6 +18,7 @@ def test_download_file():
     os.remove(file_name)
     assert not os.path.exists(file_name)
 
+
 def test_unpack_file():
     url = f"{TEST_REPO}/archive/refs/tags/v1.4.4.tar.gz"
     file_name = "test_file.tar.gz"