jw-pkg

Author	SHA1	Message	Date
Jan Lindemann	5d1ba6e15a	pyproject.toml: Enforce import annotations style 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>	2026-06-01 14:34:25 +02:00
Jan Lindemann	24928c6f5d	cmds / lib: Fix more static checker findings Fix more errors and warnings produced by "make check" as reported by CI and a pyright upgrade. Signed-off-by: Jan Lindemann <jan@janware.com>	2026-06-01 07:55:11 +02:00
Jan Lindemann	6db73873e7	jw.pkg: Fix "make check" static code check fallout 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>	2026-05-31 18:20:38 +02:00
Jan Lindemann	d9746cd20b	lib + cmds.projects: Use lib.Uri Remove the feeble attempts at unifying URI handling, and use class Uri from lib.Uri instead. Signed-off-by: Jan Lindemann <jan@janware.com>	2026-04-28 13:00:29 +02:00
Jan Lindemann	6cfb86d2a7	lib.FileContext.is_dir(): Add follow_symlinks Make FileContext.is_dir() usable: - Add follow_symlinks parameter meant to do the obvious - Fix missing await Signed-off-by: Jan Lindemann <jan@janware.com>	2026-04-28 13:00:29 +02:00
Jan Lindemann	b5762116a1	lib.FileContext.get(): Remove bogus owner, group, mode owner, group or mode don't belong in .get()'s signature, remove them. Signed-off-by: Jan Lindemann <jan@janware.com>	2026-04-28 13:00:29 +02:00
Jan Lindemann	37fcf56ad2	lib.FileContext._mktemp(): Fix missing self before _chroot() _mktemp() call _chroot() instead of self._chroot(), fix that. Signed-off-by: Jan Lindemann <jan@janware.com>	2026-04-25 13:50:42 +02:00
Jan Lindemann	3ac3aff997	lib: Fix silent assertitons There are a couple of assert statements in the codebase which can make jw-pkg fail without any detail whatsoever if --backtrace is not specified, fix that. Signed-off-by: Jan Lindemann <jan@janware.com>	2026-04-25 08:44:49 +02:00
Jan Lindemann	772512aee0	FileContext.open() / close(): Only call wrapped once FileContext's _open() and _close() are called everytime their wrapper is called, which tasks the caller with keeping track of whether they were already called or not. Be a little easier on the caller, keep track in an open count, and call _open() only once for multiple calls to open(), and close() likewise. The caller still needs to make sure the number of open() and close() calls matches. Signed-off-by: Jan Lindemann <jan@janware.com>	2026-04-24 16:53:55 +02:00
Jan Lindemann	4c81647bbe	lib.FileContext: Support attaching data filters - Add optional in_pipe and out_pipe parameters to __init__() - Add a add_proc_filter() method Add possibilites to attach input / output pipes to a FileContext instance. Data will be passed through the input pipe between ._get() and .get(), and through the output pipe between .put() and _put(). Signed-off-by: Jan Lindemann <jan@janware.com>	2026-04-23 20:18:40 +02:00
Jan Lindemann	58f7997bc6	lib.FileContext.open(): Add method Add an async open() method which should allow to do what __init__() couldn't, because it's not async, and to match the already existing .close(). It's called by __aenter__() __aexit__() if the FileContext is instantiated as context manager, or at will when the user finds it a good idea. Signed-off-by: Jan Lindemann <jan@janware.com>	2026-04-23 15:32:34 +02:00
Jan Lindemann	432830a5c5	lib.FileContext.mkdir(): Add method Add .mkdir() to the API which should do the expected, and implement it in ExecContext and Local specializations. Signed-off-by: Jan Lindemann <jan@janware.com>	2026-04-23 15:30:22 +02:00
Jan Lindemann	7547d13a6d	lib.FileContext: Support chroot Add a bool parameter "chroot" to __init__(). If passed, all path-centric operations act as if .root was prepended to it. Signed-off-by: Jan Lindemann <jan@janware.com>	2026-04-23 15:30:08 +02:00
Jan Lindemann	b52264dfad	lib.FileContext.root: Add property Add a .root property, returning the path part of the instantiating URI. Nothing meaningful beyond returning it is done with it so far. Signed-off-by: Jan Lindemann <jan@janware.com>	2026-04-23 15:29:20 +02:00
Jan Lindemann	6a3cf7a283	lib.FileContext: Beautify NotImplementedErrors Each wrapper method throws a NotImplementedError by default. Make that error a little more descriptive in case it really gets thrown. Signed-off-by: Jan Lindemann <jan@janware.com>	2026-04-23 15:28:54 +02:00
Jan Lindemann	3360ec86cb	lib.FileContext: Add URI manipulation methods Add .schema_from_uri(), .split_uri(), .id() to define some standardish way to dissect an URI the same way FileContext does. Signed-off-by: Jan Lindemann <jan@janware.com>	2026-04-23 15:27:38 +02:00
Jan Lindemann	b44879c517	lib.FileContext.file_exists(): Fix missing await file_exists and _stat() in file_exists() are async, need to be awaited, but aren't. Fix that. Signed-off-by: Jan Lindemann <jan@janware.com>	2026-04-21 21:52:09 +02:00
Jan Lindemann	3cf5b2264e	lib.FileContext: Add file methods Add the following methods, meant to do the obvious: unlink(self, path: str) -> None erase(self, path: str) -> None rename(self, src: str, dst: str) -> None mktemp(self, tmpl: str, directory: bool=False) -> None chown(self, path: str, owner: str\|None=None, group: str\|None=None) -> None chmod(self, path: str, mode: int) -> None stat(self, path: str, follow_symlinks: bool=True) -> StatResult file_exists(self, path: str) -> bool is_dir(self, path: str) -> bool All methods are async and call their protected counterpart, which is designed to be overridden. If possible, default implementations do something meaningful, if not, they just raise plain NotImplementedError. Signed-off-by: Jan Lindemann <jan@janware.com>	2026-04-18 10:43:31 +02:00
Jan Lindemann	fe3508036e	lib.FileContext.put(): Change param mode type str -> int Don't pass mode as a string to put(). Given the multitunde of possible string representations for numbers, some understood by int(string, 0) and some not, there's too much room for passing strings which are unparseable, or worse, prone to be parsed wrongly. However, pass mode down to _put() as a string for convenience, because that's what most _put() implementations will need to use. If they don't, converting to int is easy from the one defined string format. Signed-off-by: Jan Lindemann <jan@janware.com>	2026-04-18 10:43:31 +02:00
Jan Lindemann	64e9fbff59	lib.FileContext.put(): Swap params path and content Swap the positions of the "path" and "content" parameters of put(). Path comes always first, in every path related function I know. Signed-off-by: Jan Lindemann <jan@janware.com>	2026-04-18 10:43:31 +02:00
Jan Lindemann	94eee5c4bb	lib.FileContext.put(): Add parameter "atomic" Add the parameter "atomic" to put() / _put(). If instructs the implementation to take extra precautions to make sure the operation either succeeds or fails entirely, i.e. doesn't leave a broken target file behind. Signed-off-by: Jan Lindemann <jan@janware.com>	2026-04-18 10:43:31 +02:00
Jan Lindemann	0d6eeeadcf	lib.FileContext.log_name: Beautify Prepend the class name to .log_name. Not sure if that makes logs more legible, but we'll try it out for a while. Signed-off-by: Jan Lindemann <jan@janware.com>	2026-04-18 10:43:31 +02:00
Jan Lindemann	4f98fd6c78	lib.FileTransfer: Rename to FileContext Rename class FileTransfer to FileContext because that's the better name. It's the base class of ExecContext and also a context. Signed-off-by: Jan Lindemann <jan@janware.com>	2026-04-18 10:43:31 +02:00

23 commits