Commit graph

171 commits

Author SHA1 Message Date
13ec34cc57
lib.init.detect_modules(): Add function

Not all __init__.py modules are generated by python-tools.sh, some are needed early to make jw-pkg useful without generation, notably in jw.pkg.cmds.

Add detect_modules() to unify that detection, and place it into a minimal module lib.init to not increase startup time cost.

Signed-off-by: Jan Lindemann <jan@janware.com>
2026-05-31 17:52:20 +02:00
fc6f2fbb65
python-tools.sh: Fix __init__.py linter complaints

The __init__.py files as gnerated by python-tools.sh contain multiple issues, fix them:

- Make the machinery fail if the same type name is imported from different modules
- Support relative imports from .Module import Module instead of having to use the entire module path as import source

- Import types explicitly re-exported with "as":

from .Module import Module as Module
Otherwise ruff will regard the type as "imported but not used"
- Add "# ruff: noqa: E501" near the top. The import lines can get long and are beyond manual control (except for renaming the modules themselves, that is). This can cause ruff to fail, so get it to accept long lines in __init__.py. The style violation doesn't make much of a difference in generated code, anyway, because nobody reads that. Plus what's happening in the code isn't rocket science, so good style wouldn't help much with understanding, either.

This promptly digs up two symbol name conflicts lib.pm.dpkg and lib.pm.rpm. Fix them along with this commit to keep it from breaking the build.

Signed-off-by: Jan Lindemann <jan@janware.com>
2026-05-31 17:51:51 +02:00
99b57c5f4e
lib.Uri.basename: Add property

Add a property to get a file's basename. For

https://host.com/path/to/file?key=val

.basename should return "file"".

Signed-off-by: Jan Lindemann <jan@janware.com>
2026-05-21 11:32:33 +02:00
237096cac9
lib.Uri: Add new convenience properties

Add a couple of properties and methods that come in handy when manipulating URIs:

.path .safe_full_with_username

do the obvious, and these return new Uri objects with modified paths:

.new_add_path() .new_replace_path()

Signed-off-by: Jan Lindemann <jan@janware.com>
2026-05-06 15:26:14 +02:00
30abb227c7
lib.Cmd.print_help(): Add method

Add Cmd.print_help(). By default, it prints a help message. If passed an integer exit_status, it also calls sys.exit(exit_status).

Signed-off-by: Jan Lindemann <jan@janware.com>
2026-05-01 15:57:16 +02:00
7e2099877c
lib.Cmd.load_subcommands(): Add method

Push cmds.Cmd._add_subcommands() as lib.Cmd.load_subcommands() one step up to the top of the type hierarchy ladder.

By default, it does the same thing, i.e. load subcommands matching frobnicate.Cmd* if called on class CmdFrobnicate.

This commit also replaces invocations of Cmd._add_subcommands() by invocations of this new method.

Signed-off-by: Jan Lindemann <jan@janware.com>
2026-05-01 15:56:08 +02:00
5bb7fe96db
lib.util.get(): Add function

Add get(), which does pretty much what FileContext.get() does, but with auto-instantiating a FileContext instance. Input processing filters can be passed, too, all *args and **kwargs are passed unchanged to the FileContext's constructor.

Signed-off-by: Jan Lindemann <jan@janware.com>
2026-04-28 13:00:29 +02:00
fe1eb0014a
lib.ProcFilter: Add run()

Add a run() function. It constructs a pipeline from various possible types, and runs its data parameter through it.

Signed-off-by: Jan Lindemann <jan@janware.com>
2026-04-28 13:00:29 +02:00
1c11503dfb
lib.Distro._install(): Implement remote installation

lib.Distro._install()'s default implementation allows to install packages specified as direct links, but only to the local machine. Implement installation to arbitrary hosts specified with --target.

Signed-off-by: Jan Lindemann <jan@janware.com>
2026-04-28 13:00:29 +02:00
60de1b0ca0
lib.Distro.pkg_ext: Fix call to os_cascade

The Distro.pkg_ext property calls .os_cascade, which is a property, with parenthesis. Fix that.

Signed-off-by: Jan Lindemann <jan@janware.com>
2026-04-28 13:00:29 +02:00
5837d10a1c
lib.util.copy(): Tolerate list[str] and FileContext args

Modify copy():

- Allow the source argument src_uri to be a list of URIs, in which case copy should return a list of paths instead of one path
- Change the dst_uri parameter to dst, signalling that it now also tolerates a FileContext
- Use the CopyContext class to manage the source and target FileContext instances
Signed-off-by: Jan Lindemann <jan@janware.com>
2026-04-28 13:00:29 +02:00
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
f0eeb14a97
lib.base.Uri: Add module

Add a URI abstraction module. The class is designed to replace less unified attempts at URI parsing throughout the jw-pkg code base.

Signed-off-by: Jan Lindemann <jan@janware.com>
2026-04-28 13:00:29 +02:00
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
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
6ced64202e
lib.ExecContext._stat(): Don't decode stderr twice

The output of /usr/bin/stat is decoded once the Result object is decoded as a whole, and then again individually, which fails of course. Fix that.

Signed-off-by: Jan Lindemann <jan@janware.com>
2026-04-28 13:00:28 +02:00
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
66b968c51c
TarIo.TarIoTarFile._extract(): Fix typo

TarIoTarFile is currently unused but should still be correct, so fix a typo in _extract().

Signed-off-by: Jan Lindemann <jan@janware.com>
2026-04-25 08:47:45 +02:00
069899e48e
lib: Remove leftover breakpoints

Remove two breakpoints not belonging in the code of TarIo and Types.

Signed-off-by: Jan Lindemann <jan@janware.com>
2026-04-25 08:47:21 +02:00
a9475de48e
lib.ExecContext: Add open() + close() around _run()

Enclose ExecContext._run() in an open() / close() - pair. This is convenient for the caller in that it doesn't need to take care of opening and closing for one call only, and inconvenient in that it forces the caller to conciously add an open() / close() - pair around multiple run() calls where it wants the context to stay open in between. Or use the ExecContext as a context manager.

Signed-off-by: Jan Lindemann <jan@janware.com>
2026-04-25 08:45:29 +02:00
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
7309ec687e
lib.TarIo.extract(): Return list of extracted files

Make TarIo.extract return the list of files that were actually extracted.

Signed-off-by: Jan Lindemann <jan@janware.com>
2026-04-24 16:53:55 +02:00
f2ca32a343
CopyContext: Replace src_uri, dst_uri by src, dst

Allow to pass ready-made FileContext objects to CopyContext's destructor so it doesn't need to instantiate them itself.

Signed-off-by: Jan Lindemann <jan@janware.com>
2026-04-24 16:53:55 +02:00
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
cc6febcda3
lib.Cmd: Add description property

Add keyword-argument description to Cmd.__init__(), and default it to help. Also, add a property .description returning it, and add it to add_parser() so that it shows up in the usage message.

Signed-off-by: Jan Lindemann <jan@janware.com>
2026-04-24 16:53:54 +02:00
a5e7647026
lib.TarIo: Add module

Add a class providing a method to read tar files from a FileContext, and extract them to another.

Signed-off-by: Jan Lindemann <jan@janware.com>
2026-04-23 20:18:42 +02:00
d82bc20663
lib.CopyContext: Add module

Add a CopyContext class. At this point it mostly acts as a context manager for two FileContext instances, and copying data is the canonical case to use it, hence the name.

Signed-off-by: Jan Lindemann <jan@janware.com>
2026-04-23 20:18:42 +02:00
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
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
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
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
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
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
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
efe047fa50
lib.ExecContext: Strip unnecessary args from __init__()

Code beautification: __init__() doesn't use the arguments it grabs by name from its parameter list, use *args and **kwargs instead.

Signed-off-by: Jan Lindemann <jan@janware.com>
2026-04-23 15:26:42 +02:00
d70454b32a
lib.ProcFilterGpg: Add module

Add a ProcFilter implementation for decrypting GPG blobs. It needs an ExecContext passed to __init__() in order to run /usr/bin/gpg.

Signed-off-by: Jan Lindemann <jan@janware.com>
2026-04-23 15:25:57 +02:00
411bfd41ca
lib.ProcFilter: Add module

Add the ProcFilter module, containing the following classes:

- ProcFilter:

Abstract base class defining a run(data: bytes) -> Result method, allowing to do arbitrary data manipulation in subclasses.

- ProcFilterIdenty

A ProcFilter specialization which passes through the input unchanged.

- ProcPipeline

A container for multiple chained ProcFilter classes
Signed-off-by: Jan Lindemann <jan@janware.com>
2026-04-23 15:23:27 +02:00
fc6af091eb
lib.Distro.select(): Add filter parameter

Add an optional "filter: PackageFilter|None" parameter to .select(), and if it's not None, call a new version of ._select() with it.

._select() is not abstract anylonger. Its default implementation filters the results of ._select_by_name(), can be reimplemented by deriving classes for better performance, but doesn't have to.

Signed-off-by: Jan Lindemann <jan@janware.com>
2026-04-21 21:52:10 +02:00
4e1ec7eaf6
lib.Distro._select() -> _select_by_name()

Rename ._select() to _select_by_name() in Distro and its subclasses. Don't rename .select() itself, because it's going to be a broader interface supporting more select criteria than just package names.

Signed-off-by: Jan Lindemann <jan@janware.com>
2026-04-21 21:52:09 +02:00
dcdf69890c
lib.Distro.default_pkg_filter: Add property

Add a default_pkg_filter parameter to Distro's constructor defaulting to None, and expose it via the .default_pkg_filter property. As of this commit, no code in jw-pkg does anything meaningful with it.

Signed-off-by: Jan Lindemann <jan@janware.com>
2026-04-21 21:52:09 +02:00
33ff46e7b3
lib.PackageFilter: Add module

Add a package filter abstraction designed to replace the package filter string tossed around various functions througout jw-pkg.

Signed-off-by: Jan Lindemann <jan@janware.com>
2026-04-21 21:52:09 +02:00
3f66e061a6
lib.Package: Cosmetics: Fix log message typo

Fix typo in log message.

Signed-off-by: Jan Lindemann <jan@janware.com>
2026-04-21 21:52:09 +02:00
d14f1645c1
lib.ExecContext._chmod(): Fix broken mode string
Signed-off-by: Jan Lindemann <jan@janware.com>
2026-04-21 21:52:09 +02:00
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
8210baa683 lib.ec.ssh.AsyncSSH: Code beautification

- Remove _run_on_conn() because it doesn't add any value

- Add verbose try-except block around connect()

- Add try-except block around failing close

- Prefix private member variables with "__"

Signed-off-by: Jan Lindemann <jan@janware.com>
2026-04-19 21:09:51 +02:00
baf09e32eb lib.ec.ssh.AsyncSSH: Re-use connection

Commit a19679fec reverted the first attempt to make AsyncSSH reuse one connection during an instance lifetime. That failed because a lot of distribution-specific properties were filled in a new event loop thread started by AsyncRunner, and AsyncSSH didn't like that.

The last commit provided the needed properties as members of the Distro class. This commit is the second part of the solution: Keep one connection around as a class member and reuse it on every _run() invocation.

Signed-off-by: Jan Lindemann <jan@janware.com>
2026-04-19 21:08:04 +02:00
aa7275f426 App.distro_xxx: Move properties to Distro.xxx

Commit a19679fec reverted the first attempt to make AsyncSSH reuse one connection during an instance lifetime. That failed because a lot of distribution-specific properties were filled in a new event loop thread started by AsyncRunner, and AsyncSSH didn't like that.

This commit is the first part of the solution: Move those properties from the App class to the Distro class, and load the Distro class in an async loader. As soon as it's instantiated, it can provide all its properties without cluttering the code with async keywords.

Signed-off-by: Jan Lindemann <jan@janware.com>
2026-04-19 21:00:21 +02:00
c238a0d2d0 lib.ec.ssh.AsyncSSH: Replace legacy Caps.Env

AsyncSSH uses the legacy Caps.Env, replace it by Caps.ModEnv.

Signed-off-by: Jan Lindemann <jan@janware.com>
2026-04-19 20:59:16 +02:00
f1898941e7 lib.ec.ssh.AsyncSSH: Code beautification

Apply some style changes:

- Replace double by single quotes for consistency

- Add spaces around equal signs in long parameter lists

Signed-off-by: Jan Lindemann <jan@janware.com>
2026-04-19 14:36:50 +02:00
1359719f04 lib.ExecContext: Code beautification

Add spaces around equal signs in long parameter lists.

Signed-off-by: Jan Lindemann <jan@janware.com>
2026-04-19 14:36:50 +02:00