Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added python script linting #3264

Merged
merged 5 commits into from
Jan 12, 2025
Merged

Added python script linting #3264

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6ffca5e
Added python script linting
palisadoes Jan 12, 2025
b24349e
Added pyproject.toml to exclusion
palisadoes Jan 12, 2025
8817ed4
Updated venv
palisadoes Jan 12, 2025
83cc020
Fixed arguments function
palisadoes Jan 12, 2025
ef9bb34
Edit to argparse help
palisadoes Jan 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .flake8
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[flake8]

Check warning on line 1 in .flake8

View workflow job for this annotation

GitHub Actions / Performs linting, formatting, type-checking, checking for different source and target branch 

File ignored by default.
ignore = E402,E722,E203,F401,W503
max-line-length = 80
51 changes: 51 additions & 0 deletions .github/workflows/pull-request.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
##############################################################################

Check warning on line 1 in .github/workflows/pull-request.yml

View workflow job for this annotation

GitHub Actions / Performs linting, formatting, type-checking, checking for different source and target branch 

File ignored by default.
##############################################################################
#
# NOTE!
Expand Down Expand Up @@ -96,6 +96,9 @@
uses: tj-actions/changed-files@v45
with:
files: |
.flake8
.pydocstyle
pyproject.toml
.env*
vitest.config.js
src/App.tsx
Expand Down Expand Up @@ -449,3 +452,51 @@
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
PR_NUMBER: ${{ github.event.pull_request.number }}
GITHUB_REPOSITORY: ${{ github.repository }}


Python-Compliance:
name: Check Python Code Style
runs-on: ubuntu-latest
needs: [Code-Quality-Checks]
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0

- name: Set up Python 3.11
uses: actions/setup-python@v4
with:
python-version: 3.11
Comment on lines +467 to +470
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Update setup-python action to latest version.

The setup-python action version is outdated.

-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: 3.11
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- name: Set up Python 3.11
uses: actions/setup-python@v4
with:
python-version: 3.11
- name: Set up Python 3.11
uses: actions/setup-python@v5
with:
python-version: 3.11
🧰 Tools
🪛 actionlint (1.7.4)

468-468: the runner of "actions/setup-python@v4" action is too old to run on GitHub Actions. update the action's version to fix this issue

(action)


- name: Cache pip packages
uses: actions/cache@v4
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
restore-keys: |
${{ runner.os }}-pip-

- name: Install dependencies
run: |
python3 -m venv venv
source venv/bin/activate
python -m pip install --upgrade pip
pip install -r .github/workflows/requirements.txt

- name: Run Black Formatter Check
run: |
black --check .

- name: Run Flake8 Linter
run: |
flake8 --docstring-convention google --ignore E402,E722,E203,F401,W503 .github

- name: Run pydocstyle
run: |
pydocstyle --convention=google --add-ignore=D415,D205 .github

- name: Run docstring compliance check
run: |
source venv/bin/activate
python .github/workflows/scripts/check_docstrings.py --directories .github
14 changes: 14 additions & 0 deletions .github/workflows/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
#############################################################################

Check warning on line 1 in .github/workflows/requirements.txt

View workflow job for this annotation

GitHub Actions / Performs linting, formatting, type-checking, checking for different source and target branch 

File ignored by default.
# DO NOT DELETE
#############################################################################
#
# Required for GitHub Action workflow python checks
#
#############################################################################
#############################################################################

black
pydocstyle
flake8
flake8-docstrings
docstring_parser
Comment on lines +10 to +14
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Pin package versions for reproducible builds.

Dependencies should have version constraints to ensure reproducible builds and avoid breaking changes.

-black
-pydocstyle 
-flake8
-flake8-docstrings
-docstring_parser
+black==24.1.1
+pydocstyle==6.3.0
+flake8==7.0.0
+flake8-docstrings==1.7.0
+docstring_parser==0.15
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
black
pydocstyle
flake8
flake8-docstrings
docstring_parser
black==24.1.1
pydocstyle==6.3.0
flake8==7.0.0
flake8-docstrings==1.7.0
docstring_parser==0.15

Loading
Loading