dbcli/cli-helpers
1
0
Fork 0
Code Issues Activity

Merging upstream version 2.2.0.

Browse source 
Signed-off-by: Daniel Baumann <daniel@debian.org>
This commit is contained in:
Daniel Baumann 2025-02-07 00:48:48 +01:00
parent ab1302c465
commit 95bca6b33d
Signed by: daniel
GPG key ID: FBB4F0E80A80222F
42 changed files with 1085 additions and 840 deletions
Download patch file Download diff file Expand all files Collapse all files

54
tasks.py
View file

@ -13,7 +13,7 @@ class BaseCommand(Command, object):
user_options = []
default_cmd_options = ('verbose', 'quiet', 'dry_run')
default_cmd_options = ("verbose", "quiet", "dry_run")
def __init__(self, *args, **kwargs):
super(BaseCommand, self).__init__(*args, **kwargs)
@ -40,54 +40,58 @@ class BaseCommand(Command, object):
def apply_options(self, cmd, options=()):
"""Apply command-line options."""
for option in (self.default_cmd_options + options):
cmd = self.apply_option(cmd, option,
active=getattr(self, option, False))
for option in self.default_cmd_options + options:
cmd = self.apply_option(cmd, option, active=getattr(self, option, False))
return cmd
def apply_option(self, cmd, option, active=True):
"""Apply a command-line option."""
return re.sub(r'{{{}\:(?P<option>[^}}]*)}}'.format(option),
r'\g<option>' if active else '', cmd)
return re.sub(
r"{{{}\:(?P<option>[^}}]*)}}".format(option),
r"\g<option>" if active else "",
cmd,
)
class lint(BaseCommand):
"""A PEP 8 lint command that optionally fixes violations."""
description = 'check code against PEP 8 (and fix violations)'
description = "check code against PEP 8 (and fix violations)"
user_options = [
('branch=', 'b', 'branch or revision to compare against (e.g. master)'),
('fix', 'f', 'fix the violations in place')
("branch=", "b", "branch or revision to compare against (e.g. master)"),
("fix", "f", "fix the violations in place"),
]
def initialize_options(self):
"""Set the default options."""
self.branch = 'master'
self.branch = "master"
self.fix = False
super(lint, self).initialize_options()
def run(self):
"""Run the linter."""
cmd = 'pep8radius {branch} {{fix: --in-place}}{{verbose: -vv}}'
cmd = "black ."
cmd = cmd.format(branch=self.branch)
self.call_and_exit(self.apply_options(cmd, ('fix', )))
self.call_and_exit(self.apply_options(cmd, ("fix",)))
class test(BaseCommand):
"""Run the test suites for this project."""
description = 'run the test suite'
description = "run the test suite"
user_options = [
('all', 'a', 'test against all supported versions of Python'),
('coverage', 'c', 'measure test coverage')
("all", "a", "test against all supported versions of Python"),
("coverage", "c", "measure test coverage"),
]
unit_test_cmd = ('pytest{quiet: -q}{verbose: -v}{dry_run: --setup-only}'
'{coverage: --cov-report= --cov=cli_helpers}')
test_all_cmd = 'tox{verbose: -v}{dry_run: --notest}'
coverage_cmd = 'coverage report'
unit_test_cmd = (
"pytest{quiet: -q}{verbose: -v}{dry_run: --setup-only}"
"{coverage: --cov-report= --cov=cli_helpers}"
)
test_all_cmd = "tox{verbose: -v}{dry_run: --notest}"
coverage_cmd = "coverage report"
def initialize_options(self):
"""Set the default options."""
@ -101,20 +105,20 @@ class test(BaseCommand):
cmd = self.apply_options(self.test_all_cmd)
self.call_and_exit(cmd)
else:
cmds = (self.apply_options(self.unit_test_cmd, ('coverage', )), )
cmds = (self.apply_options(self.unit_test_cmd, ("coverage",)),)
if self.coverage:
cmds += (self.apply_options(self.coverage_cmd), )
cmds += (self.apply_options(self.coverage_cmd),)
self.call_in_sequence(cmds)
class docs(BaseCommand):
"""Use Sphinx Makefile to generate documentation."""
description = 'generate the Sphinx HTML documentation'
description = "generate the Sphinx HTML documentation"
clean_docs_cmd = 'make -C docs clean'
html_docs_cmd = 'make -C docs html'
view_docs_cmd = 'open docs/build/html/index.html'
clean_docs_cmd = "make -C docs clean"
html_docs_cmd = "make -C docs html"
view_docs_cmd = "open docs/build/html/index.html"
def run(self):
"""Generate and view the documentation."""