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>
This commit is contained in:
parent
8c5c98c95a
commit
6db73873e7
GPG key ID:
3750640C9E25DD61
97 changed files with 3229 additions and 1893 deletions
|
|
@ -1,50 +1,66 @@
|
|||
# -*- coding: utf-8 -*-
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
from typing import Iterable, TYPE_CHECKING
|
||||
from typing import TYPE_CHECKING, Iterable
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from ..ExecContext import ExecContext
|
||||
|
||||
from ..base import InputMode
|
||||
from ..Package import Package
|
||||
from ..util import run_cmd, run_sudo
|
||||
from ..Package import Package, meta_tags
|
||||
|
||||
_meta_map: dict[str, str]|None = None
|
||||
_meta_map: dict[str, str] | None = None
|
||||
|
||||
def meta_map():
|
||||
global _meta_map
|
||||
if _meta_map is None:
|
||||
_meta_map = Package.order_tags({
|
||||
'name': 'binary:Package',
|
||||
'vendor': None, # deb doesn't have vendor field
|
||||
'packager': None, # -- packager --
|
||||
'url': 'Homepage',
|
||||
'maintainer': 'Maintainer',
|
||||
})
|
||||
_meta_map = Package.order_tags(
|
||||
{
|
||||
'name': 'binary:Package',
|
||||
'vendor': None, # deb doesn't have vendor field
|
||||
'packager': None, # -- packager --
|
||||
'url': 'Homepage',
|
||||
'maintainer': 'Maintainer',
|
||||
}
|
||||
)
|
||||
return _meta_map
|
||||
|
||||
async def run_dpkg(args: list[str], sudo: bool=False, ec: ExecContext=None): # export
|
||||
async def _run(
|
||||
cmd: list[str], sudo: bool = False, ec: ExecContext | None = None
|
||||
) -> str:
|
||||
return (
|
||||
await run_sudo(cmd)
|
||||
if sudo else await run_cmd(cmd, ec = ec, cmd_input = InputMode.NonInteractive)
|
||||
).stdout_str
|
||||
|
||||
async def run_dpkg(
|
||||
args: list[str],
|
||||
sudo: bool = False,
|
||||
ec: ExecContext | None = None
|
||||
) -> str: # export
|
||||
cmd = ['/usr/bin/dpkg']
|
||||
cmd.extend(args)
|
||||
if sudo:
|
||||
return await run_sudo(cmd, ec=ec)
|
||||
return (await run_cmd(cmd, ec=ec)).decode()
|
||||
return await _run(cmd, sudo, ec)
|
||||
|
||||
async def run_dpkg_query(args: list[str], sudo: bool=False, ec: ExecContext=None): # export
|
||||
async def run_dpkg_query(
|
||||
args: list[str],
|
||||
sudo: bool = False,
|
||||
ec: ExecContext | None = None
|
||||
) -> str: # export
|
||||
cmd = ['/usr/bin/dpkg-query']
|
||||
cmd.extend(args)
|
||||
if sudo:
|
||||
return await run_sudo(cmd)
|
||||
return (await run_cmd(cmd, ec=ec, cmd_input=InputMode.NonInteractive)).decode()
|
||||
return await _run(cmd, sudo, ec)
|
||||
|
||||
async def query_packages(names: Iterable[str] = [], ec: ExecContext=None) -> Iterable[Package]:
|
||||
fmt_str = '|'.join([(f'${{{tag}}}' if tag else '') for tag in meta_map().values()]) + r'\n'
|
||||
async def query_packages(names: Iterable[str] = [],
|
||||
ec: ExecContext | None = None) -> Iterable[Package]:
|
||||
fmt_str = (
|
||||
'|'.join([(f'${{{tag}}}' if tag else '')
|
||||
for tag in meta_map().values()]) + r'\n'
|
||||
)
|
||||
# dpkg-query -W -f='${binary:Package}|${Maintainer}| ... \n'
|
||||
specs, stderr, status = await run_dpkg_query(['-W', '-f=' + fmt_str, *names], sudo=False, ec=ec)
|
||||
specs = await run_dpkg_query(['-W', '-f=' + fmt_str, *names], sudo = False, ec = ec)
|
||||
return Package.parse_specs_str(specs)
|
||||
|
||||
async def list_files(pkg: str, ec: ExecContext=None) -> list[str]:
|
||||
file_list_str, stderr, status = await run_dpkg(['-L', pkg], sudo=False, ec=ec)
|
||||
async def list_files(pkg: str, ec: ExecContext | None = None) -> list[str]:
|
||||
file_list_str = await run_dpkg(['-L', pkg], sudo = False, ec = ec)
|
||||
return file_list_str.splitlines()
|
||||
|
|
|
|||
|
|
@ -1,45 +1,71 @@
|
|||
# -*- coding: utf-8 -*-
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
from typing import Iterable, TYPE_CHECKING
|
||||
from typing import TYPE_CHECKING, Iterable
|
||||
|
||||
from ..base import InputMode
|
||||
from ..Package import Package
|
||||
from ..util import run_cmd, run_sudo
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from ..ExecContext import ExecContext
|
||||
|
||||
from ..util import run_cmd, run_sudo
|
||||
from ..base import InputMode
|
||||
from ..Package import Package, meta_tags
|
||||
|
||||
_meta_map: dict[str, str]|None = None
|
||||
_meta_map: dict[str, str] | None = None
|
||||
|
||||
def meta_map():
|
||||
global _meta_map
|
||||
if _meta_map is None:
|
||||
_meta_map = Package.order_tags({
|
||||
'name': 'Name',
|
||||
'vendor': 'Vendor',
|
||||
'packager': 'Packager',
|
||||
'url': 'URL',
|
||||
'maintainer': None, # RPM doesn't have a maintainer field
|
||||
})
|
||||
_meta_map = Package.order_tags(
|
||||
{
|
||||
'name': 'Name',
|
||||
'vendor': 'Vendor',
|
||||
'packager': 'Packager',
|
||||
'url': 'URL',
|
||||
'maintainer': None, # RPM doesn't have a maintainer field
|
||||
}
|
||||
)
|
||||
return _meta_map
|
||||
|
||||
async def run_rpm(args: list[str], sudo: bool=False, ec: ExecContext=None, mode: InputMode=InputMode.OptInteractive, **kwargs): # export
|
||||
async def run_rpm(
|
||||
args: list[str],
|
||||
sudo: bool = False,
|
||||
ec: ExecContext | None = None,
|
||||
mode: InputMode = InputMode.OptInteractive,
|
||||
**kwargs,
|
||||
) -> str: # export
|
||||
cmd = ['/usr/bin/rpm']
|
||||
cmd.extend(args)
|
||||
if sudo:
|
||||
return await run_sudo(cmd, ec=ec, cmd_input=mode, **kwargs)
|
||||
return await run_cmd(cmd, ec=ec, cmd_input=mode, **kwargs)
|
||||
result = (
|
||||
await run_sudo(cmd, ec = ec, cmd_input = mode, **kwargs)
|
||||
if sudo else await run_cmd(cmd, ec = ec, cmd_input = mode, **kwargs)
|
||||
)
|
||||
return result.stdout_str
|
||||
|
||||
async def query_packages(names: Iterable[str] = [], ec: ExecContext=None) -> Iterable[Package]:
|
||||
fmt_str = '|'.join([(f'%{{{tag}}}' if tag else '') for tag in meta_map().values()]) + r'\n'
|
||||
async def query_packages(
|
||||
names: Iterable[str] = [],
|
||||
ec: ExecContext | None = None,
|
||||
) -> Iterable[Package]: # export
|
||||
fmt_str = (
|
||||
'|'.join([(f'%{{{tag}}}' if tag else '')
|
||||
for tag in meta_map().values()]) + r'\n'
|
||||
)
|
||||
opts = ['-q', '--queryformat', fmt_str]
|
||||
if not names:
|
||||
opts.append('-a')
|
||||
specs, stderr, status = await run_rpm([*opts, *names], throw=True, sudo=False, mode=InputMode.NonInteractive, ec=ec)
|
||||
return Package.parse_specs_str(specs.decode())
|
||||
specs = await run_rpm(
|
||||
[*opts, *names],
|
||||
throw = True,
|
||||
sudo = False,
|
||||
mode = InputMode.NonInteractive,
|
||||
ec = ec
|
||||
)
|
||||
return Package.parse_specs_str(specs)
|
||||
|
||||
async def list_files(pkg: str, ec: ExecContext=None) -> list[str]:
|
||||
stdout, stderr, status = await run_rpm(['-ql', pkg], throw=True, sudo=False, mode=InputMode.NonInteractive, ec=ec)
|
||||
return stdout.decode().splitlines()
|
||||
async def list_files(pkg: str, ec: ExecContext | None = None) -> list[str]:
|
||||
stdout = await run_rpm(
|
||||
['-ql', pkg],
|
||||
throw = True,
|
||||
sudo = False,
|
||||
mode = InputMode.NonInteractive,
|
||||
ec = ec
|
||||
)
|
||||
return stdout.splitlines()
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue