Merge pull request #255 from plugwise/pre-commit

Install pre-commit.ci

Author: bouwew

.flake8

@@ -1,5 +1,21 @@
 [flake8]
-ignore = E203, E231, E266, E501, W503, F403, F401, W503
+exclude = 
+    .venv,
+    .git,
+    .tox,
+    docs,
+    venv,
+    bin,
+    lib,
+    deps,
+    build,
+    plugwise/connections/*.py,
+    plugwise/messages/*.py,
+    plugwise/nodes/*.py,
+    plugwise/controller.py,
+    plugwise/parser.py,
+    plugwise/stick.py,
+    plugwise/util.py
+ignore = E203,E231,E266,E501,W503,F403,F401,W503
 max-line-length = 89
 max-complexity = 20
-select = B,C,E,F,W,T4,B9

.github/ISSUE_TEMPLATE/bug.yml

@@ -131,7 +131,6 @@ body:
 
   - type: textarea
     attributes:
-      label: Generic or other logging (provide tools and version used)
       label: Diagnostics information
       description: >-
         Provide your version of python used and/or include any and all informational, error and debug messages.

.github/workflows/codeql-analysis.yml

@@ -13,13 +13,13 @@
 name: "CodeQL"
 
 on:
-#  push:
-#    branches: [ main ]
-#  pull_request:
-#    # The branches below must be a subset of the branches above
-#    branches: [ main ]
+  #  push:
+  #    branches: [ main ]
+  #  pull_request:
+  #    # The branches below must be a subset of the branches above
+  #    branches: [ main ]
   schedule:
-    - cron: '24 14 * * 5'
+    - cron: "24 14 * * 5"
 
 jobs:
   analyze:
@@ -29,41 +29,40 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        language: [ 'python' ]
+        language: ["python"]
         # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
         # Learn more...
         # https://docs.github.com/en/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#overriding-automatic-language-detection
 
     steps:
-    - name: Checkout repository
-      uses: actions/checkout@v3
+      - name: Checkout repository
+        uses: actions/checkout@v3
 
-    # Initializes the CodeQL tools for scanning.
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@v2
-      with:
-        languages: ${{ matrix.language }}
-        # If you wish to specify custom queries, you can do so here or in a config file.
-        # By default, queries listed here will override any specified in a config file.
-        # Prefix the list here with "+" to use these queries and those in the config file.
-        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v2
+        with:
+          languages: ${{ matrix.language }}
+          # If you wish to specify custom queries, you can do so here or in a config file.
+          # By default, queries listed here will override any specified in a config file.
+          # Prefix the list here with "+" to use these queries and those in the config file.
+          # queries: ./path/to/local/query, your-org/your-repo/queries@main
 
-    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
-    # If this step fails, then you should remove it and run the build manually (see below)
-    - name: Autobuild
-      uses: github/codeql-action/autobuild@v2
+      # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+      # If this step fails, then you should remove it and run the build manually (see below)
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v2
 
-    # ℹ️ Command-line programs to run using the OS shell.
-    # 📚 https://git.io/JvXDl
+      # ℹ️ Command-line programs to run using the OS shell.
+      # 📚 https://git.io/JvXDl
 
-    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
-    #    and modify them (or add more) to build your code if your project
-    #    uses a compiled language
+      # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+      #    and modify them (or add more) to build your code if your project
+      #    uses a compiled language
 
-    #- run: |
-    #   make bootstrap
-    #   make release
-
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v2
+      #- run: |
+      #   make bootstrap
+      #   make release
 
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v2

.github/workflows/verify.yml

@@ -152,14 +152,7 @@ jobs:
       - name: Verify commit
         run: |
           . venv/bin/activate
-          pre-commit run --show-diff-on-failure --color=always --all-files --hook-stage manual bandit
-          pre-commit run --show-diff-on-failure --color=always --all-files --hook-stage manual black
-          pre-commit run --show-diff-on-failure --color=always --all-files --hook-stage manual codespell
-          pre-commit run --show-diff-on-failure --color=always --all-files --hook-stage manual flake8
-          #pre-commit run --show-diff-on-failure --color=always --all-files --hook-stage manual isort
-          pre-commit run --show-diff-on-failure --color=always --all-files --hook-stage manual mypy
-          pre-commit run --show-diff-on-failure --color=always --all-files --hook-stage manual userdata
-          pre-commit run --show-diff-on-failure --color=always --all-files --hook-stage manual yamllint
+          pre-commit run --show-diff-on-failure --color=always --all-files --hook-stage manual pylint
 
   prepare-test-cache:
     runs-on: ubuntu-latest

.pre-commit-config.yaml

@@ -1,6 +1,11 @@
+ci:
+  skip: [pylint]
+  submodules: true
+
 default_language_version:
   # force all unspecified python hooks to run python3
-  python: python3.9
+  python: python3.10
+
 repos:
   # Run manually in CI skipping the branch checks
   - repo: https://github.com/PyCQA/isort

README.md

@@ -10,6 +10,7 @@ Our main usage for this module is supporting [Home Assistant](https://www.home-a
 [![codecov](https://codecov.io/gh/plugwise/python-plugwise/branch/main/graph/badge.svg)](https://codecov.io/gh/plugwise/python-plugwise)
 [![PyPI version fury.io](https://badge.fury.io/py/plugwise.svg)](https://pypi.python.org/pypi/plugwise/)
 [![Newest commit](https://github.com/plugwise/python-plugwise/workflows/Latest%20commit/badge.svg)](https://github.com/plugwise/python-plugwise/actions)
+[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/plugwise/python-plugwise/main.svg)](https://results.pre-commit.ci/latest/github/plugwise/python-plugwise/main)
 
 ## Integration
 

setup.cfg

@@ -13,22 +13,6 @@ classifier =
     Programming Language :: Python :: 3.9
     Topic :: Home Automation
 
-[flake8]
-exclude = .venv,.git,.tox,docs,venv,bin,lib,deps,build
-doctests = True
-# To work with Black
-# E501: line too long
-# W503: Line break occurred before a binary operator
-# E203: Whitespace before ':'
-# D202 No blank lines allowed after function docstring
-# W504 line break after binary operator
-ignore =
-    E501,
-    W503,
-    E203,
-    D202,
-    W504
-
 [mypy]
 python_version = 3.9
 show_error_codes = true

tests/test_smile.py

@@ -308,7 +308,6 @@ async def connect_wrapper(
         self, raise_timeout=False, fail_auth=False, stretch=False
     ):
         """Wrap connect to try negative testing before positive testing."""
-
         if fail_auth:
             try:
                 _LOGGER.warning("Connecting to device with invalid credentials:")
@@ -5220,7 +5219,6 @@ async def test_fail_anna_connected_to_adam(self):
     @pytest.mark.asyncio
     async def test_invalid_credentials(self):
         """Test P1 with invalid credentials setup."""
-
         self.smile_setup = "p1v4"
         try:
             await self.connect_wrapper(fail_auth=True)
@@ -5232,7 +5230,6 @@ async def test_invalid_credentials(self):
     @pytest.mark.asyncio
     async def test_connect_fail_firmware(self):
         """Test a P1 non existing firmware setup."""
-
         self.smile_setup = "fail_firmware"
         try:
             await self.connect_wrapper()
@@ -5245,7 +5242,6 @@ async def test_connect_fail_firmware(self):
     @pytest.mark.asyncio
     async def test_connect_timeout(self, timeout_test):
         """Wrap connect to raise timeout during get."""
-
         # pylint: disable=unused-variable
         try:
             self.smile_setup = "p1v4"