janware/jw-pkg
Watch
1
Code Pull requests Activity Actions
jw-pkg/make/py-topdir.mk

28 lines
1.1 KiB
Makefile
Raw Normal View History

py-topdir.mk: Use pythonpath --prefix for mypy_path Make use of the newly introduced --prefix option to the pythonpath command, and generate what's subseqently used to fill in mypy_path in pyproject.toml. By decoupling it from PYTHONPATH, this commit makes the creation of mypy_path less involved and easier to understand. It also obviates the need replace the relatively heavy ldlibpath.mk by the relatively lightweight projects.mk, thereby enhancing performance. Signed-off-by: Jan Lindemann <jan@janware.com>
2026-06-11 11:57:01 +02:00
include $(JWBDIR)/make/projects.mk
py-topdir.mk: Add machinery to generate pyproject.toml pyproject.toml is currently copied unchanged from conf/topdir to the toplevel directory. Set up machinery in py-topdir.mk to render it from a template in conf/templates instead, replacing {mypypath} in the process. Signed-off-by: Jan Lindemann <jan@janware.com>
2026-06-02 21:22:02 +02:00
TD_GENERATE_FILES += pyproject.toml
py-topdir.mk: Add file Add a file to be included from every toplevel Makefile of every repo that owns Python code. It defines the following targets: py-check: py-check-syntax py-check-format py-check-syntax: py-check-format: py-format: Currently, only mypy is run from py-check-syntax, but the targets are meant as entry point for further linter jobs in the future. There's also py-format-assignments: which is meant to add spaces around "=" in multi-line assignment blocks, but, pending future experiments, I thing that target is going to be removed again. Left in for now. Signed-off-by: Jan Lindemann <jan@janware.com>
2026-05-26 10:31:54 +02:00
PY_CHECK_EXCLUDE ?=
py-topdir.mk: Add machinery to generate pyproject.toml pyproject.toml is currently copied unchanged from conf/topdir to the toplevel directory. Set up machinery in py-topdir.mk to render it from a template in conf/templates instead, replacing {mypypath} in the process. Signed-off-by: Jan Lindemann <jan@janware.com>
2026-06-02 21:22:02 +02:00
py-topdir.mk: Use pythonpath --prefix for mypy_path Make use of the newly introduced --prefix option to the pythonpath command, and generate what's subseqently used to fill in mypy_path in pyproject.toml. By decoupling it from PYTHONPATH, this commit makes the creation of mypy_path less involved and easier to understand. It also obviates the need replace the relatively heavy ldlibpath.mk by the relatively lightweight projects.mk, thereby enhancing performance. Signed-off-by: Jan Lindemann <jan@janware.com>
2026-06-11 11:57:01 +02:00
MYPY_CONFIG_PATH = $(shell $(JW_PKG_PY) --topdir-format relative projects pythonpath --prefix '$$MYPY_CONFIG_FILE_DIR/' $(PROJECT))
py-topdir.mk: Add machinery to generate pyproject.toml pyproject.toml is currently copied unchanged from conf/topdir to the toplevel directory. Set up machinery in py-topdir.mk to render it from a template in conf/templates instead, replacing {mypypath} in the process. Signed-off-by: Jan Lindemann <jan@janware.com>
2026-06-02 21:22:02 +02:00
MYPY_PATH_DIRECTIVE = mypy_path = "$(MYPY_CONFIG_PATH)"
py-topdir.mk: Introduce $(PY_CHECK_ROOTS) Replace variable PY_SRC_ROOT by PY_CHECK_ROOTS. The name PY_SRC_ROOT was a bad choice, given that it isn't immediately obvious that it a) can contain multiple root locations to be checked, and that it b) specifically concerns static type checking. As of this commit, it's possible to limit the type checking scope with PY_CHECK_ROOTS as in PY_CHECK_ROOTS="src/python/jw/pkg/CmdBase.py src/python/jw/lib" \ make check Signed-off-by: Jan Lindemann <jan@janware.com>
2026-06-05 14:36:22 +02:00
ifndef PY_CHECK_ROOTS
py-topdir.mk: PY_CHECK_ROOTS: Don't += assign py-topdir.mk has this: ifndef PY_CHECK_ROOTS PY_CHECK_ROOTS += ... endif That is too involved: Either PY_CHECK_ROOTS is defined, then nothing is appended, or it's undefined, then a simple "=" would be just fine. Use that instead. Signed-off-by: Jan Lindemann <jan@janware.com>
2026-07-06 20:44:38 +02:00
PY_CHECK_ROOTS = $(wildcard $(TOPDIR)/src $(TOPDIR)/tools)
py-topdir.mk: Introduce $(PY_CHECK_ROOTS) Replace variable PY_SRC_ROOT by PY_CHECK_ROOTS. The name PY_SRC_ROOT was a bad choice, given that it isn't immediately obvious that it a) can contain multiple root locations to be checked, and that it b) specifically concerns static type checking. As of this commit, it's possible to limit the type checking scope with PY_CHECK_ROOTS as in PY_CHECK_ROOTS="src/python/jw/pkg/CmdBase.py src/python/jw/lib" \ make check Signed-off-by: Jan Lindemann <jan@janware.com>
2026-06-05 14:36:22 +02:00
endif
py-topdir.mk: Add file Add a file to be included from every toplevel Makefile of every repo that owns Python code. It defines the following targets: py-check: py-check-syntax py-check-format py-check-syntax: py-check-format: py-format: Currently, only mypy is run from py-check-syntax, but the targets are meant as entry point for further linter jobs in the future. There's also py-format-assignments: which is meant to add spaces around "=" in multi-line assignment blocks, but, pending future experiments, I thing that target is going to be removed again. Left in for now. Signed-off-by: Jan Lindemann <jan@janware.com>
2026-05-26 10:31:54 +02:00
all:
py-xxx.mk: Clean more python tool caches .mypy_cache, .ruff_cache and .pytest_cache are not consistently cleaned in all subdirectories. Fix that. Signed-off-by: Jan Lindemann <jan@janware.com>
2026-07-09 07:47:25 +02:00
clean: clean.topdir
py-topdir.mk: Add file Add a file to be included from every toplevel Makefile of every repo that owns Python code. It defines the following targets: py-check: py-check-syntax py-check-format py-check-syntax: py-check-format: py-format: Currently, only mypy is run from py-check-syntax, but the targets are meant as entry point for further linter jobs in the future. There's also py-format-assignments: which is meant to add spaces around "=" in multi-line assignment blocks, but, pending future experiments, I thing that target is going to be removed again. Left in for now. Signed-off-by: Jan Lindemann <jan@janware.com>
2026-05-26 10:31:54 +02:00
clean.topdir: clean.py-check
py-topdir.mk: Use pyright py-topdir.mk: Use ruff and yapf - Use pyright for the target py-check-syntax - Generate a $(TOPDIR)/pyrightconfig.json for that - Add pyrightconfig-base.json because it's used by pyrightconfig.json - Add python3-pyright to pkg.requires.release, anticipating the use of the py-syntax-check target by CI Signed-off-by: Jan Lindemann <jan@janware.com>
2026-05-27 18:59:00 +02:00
py-topdir.mk: Add machinery to generate pyproject.toml pyproject.toml is currently copied unchanged from conf/topdir to the toplevel directory. Set up machinery in py-topdir.mk to render it from a template in conf/templates instead, replacing {mypypath} in the process. Signed-off-by: Jan Lindemann <jan@janware.com>
2026-06-02 21:22:02 +02:00
pyproject.toml:
$(PYTHON) $(JWB_SCRIPT_DIR)/jw-pkg.py -p $(PROJECTS_DIR) -t $(TOPDIR) --topdir-format unaltered projects create-file --format tmpl \
--template-name $@ --search-path $(JW_PKG_CONF_BASE_DIR)/templates --field mypypath='$(MYPY_PATH_DIRECTIVE)' $(PROJECT) > $@.tmp
mv $@.tmp $@
py-topdir.mk: Use pyright py-topdir.mk: Use ruff and yapf - Use pyright for the target py-check-syntax - Generate a $(TOPDIR)/pyrightconfig.json for that - Add pyrightconfig-base.json because it's used by pyrightconfig.json - Add python3-pyright to pkg.requires.release, anticipating the use of the py-syntax-check target by CI Signed-off-by: Jan Lindemann <jan@janware.com>
2026-05-27 18:59:00 +02:00
pyrightconfig.json:
$(PYTHON) $(JWB_SCRIPT_DIR)/jw-pkg.py -p $(PROJECTS_DIR) -t $(TOPDIR) --topdir-format unaltered projects create-file --format pyright \
py-topdir.mk: Add machinery to generate pyproject.toml pyproject.toml is currently copied unchanged from conf/topdir to the toplevel directory. Set up machinery in py-topdir.mk to render it from a template in conf/templates instead, replacing {mypypath} in the process. Signed-off-by: Jan Lindemann <jan@janware.com>
2026-06-02 21:22:02 +02:00
--field base=$(JW_PKG_CONF_BASE_DIR)/project/pyrightconfig-base.json $(addprefix --field include=,$(wildcard src/python tools/python)) $(PROJECT) > $@.tmp
py-topdir.mk: Use pyright py-topdir.mk: Use ruff and yapf - Use pyright for the target py-check-syntax - Generate a $(TOPDIR)/pyrightconfig.json for that - Add pyrightconfig-base.json because it's used by pyrightconfig.json - Add python3-pyright to pkg.requires.release, anticipating the use of the py-syntax-check target by CI Signed-off-by: Jan Lindemann <jan@janware.com>
2026-05-27 18:59:00 +02:00
mv $@.tmp $@
py-check.mk: Add file Add py-check.mk and use it from py-topdir.mk and py-rules.mk. This removes redundant check definitions, making sure that that checks run from a repo's subdirectory match the checks run from its toplevel directory. Signed-off-by: Jan Lindemann <jan@janware.com>
2026-07-17 12:57:17 +02:00
include $(JWBDIR)/make/py-check.mk
Copy permalink