The .strip property of class Result defaults to True, and its name
isn't very clear. Rename it to .strip_output, and default it to False
to avoid surprising contents for unsuspecting callers.
Signed-off-by: Jan Lindemann <jan@janware.com>
The command line jw-pkg.py is run with is logged with level "debug",
and reconstructed with ' '.join(sys.argv). Use pretty_cmd() instead,
this adds quotes around spaces.
Signed-off-by: Jan Lindemann <jan@janware.com>
Commands executed by ExecContext and its derived classes don't
populate the "cmd" parameter of "Result"'s constructor. Fixing that
makes for nicer error messages.
Signed-off-by: Jan Lindemann <jan@janware.com>
Use the (mostly) call-compatible log implementation from jw-python.
This buys us much nicer logs with color and source-code positon
annotations.
Signed-off-by: Jan Lindemann <jan@janware.com>
In LoadTypes' constructor, allow the type_filter parameter to be of
type Sequence[type[Any]] instead of list[type[T]]. a) Sequence is
more generic than list, and b) with T instead of Any, trying to
instantiate with an abstract class has mypy complain:
# E: Only concrete class can be given where "type[MyClass]" is
expected [type-abstract]
- type_filter: list[type[T]] = [],
+ type_filter: Sequence[type[Any]] | None = None,
Not that this makes mypy complain that it needs an annotation at the
places where LoadTypes is used.
Signed-off-by: Jan Lindemann <jan@janware.com>
OpenSUSE leaves installing local packages to the default
implementation in lib.Distro._install_local_files(), which passes the
package path to the package manager, i.e. zypper in OpenSUSE's case.
That has advantages, namely automatic installation of dependencies,
but also disadvantages, namely the attempt to install dependencies
even if the package manager is disfunctional, possibly because an
installed package containing installation sources is broken.
That could lead to a deadlock when trying to install a fixed package.
I see two ways out: Support an additional flag to jw-pkg's install
command which selects whether or not dependencies shall be resolved
along, or just use rpm directly for all local install attempts.
The latter is the less fancy way to handle this, so as a first step
make it the default by overriding suse.Distro._install_local_files().
Signed-off-by: Jan Lindemann <jan@janware.com>
Define default parameter values for Result's constructor, namely None
for exit status, stdout and stderr.
Instantiating a Result object without parameters signifies "this
object doesn't contain data from a real process's exit event". Up to
now, similar meaning has been hand-crafted by ExecContext's run() and
friends by using an error exit status (1) to make sure it wasn't
mistaken for success. This commit formalizes that into the Result
structure itself, but uses None instead for the exit status.
Controlling default values in Result itself also means that the
Result class gets better awareness of what it contains, and its log
messages and stdin / stdout can be more fitting:
- If a real process failed, make stdout return at least b''
- If a real process succeeded, make stdout return at least b''
Returning something from .stdout on success fixes a real bug: An
attempt to access what "rpm -U somepackage.rpm" returns, namely
nothing, raises a bogus exception, because stdout is None.
Signed-off-by: Jan Lindemann <jan@janware.com>
Make the log delimiter look more consistent: Whether a CallContext
was constructed with a title parameter or without, prefix its
.log_delimiter property with a "----".
Signed-off-by: Jan Lindemann <jan@janware.com>
Remove CmdPythonpathOrig. Its only purpose has ever been to document
and try out how cmd_pythonpath_orig() had worked in an ancient
application version, that purpose is now served.
Signed-off-by: Jan Lindemann <jan@janware.com>
Support additional options:
--subdir makes the command look for these existing
subdirectories. Can be specified multiple times.
--delimiter Does the obvious and defaults to ":"
--prefix A string to prepend verbatim before each path component
Signed-off-by: Jan Lindemann <jan@janware.com>
The global --topdir-format option governs how a project's root
directory is represented in paths output by various queries.
"absolute" means as absolute path, "unaltered" means verbatim as
specified via --topdir, make:xyz means replaced by the string $(xyz),
for later expansion in a makefile variable.
This commit adds another variant: "relative" yields the shortest
possible output format of the output path in question relative to
--topdir, with "shortest possible" in this context meaning
canonicalized and leading "./" stripped.
Signed-off-by: Jan Lindemann <jan@janware.com>
Ignore newline at the end of Result.stdout_str if only one line of
output is wanted from an executed shell command. The output of both
uname and mktemp are used wrongly in that regard.
Signed-off-by: Jan Lindemann <jan@janware.com>
- Add an additional, more generic value that --format understands:
"tmpl". If chosen, the template selected by the new option
--template-name is rendered by replacing --field key=value pairs.
- This commit also adds the option --quote, which makes the
renderer enclose the rendered variable values in double quotes.
Signed-off-by: Jan Lindemann <jan@janware.com>
Add --search-path to the list of CmdCreateFile's supported options.
Its value is split by ":" and subsequently passed to the tmpl_render()'s
search_path argument.
Signed-off-by: Jan Lindemann <jan@janware.com>
tmpl_render()'s "values" argument currently understands
dict[str,str|list[str]]. Enhance that to understand the broader
RenderValues type, which also includes Iterable[tuple[str, str]], as
produced by argparse.add_argument(action='append').
This commit also adds proper type-checking for the values argument.
Before, its type had gone unchecked entirely.
Signed-off-by: Jan Lindemann <jan@janware.com>
Add an additional keyword-argument search_path to
templates.tmpl_render(). It allows to specifiy a list of directory
paths in which a template of a given name can be found. It defaults
to [], in which case only the built-in templates are considered.
Otherwise file locations are tried first, then the built-in
templates.
Signed-off-by: Jan Lindemann <jan@janware.com>
In order to allow Pyright to check the types provided by dependant
repositories without installing them, pyrightconfig.json contains a
list of paths to their root directories in "extraPaths". These paths
are unusable for Pyright, though: For type checking to work, it needs
to be pointed to the "jw" namespace package paths within those repos.
This commit achieves that by appending the subdirs src/python and
tools/python to them, provided they exist.
TODO: This fix hardcodes the current project directory structure.
Better would be a way to customize that via makefiles, where the
paths can be more easily customized.
Signed-off-by: Jan Lindemann <jan@janware.com>
App.get_projects_refs() is a versatile tool, but what it does isn't
obvious. Use the simpler method .get_value() instead for
get_libname(), and return None if a project doesn't provide a
linkable library.
This is similar to fix aadcdfb5f.
Signed-off-by: Jan Lindemann <jan@janware.com>
In __get_project_refs():
- Rename variable dep and deps to val and vals, respectively,
because that's more what they are values of key-value pairs. In
some cases that can represent dependencies, in some case other
things.
- Make a scope case distinction a little clearer by mentioning all
possible cases in a match / case block
Signed-off-by: Jan Lindemann <jan@janware.com>
- Remove package_name and package_path from the prototype of
detect_modules(). They can and should be deduced from
namespace['__name__'] and namespace['__path__'], respectively.
- Make prefix default to None, which signifies "Don't filter by
prefix".
- Add an optional extend_namespace parameter, which will make the
function append the module's __name__ to its __path__. This
defaults to True, thereby adding a side effect to the function.
Which is always wanted in the case for all callers of this
function.
Signed-off-by: Jan Lindemann <jan@janware.com>
.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>
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>
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>
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 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>
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>
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>
BaseCmdPkgRelations contains pkg_relations(), a function doing
package graph analysis code. The function needs to be made available
to code outside BaseCmdPkgRelations, so move it to
cmds.projects.lib.pkg_relations.
The commit also applies style fixes to both BaseCmdPkgRelations and
pkg_relations which anticipate broader style changes to jw-pkg in
general.
Signed-off-by: Jan Lindemann <jan@janware.com>
