.lib.Result has grown enourmously in size and merits its own module.
For now, reexport it from .lib.base to not break all code containing
"from jw.lib.base import Result"
Signed-off-by: Jan Lindemann <jan@janware.com>
Forgejo versions before 15 didn't support workflow expansion, and
"runs-on" was necessary in callers of reusable workflows. janware.com
now runs Forgejo 15.x, and the requirement is gone, so remove the config
option.
Quoting from https://forgejo.org/docs/latest/user/actions/reference/
runs-on is typically a required field. However, if a job defines
jobs.<job_id>.uses in order to reference a reusable workflow, then it
is optional. See jobs.<job_id>.uses for more information on this
behaviour.
[...]
It is recommended that jobs.<job_id>.runs-on is omitted when using
uses, as this will allow Forgejo to perform workflow expansion.
Workflow expansion results in the target workflow’s jobs appearing in
the UI as separate jobs. This provides an easier to understand
experience for accessing the logs of each job, and permits the jobs to
run on separate runners with their own runs-on fields.
Signed-off-by: Jan Lindemann <jan@janware.com>
Accept if AsyncSSH is missing. The package would be nice to have,
i.e. a good candidate for a "recommends" section, but until there's
support for that, better be able to do without and fall back to
command-line ssh.
Signed-off-by: Jan Lindemann <jan@janware.com>
Accept if argcomplete is missing. The package would be nice to have,
i.e. a good candidate for a "recommends" section, but until there's
support for that, better be able to do without.
Signed-off-by: Jan Lindemann <jan@janware.com>
"make check" fails on Kali Linux, because the machinery lacks pieces:
- Add mypy, yapf3, python3-pyright to project.conf for Debian. The
pyright package is not in upstream Kali, but is now supplied by
the jw-foss repo.
- ifdef ruff out from "make check" in py-topdir.mk, because it's
too much work to get that to work from packages on Kali Linux for
now.
project.conf, py-topdir.mk: Make Kali work
Signed-off-by: Jan Lindemann <jan@janware.com>
All commands that do load_subcommands() should have a default _run()
implementation which calls print_help(), add them.
Signed-off-by: Jan Lindemann <jan@janware.com>
Fix another regression of commit 6db73873e7:
lib.ExecContext.CallContext.__exit__() returns True, which swallows
all exceptions thrown in the context of _run() and _sudo(). Fix that.
Signed-off-by: Jan Lindemann <jan@janware.com>
Allow find_dir() to return None in case it couldn't find a directory,
that's a legal outcome. Add a boolean parameter "throw" to support
throwing an exception if the existence needs to be asserted.
It would probably be nicer for the type checkers to split this up
into a throwing and non-throwing function. Postponed.
Signed-off-by: Jan Lindemann <jan@janware.com>
Updates running in non-interactive mode are passed
--force-resolution
--auto-agree-with-licenses
to get more snakes out of the way, as recently during CI:
# make pkg-install-testbuild-deps
/usr/bin/which: no xdg-open in (/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin)
/usr/bin/python3.13 ./scripts/jw-pkg.py -p ./.. -t .
--topdir-format absolute --interactive=false pkg install "make"
"time" "xdg-utils" "coreutils" "cpio" "git-core" "bash" "python3"
"sudo" "gawk" "pkg-config" "python3-isort" "python3-yapf"
"python3-ruff" "python3-pyright" "rpmbuild" "python3-base"
,---- file://local: Running /usr/bin/zypper --non-interactive --gpg-auto-import-keys --no-gpg-checks install make time xdg-utils coreutils cpio git-core bash python3 sudo gawk pkg-config python3-isort python3-yapf python3-ruff python3-pyright rpmbuild python3-base - >
| Loading repository data...
| Reading installed packages...
| 'sudo' is already installed.
| No update candidate for 'sudo-1.9.17p2-2.2.x86_64'. The highest available version is already installed.
| 'bash' is already installed.
| No update candidate for 'bash-5.3.9-6.4.x86_64'. The highest available version is already installed.
| 'python3' not found in package names. Trying capabilities.
| 'python313' providing 'python3' is already installed.
| 'coreutils' is already installed.
| No update candidate for 'coreutils-9.11-3.1.x86_64'. The highest available version is already installed.
| 'pkg-config' not found in package names. Trying capabilities.
| 'make' is already installed.
| No update candidate for 'make-4.4.1-3.5.x86_64'. The highest available version is already installed.
| 'python3-base' not found in package names. Trying capabilities.
| 'python313-base' providing 'python3-base' is already installed.
| 'rpmbuild' not found in package names. Trying capabilities.
| 'git-core' is already installed.
| No update candidate for 'git-core-2.54.0-2.1.x86_64'. The highest available version is already installed.
| 'python3-pyright' not found in package names. Trying capabilities.
| 'python3-ruff' not found in package names. Trying capabilities.
| 'python3-isort' not found in package names. Trying capabilities.
| 'python3-yapf' not found in package names. Trying capabilities.
| Resolving package dependencies...
|
| Problem: 1: the installed busybox-gawk-1.37.0-41.4.noarch conflicts with 'gawk' provided by the to be installed gawk-5.4.0-1.1.x86_64
| Solution 1: Following actions will be done:
| do not install gawk-5.4.0-1.1.x86_64
| do not ask to install a solvable providing rpmbuild
| Solution 2: deinstallation of busybox-gawk-1.37.0-41.4.noarch
|
| Choose from above solutions by number or cancel [1/2/c/d/?] (c): c
`---- file://local: Running /usr/bin/zypper --non-interactive --gpg-auto-import-keys --no-gpg-checks install make time xdg-utils coreutils cpio git-core bash python3 sudo gawk pkg-config python3-isort python3-yapf python3-ruff python3-pyright rpmbuild python3-base - <
Signed-off-by: Jan Lindemann <jan@janware.com>
Fix a regregression breaking run_curl() / run_curl_into(), introduced
by commit 6db73873e7. A missing indentation raises a non-existing
Error after successful JSON parsing, fix that.
Signed-off-by: Jan Lindemann <jan@janware.com>
The generated code doesn't pass "make check": It would like to see a
newline after the import statement. Add that.
Signed-off-by: Jan Lindemann <jan@janware.com>
App.is_excluded_from_build() uses the wrong function entirely to
query the [build.exclude] section of project.conf
(App.get_project_refs() instead of App.get_value()). This has
obviously never worked. It rose to prominence because commit 6db73873
introduced App.__proj_dir(), which now raises an Exception if passed
garbage, which in turn surfaces as
Exception: No project path found for module "debian"
Use the correct function for that: App.get_value().
Signed-off-by: Jan Lindemann <jan@janware.com>
This file can be included from toplevel Makefiles of projects which are part
of a jw-pkg project tree but don't want to provide necessary targets
themselves. The targets in this makefile simply do nothing. Feel free to add
functionality to whatever target seems useful to you.
Signed-off-by: Jan Lindemann <jan@janware.com>
This reverts the changes commit 24928c6f did beyond mere type fixes to
pkg_relations(). It looked better, but it had the output collapse to
an empty list. Refactoring of that mega-function postponed.
Signed-off-by: Jan Lindemann <jan@janware.com>
Add new ruff rules and fix their fallout:
future-annotations = true
select = [
"TC", # type-checking import placement rules
"FA", # future annotations rules
]
This comprises:
- Streamline imports and exports in cmds.xxx.Cmd
- Import base class as "Base"
- Export types Cmd and Parent via __all__
- Move all types imported only for annotation below TYPE_CHECKING
- Use "from __future__ import annotations" all over the place
Signed-off-by: Jan Lindemann <jan@janware.com>
In order to produce make check output digestable by vim, ruff's
output format needs to be set to "concise", so do that.
Signed-off-by: Jan Lindemann <jan@janware.com>
make topdir doesn't reliably regenerate pyrightconfig.json because of
.SECONDEXPANSION. Adding a second dollar symbol $$(TD_GENERATE_FILES)
solves the problem.
Signed-off-by: Jan Lindemann <jan@janware.com>
Add an empty __init__.py in jw.pkg to version control because, before
a build is through, it's needed for running jw-pkg.py from source.
Without it, with the jw now a namespace container and empty as such,
as long as src/python/jw/pkg/__init__.py is not yet created by make
all, /usr/lib64/python3.x/site-packages/jw/pkg will take precedence
before src/python/jw/pkg. So, if jw-pkg-run is installed regularly,
the source tree remains unused.
Signed-off-by: Jan Lindemann <jan@janware.com>
The previous commits have put rules for linting and formatting via
ruff, yapf, mypy and pyright into place. They are checked with the
make check target, and this commit adds the fixes for the target to
succeed.
It does some refactoring where type checking dug up dirty bits, and
also adds lots of churn in the Python code. To a good deal, that's
owed to mere formatting changes. It would have been better to
seperate those from syntax and refactoring fixes into multiple
commits, so that the interesting changes don't drown in the
formatting nose. However, that would have been a lot of additional
work only to be thrown away by later commits, hence this commit has a
big diff in one piece. The size of the diff is regrettable but
hopefully a one-off: What it buys is automatic format checking for CI
and predictble formats for smaller diffs in the future.
Rules that "make check" enforces are, in the following order
- Syntax checkers:
- ruff check .
- mypy .
- pyright
- Format check:
- yapf --diff --recursive .
The refactoring includes:
- Turn the Result class into a more elaborate object, capable of
doing more heavy lifting around stderr and stdout decoding,
summarizing outcome, and matching error strings.
Aside from fixing broken type checks, this also removes lots of
boilerplate calling code which is currently used for handling
possible call outcome scenarios. Trying to access an inexistent,
decoded string should raise a meaningful exception by itself now,
which removes lots of code with case distinctions.
- Fix Cmd type hierarchy:
- Add the AbstractCmd class above Cmd. This is necessary because
the checker rightfully complains it can't instantiate a Cmd
instance where constructor arguments were needed. They never
were, but the type used at the instantiating code's location in
jw.pkg.App so claims.
- Lots of sub- and sub-subcommands are derived from the base
class of the invoking command. That provides some properties
shared across the ancestor hierarchy of a command, but is
semantically unsound. Fix that by introducing jw.pkg.BaseCmd
class as a place to provide basic helpers shared across all
commands used in a jw.pkg.App's context, and derive all command
classes from that afresh. The parent command is still reachable
via a common parent property.
Formatting changes are conforming to PEP-8, mostly, with minor
tweaks. All in all they include the following changes.
- Remove # -*- coding: utf-8 -*-
The line was needed by Python 2 which is not supported anylonger.
For Python 3, the default encoding is UTF-8, anyway.
- Allow to run "make py-format" without having it produce any
changes. It's basically "yapf --in-place --recursive ." with some
code style settings, see conf/topdir/pyproject.toml. The settings
may be debatable. I've had custom tweaks in place on that target,
too, but then again, IDEs would have more hassle to integrate
that.
- Introduce a 88 character line length limit
- One import per line, reshuffle them semantically, see
[tool.isort] in pyproject.toml.
- Hide imports needed for type-checking only behind
if TYPE_CHECKING
- Spaces around assignments accounts for much churn. Having having
no spaces in inline parameter list assignments and default
parameter values would arguably be more compact where it's
useful. On the other hand, I have not found a code formatter
which allows spaces around assignments in parameter lists broken
into one per line and that's often better than a wall of text.
- Add two spaces before # export, as this seems to be mandated by
PEP-8
- Use single quotes by default
Signed-off-by: Jan Lindemann <jan@janware.com>
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>
- Use ruff and yapf for the targets py-check-syntax, py-format and
py-check-format.
- Add a pyproject.toml for those. It also includes configuration
for isort, albeit not being directly used in the linter targets.
- Make .gitignore igore that in newly created projects.
- Add ruff, yapf and isort to pkg.requires.release, anticipating
their use by CI.
Signed-off-by: Jan Lindemann <jan@janware.com>
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>
Add py-ns-dir.mk. It's first intended use is inside the
$(TOPDIR)/src/python/jw directories of each package. These are to be
treated specially, because they contribute to the same namespace: jw.
This is true when installed, which means that no __init__.py should
be packaged from that directory, see the guide linked below.
And it's also true when not installed, in which case there has to be
a path-extending __init__.py in the directory. Normally, it should
work without __init__.py in that case, as well, and it does for
running Python code with PYTHONPATH pointing to the respective
package roots. However, pyright doesn't seem to pull in code
scattered over multiple locations without an old-style namespace
path-extender, so we're likely going to add (but not install) an
__init__.py there.
Not sure if it's going to be auto-generated py py-ns-dir.mk or
committed to version control, we'll see with more testing.
Here's where I have my info from, aside from experiments.
https://packaging.python.org/en/latest/guides/packaging-namespace-packages/
Signed-off-by: Jan Lindemann <jan@janware.com>
If $(wildcard py.typed) is found in a python module directory,
install it. py.typed should be used by every repo that declares
properly typed code, for jw-pkg that would be at the jw.pkg node, i.e
installed to <site-dir>/jw/jw-pkg/py.typed.
Signed-off-by: Jan Lindemann <jan@janware.com>
Add generic machinery to dynamically create files in $(TOPDIR). The
need arises because version controlled configuration files for
linters are going to be introduced.
For that, this commit introduces a variable $(TD_GENERATE_FILES),
which target all depends on, and which topdir.clean removes.
It defaults to another variable also introduced by this commit,
$(TD_COPY_FILES), which in turn defaults to $(TOPDIR)/conf/topdir.
This commit also adds support for JW_PKG_TOPDIR_COPY_PATH. It
supports a PATH-style syntax, which allows pointing to multiple
directories to be checked for source files. If they exist, they will
be appended to the files found in $(TOPDIR)/conf/topdir after
copying. Defining arbitray files to copy is not supported before
security implications during CI runs are better understood.
Having the copy prerequisites work comes at the cost of having to add
.SECONDEXPANSION. Since it's limited to the toplevel Makefile, I
suppose that's acceptable.
Signed-off-by: Jan Lindemann <jan@janware.com>
Add CmdCreateFile as a command to generate files from project
metadata. It uses the new tmpl_render() engine, might serve as a
central location to replace other code generating files, let's see
how that evolves.
Signed-off-by: Jan Lindemann <jan@janware.com>
