Merge pull request #1 from SAP/refactor

Refactor whole project

Author: kasium

.flake8

@@ -0,0 +1,22 @@
+[flake8]
+max-line-length = 100
+enable-extensions = FT
+select =
+    C901,  # flake8-mccabe
+    E,  # flake8-pycodestyle
+    F,  # flake8-pyflakes
+    W,  # flake8-pycodestyle
+    FT,  # flake8-tergeo
+ignore=
+    # conflict with black formatter
+    W503,E203,
+    # ignore !r recommendation
+    FTB907,
+    # some things don't need a docstring
+    FTP306,FTP304,FTP305
+per-file-ignores =
+    test/*:FTP3
+ftp-python-version = 3.9.0
+ftp-auto-manage-options = true
+ftp-pytest-parametrize-names-type = csv
+ftp-docstyle-lowercase-words = pylint-per-file-ignores

.github/workflows/main.yml

@@ -0,0 +1,50 @@
+name: CI
+
+permissions:
+  contents: read
+  actions: read
+  id-token: write
+  pull-requests: write
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  ci-pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13.0"
+      - name: Install project
+        run: pip install --group dev --group test -e .
+      - name: run pre-commit
+        run: "pre-commit run --all"
+  ci-test:
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13", "3.14.0-beta.2"]
+        pylint-version: ["3.3.*", "3.*"]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install project
+        run: pip install --group test -e .
+      - name: "Install pylint"
+        run: "pip install -U pylint==${{ matrix.pylint-version }}"
+      - name: run tests (with coverage)
+        run: "pytest --cov --cov-report xml --cov-config pyproject.toml test/"
+      - name: run diff-cover
+        run: "diff-cover --config-file pyproject.toml coverage.xml"

.pre-commit-config.yaml

@@ -0,0 +1,51 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+  - repo: https://github.com/fsfe/reuse-tool
+    rev: v4.0.3
+    hooks:
+      - id: reuse
+  - repo: local
+    hooks:
+      - id: black
+        name: black
+        entry: black
+        language: system
+        types: [python]
+      - id: isort
+        name: isort
+        entry: isort
+        language: system
+        types: [python]
+      - id: mypy
+        name: mypy
+        entry: mypy
+        language: system
+        types: [python]
+        require_serial: true
+      - id: pylint
+        name: pylint
+        entry: pylint
+        language: system
+        types: [python]
+      - id: flake8
+        name: flake8
+        entry: flake8
+        language: system
+        types: [python]
+        require_serial: true
+      - id: yesqa
+        name: yesqa
+        entry: yesqa
+        language: system
+        types: [python]
+      - id: pyupgrade
+        name: pyupgrade
+        entry: pyupgrade
+        language: system
+        types: [python]
+        args: ["--py39-plus"]

CHANGELOG.md

@@ -1,3 +1,10 @@
 # Changelog
 
 ## Next version
+- Dropped support for pylint versions below 3.3
+- Officially support python 3.9-3.14
+- Dropped support for python 3.8 and before
+- Complete refactoring of the project
+- Dropped support for the custom pyproject.toml section
+- Support parallel mode of pylint
+- Switch from regex patterns to globs

README.md

@@ -1,82 +1,61 @@
 [![REUSE status](https://api.reuse.software/badge/github.com/SAP/pylint-per-file-ignores)](https://api.reuse.software/info/github.com/SAP/pylint-per-file-ignores)
 
 
-# Pylint Per File Ignores 😲
-
+# Pylint Per File Ignores
 This pylint plugin will enable per-file-ignores in your project!
 
-The project was initaly created by [christopherpickering](https://github.com/christopherpickering).
-Please stay tuned for fixes, feature, etc. in the next months but please give me some time to board on :).
+The project was initially created by [christopherpickering](https://github.com/christopherpickering).
 
 ## Install
-
 ```
-# w/ poetry
-poetry add pylint-per-file-ignores --group dev
-
-# w/ pip
 pip install pylint-per-file-ignores
 ```
 
 ## Add to Pylint Settings
-
 ```toml
-[tool.pylint.MASTER]
+[tool.pylint.main]
 load-plugins=[
     "pylint_per_file_ignores",
     ...
 ]
 ```
 
-
 ## Usage
-
 Add list of patterns and codes you would like to ignore.
+The patterns are matched using `globs`.
 
-### Using native pylint settings
-
-Section "MESSAGES CONTROL". Examples:
-
+**.pylintrc**
 ```ini
-# .pylintrc
-
 [MESSAGES CONTROL]
 per-file-ignores =
-  .*_test\.py:protected-access # ignore "protected-access" errors in test files ending in "_test.py"
+  /folder_1/:missing-function-docstring,W0621,W0240,C0115
+  file.py:C0116,E0001
 ```
 
+**setup.cfg**
 ```ini
-# setup.cfg
-
 [pylint.MESSAGES CONTROL]
 per-file-ignores =
   /folder_1/:missing-function-docstring,W0621,W0240,C0115
   file.py:C0116,E0001
 ```
 
+**pyproject.toml**
 ```toml
-# pyproject.toml
-
 [tool.pylint.'messages control']
 per-file-ignores = [
     "/folder_1/:missing-function-docstring,W0621,W0240,C0115",
     "file.py:C0116,E0001"
 ]
 ```
 
-### Using custom `pyproject.toml` section
-
-For backwards compatibility only. Example:
-
-```toml
-[tool.pylint-per-file-ignores]
-"/folder_1/"="missing-function-docstring,W0621,W0240,C0115"
-"file.py"="C0116,E0001"
-```
-
-## Thanks
+## Build and Publish
 
-To pylint :) And the plugin `pylint-django` who produced most of the complex code.
+This project uses `setuptools` as the dependency management and build tool.
+To publish a new release, follow these steps:
+* Update the version in the `pyproject.toml`
+* Add an entry in the changelog
+* Push a new tag like `vX.X.X` to trigger the release
 
 ## Support, Feedback, Contributing