Skip to content

Pull in the actual code format and lint bits from PR497 (thanks @albu-diku) #525

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

Merged
jonasbardino merged 2 commits into from
Apr 21, 2026
Merged

Pull in the actual code format and lint bits from PR497 (thanks @albu-diku) #525

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
317b85b
Pull in the actual code format and lint bits from PR497 (thanks @albu…
jonasbardino Apr 21, 2026
89610c3
Minor reordering to keep static excludes first.
jonasbardino Apr 21, 2026
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
32 changes: 10 additions & 22 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,9 @@ ifndef PY
PY = 3
endif

FORMAT_ENFORCE_DIRS = state/
FORMAT_EXCLUDE_REGEX = '.*'
FORMAT_EXCLUDE_GLOB = '*'
FORMAT_LINE_LENGTH = 80

# TODO: enable on these dirs when ready, but just leave to dummy init for now
#LINT_ENFORCE_DIRS = ./bin ./mig/lib ./sbin ./tests
LINT_ENFORCE_DIRS = ./mig/__init__.py
LOCAL_PYTHON_BIN = './envhelp/lpython'

ifdef PYTHON_BIN
Expand Down Expand Up @@ -42,15 +40,11 @@ ifneq ($(MIG_ENV),'local')
endif
@make format-python

.PHONY:format-python
# NOTE: black and isort use pyproject.toml to temporarily exclude a few paths
.PHONY: format-python
format-python:
@$(LOCAL_PYTHON_BIN) -m black $(FORMAT_ENFORCE_DIRS) \
--line-length=$(FORMAT_LINE_LENGTH) \
--exclude=$(FORMAT_EXCLUDE_REGEX)
@$(LOCAL_PYTHON_BIN) -m isort $(FORMAT_ENFORCE_DIRS) \
--profile=black \
--line-length=$(FORMAT_LINE_LENGTH) \
--skip-glob=$(FORMAT_EXCLUDE_GLOB)
@$(LOCAL_PYTHON_BIN) -m black $(LINT_ENFORCE_DIRS)
@$(LOCAL_PYTHON_BIN) -m isort $(LINT_ENFORCE_DIRS)

.PHONY: lint
lint:
Expand All @@ -60,17 +54,11 @@ ifneq ($(MIG_ENV),'local')
endif
@make lint-python

# NOTE: black and isort use pyproject.toml to temporarily exclude a few paths
.PHONY: lint-python
lint-python:
@$(LOCAL_PYTHON_BIN) -m black $(FORMAT_ENFORCE_DIRS) \
--check \
--line-length=$(FORMAT_LINE_LENGTH) \
--exclude $(FORMAT_EXCLUDE_REGEX)
@$(LOCAL_PYTHON_BIN) -m isort $(FORMAT_ENFORCE_DIRS) \
--check-only \
--profile=black \
--line-length=$(FORMAT_LINE_LENGTH) \
--skip-glob=$(FORMAT_EXCLUDE_GLOB)
@$(LOCAL_PYTHON_BIN) -m black $(LINT_ENFORCE_DIRS) --check
@$(LOCAL_PYTHON_BIN) -m isort $(LINT_ENFORCE_DIRS) --check-only

.PHONY: clean
clean:
Expand Down
36 changes: 36 additions & 0 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Project wide settings including tooling.

# Linting tools
# TODO: fix CodeQL errors in symlinked files and disable extend-exclude+skip

[tool.black]
line-length = 80
exclude = '''
tests/data/
| tests/fixture/
'''
# NOTE: the following regex matches must be kept in sync with isort skip
extend-exclude = '''
bin/checkconf.py
| bin/createresource.py
| bin/notifypassword.py
| sbin/grid_ftps.py
| sbin/grid_openid.py
| sbin/grid_sftp.py
| sbin/grid_webdavs.py
'''

[tool.isort]
profile = "black"
line_length = 80
skip_glob = [".git/*", "tests/data/*", "tests/fixture/*"]
# NOTE: the following paths must be kept in sync with black extend-exclude
skip = [
"bin/checkconf.py",
"bin/createresource.py",
"bin/notifypassword.py",
"sbin/grid_ftps.py",
"sbin/grid_openid.py",
"sbin/grid_sftp.py",
"sbin/grid_webdavs.py"
]
Loading