mirror of
https://github.com/u-boot/u-boot.git
synced 2025-04-21 04:14:34 +00:00
u_boot_pylib: Clean up pylint warnings in gitutil.py
This file has about 40 pylint warnings, but no errors. Quite a few of these warnings have been there for a while, but most are coming from newer versions of pylint, where people come up with new warnings. The f-string warning is the most common one: C0209: Formatting a regular string which could be an f-string That feature was not available when the code was written, but it is often more convenient than using % with a list of arguments. This patches reduces the number of warnings in this file, with 7 left remaining. Signed-off-by: Simon Glass <sjg@chromium.org>
This commit is contained in:
parent
9b4b86f90c
commit
3703298e57
2 changed files with 128 additions and 116 deletions
|
@ -288,11 +288,11 @@ class TestFunctional(unittest.TestCase):
|
||||||
"""Test gitutils.Setup(), from outside the module itself"""
|
"""Test gitutils.Setup(), from outside the module itself"""
|
||||||
command.TEST_RESULT = command.CommandResult(return_code=1)
|
command.TEST_RESULT = command.CommandResult(return_code=1)
|
||||||
gitutil.setup()
|
gitutil.setup()
|
||||||
self.assertEqual(gitutil.use_no_decorate, False)
|
self.assertEqual(gitutil.USE_NO_DECORATE, False)
|
||||||
|
|
||||||
command.TEST_RESULT = command.CommandResult(return_code=0)
|
command.TEST_RESULT = command.CommandResult(return_code=0)
|
||||||
gitutil.setup()
|
gitutil.setup()
|
||||||
self.assertEqual(gitutil.use_no_decorate, True)
|
self.assertEqual(gitutil.USE_NO_DECORATE, True)
|
||||||
|
|
||||||
def _HandleCommandGitLog(self, args):
|
def _HandleCommandGitLog(self, args):
|
||||||
if args[-1] == '--':
|
if args[-1] == '--':
|
||||||
|
|
|
@ -10,7 +10,7 @@ from u_boot_pylib import command
|
||||||
from u_boot_pylib import terminal
|
from u_boot_pylib import terminal
|
||||||
|
|
||||||
# True to use --no-decorate - we check this in setup()
|
# True to use --no-decorate - we check this in setup()
|
||||||
use_no_decorate = True
|
USE_NO_DECORATE = True
|
||||||
|
|
||||||
|
|
||||||
def log_cmd(commit_range, git_dir=None, oneline=False, reverse=False,
|
def log_cmd(commit_range, git_dir=None, oneline=False, reverse=False,
|
||||||
|
@ -18,11 +18,11 @@ def log_cmd(commit_range, git_dir=None, oneline=False, reverse=False,
|
||||||
"""Create a command to perform a 'git log'
|
"""Create a command to perform a 'git log'
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
commit_range: Range expression to use for log, None for none
|
commit_range (str): Range expression to use for log, None for none
|
||||||
git_dir: Path to git repository (None to use default)
|
git_dir (str): Path to git repository (None to use default)
|
||||||
oneline: True to use --oneline, else False
|
oneline (bool): True to use --oneline, else False
|
||||||
reverse: True to reverse the log (--reverse)
|
reverse (bool): True to reverse the log (--reverse)
|
||||||
count: Number of commits to list, or None for no limit
|
count (int or None): Number of commits to list, or None for no limit
|
||||||
Return:
|
Return:
|
||||||
List containing command and arguments to run
|
List containing command and arguments to run
|
||||||
"""
|
"""
|
||||||
|
@ -32,12 +32,12 @@ def log_cmd(commit_range, git_dir=None, oneline=False, reverse=False,
|
||||||
cmd += ['--no-pager', 'log', '--no-color']
|
cmd += ['--no-pager', 'log', '--no-color']
|
||||||
if oneline:
|
if oneline:
|
||||||
cmd.append('--oneline')
|
cmd.append('--oneline')
|
||||||
if use_no_decorate:
|
if USE_NO_DECORATE:
|
||||||
cmd.append('--no-decorate')
|
cmd.append('--no-decorate')
|
||||||
if reverse:
|
if reverse:
|
||||||
cmd.append('--reverse')
|
cmd.append('--reverse')
|
||||||
if count is not None:
|
if count is not None:
|
||||||
cmd.append('-n%d' % count)
|
cmd.append(f'-n{count}')
|
||||||
if commit_range:
|
if commit_range:
|
||||||
cmd.append(commit_range)
|
cmd.append(commit_range)
|
||||||
|
|
||||||
|
@ -55,22 +55,22 @@ def count_commits_to_branch(branch):
|
||||||
since then.
|
since then.
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
branch: Branch to count from (None for current branch)
|
branch (str or None): Branch to count from (None for current branch)
|
||||||
|
|
||||||
Return:
|
Return:
|
||||||
Number of patches that exist on top of the branch
|
Number of patches that exist on top of the branch
|
||||||
"""
|
"""
|
||||||
if branch:
|
if branch:
|
||||||
us, msg = get_upstream('.git', branch)
|
us, _ = get_upstream('.git', branch)
|
||||||
rev_range = '%s..%s' % (us, branch)
|
rev_range = f'{us}..{branch}'
|
||||||
else:
|
else:
|
||||||
rev_range = '@{upstream}..'
|
rev_range = '@{upstream}..'
|
||||||
cmd = log_cmd(rev_range, oneline=True)
|
cmd = log_cmd(rev_range, oneline=True)
|
||||||
result = command.run_one(*cmd, capture=True, capture_stderr=True,
|
result = command.run_one(*cmd, capture=True, capture_stderr=True,
|
||||||
oneline=True, raise_on_error=False)
|
oneline=True, raise_on_error=False)
|
||||||
if result.return_code:
|
if result.return_code:
|
||||||
raise ValueError('Failed to determine upstream: %s' %
|
raise ValueError(
|
||||||
result.stderr.strip())
|
f'Failed to determine upstream: {result.stderr.strip()}')
|
||||||
patch_count = len(result.stdout.splitlines())
|
patch_count = len(result.stdout.splitlines())
|
||||||
return patch_count
|
return patch_count
|
||||||
|
|
||||||
|
@ -79,7 +79,7 @@ def name_revision(commit_hash):
|
||||||
"""Gets the revision name for a commit
|
"""Gets the revision name for a commit
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
commit_hash: Commit hash to look up
|
commit_hash (str): Commit hash to look up
|
||||||
|
|
||||||
Return:
|
Return:
|
||||||
Name of revision, if any, else None
|
Name of revision, if any, else None
|
||||||
|
@ -99,8 +99,8 @@ def guess_upstream(git_dir, branch):
|
||||||
'git name-rev' returns a plain branch name, with no ! or ^ modifiers.
|
'git name-rev' returns a plain branch name, with no ! or ^ modifiers.
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
git_dir: Git directory containing repo
|
git_dir (str): Git directory containing repo
|
||||||
branch: Name of branch
|
branch (str): Name of branch
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
Tuple:
|
Tuple:
|
||||||
|
@ -111,23 +111,23 @@ def guess_upstream(git_dir, branch):
|
||||||
result = command.run_one(*cmd, capture=True, capture_stderr=True,
|
result = command.run_one(*cmd, capture=True, capture_stderr=True,
|
||||||
raise_on_error=False)
|
raise_on_error=False)
|
||||||
if result.return_code:
|
if result.return_code:
|
||||||
return None, "Branch '%s' not found" % branch
|
return None, f"Branch '{branch}' not found"
|
||||||
for line in result.stdout.splitlines()[1:]:
|
for line in result.stdout.splitlines()[1:]:
|
||||||
commit_hash = line.split(' ')[0]
|
commit_hash = line.split(' ')[0]
|
||||||
name = name_revision(commit_hash)
|
name = name_revision(commit_hash)
|
||||||
if '~' not in name and '^' not in name:
|
if '~' not in name and '^' not in name:
|
||||||
if name.startswith('remotes/'):
|
if name.startswith('remotes/'):
|
||||||
name = name[8:]
|
name = name[8:]
|
||||||
return name, "Guessing upstream as '%s'" % name
|
return name, f"Guessing upstream as '{name}'"
|
||||||
return None, "Cannot find a suitable upstream for branch '%s'" % branch
|
return None, f"Cannot find a suitable upstream for branch '{branch}'"
|
||||||
|
|
||||||
|
|
||||||
def get_upstream(git_dir, branch):
|
def get_upstream(git_dir, branch):
|
||||||
"""Returns the name of the upstream for a branch
|
"""Returns the name of the upstream for a branch
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
git_dir: Git directory containing repo
|
git_dir (str): Git directory containing repo
|
||||||
branch: Name of branch
|
branch (str): Name of branch
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
Tuple:
|
Tuple:
|
||||||
|
@ -136,31 +136,30 @@ def get_upstream(git_dir, branch):
|
||||||
"""
|
"""
|
||||||
try:
|
try:
|
||||||
remote = command.output_one_line('git', '--git-dir', git_dir, 'config',
|
remote = command.output_one_line('git', '--git-dir', git_dir, 'config',
|
||||||
'branch.%s.remote' % branch)
|
f'branch.{branch}.remote')
|
||||||
merge = command.output_one_line('git', '--git-dir', git_dir, 'config',
|
merge = command.output_one_line('git', '--git-dir', git_dir, 'config',
|
||||||
'branch.%s.merge' % branch)
|
f'branch.{branch}.merge')
|
||||||
except command.CommandExc:
|
except command.CommandExc:
|
||||||
upstream, msg = guess_upstream(git_dir, branch)
|
upstream, msg = guess_upstream(git_dir, branch)
|
||||||
return upstream, msg
|
return upstream, msg
|
||||||
|
|
||||||
if remote == '.':
|
if remote == '.':
|
||||||
return merge, None
|
return merge, None
|
||||||
elif remote and merge:
|
if remote and merge:
|
||||||
# Drop the initial refs/heads from merge
|
# Drop the initial refs/heads from merge
|
||||||
leaf = merge.split('/', maxsplit=2)[2:]
|
leaf = merge.split('/', maxsplit=2)[2:]
|
||||||
return '%s/%s' % (remote, '/'.join(leaf)), None
|
return f'{remote}/{"/".join(leaf)}', None
|
||||||
else:
|
raise ValueError("Cannot determine upstream branch for branch "
|
||||||
raise ValueError("Cannot determine upstream branch for branch "
|
f"'{branch}' remote='{remote}', merge='{merge}'")
|
||||||
"'%s' remote='%s', merge='%s'"
|
|
||||||
% (branch, remote, merge))
|
|
||||||
|
|
||||||
|
|
||||||
def get_range_in_branch(git_dir, branch, include_upstream=False):
|
def get_range_in_branch(git_dir, branch, include_upstream=False):
|
||||||
"""Returns an expression for the commits in the given branch.
|
"""Returns an expression for the commits in the given branch.
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
git_dir: Directory containing git repo
|
git_dir (str): Directory containing git repo
|
||||||
branch: Name of branch
|
branch (str): Name of branch
|
||||||
|
include_upstream (bool): Include the upstream commit as well
|
||||||
Return:
|
Return:
|
||||||
Expression in the form 'upstream..branch' which can be used to
|
Expression in the form 'upstream..branch' which can be used to
|
||||||
access the commits. If the branch does not exist, returns None.
|
access the commits. If the branch does not exist, returns None.
|
||||||
|
@ -168,7 +167,7 @@ def get_range_in_branch(git_dir, branch, include_upstream=False):
|
||||||
upstream, msg = get_upstream(git_dir, branch)
|
upstream, msg = get_upstream(git_dir, branch)
|
||||||
if not upstream:
|
if not upstream:
|
||||||
return None, msg
|
return None, msg
|
||||||
rstr = '%s%s..%s' % (upstream, '~' if include_upstream else '', branch)
|
rstr = f"{upstream}{'~' if include_upstream else ''}..{branch}"
|
||||||
return rstr, msg
|
return rstr, msg
|
||||||
|
|
||||||
|
|
||||||
|
@ -176,8 +175,8 @@ def count_commits_in_range(git_dir, range_expr):
|
||||||
"""Returns the number of commits in the given range.
|
"""Returns the number of commits in the given range.
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
git_dir: Directory containing git repo
|
git_dir (str): Directory containing git repo
|
||||||
range_expr: Range to check
|
range_expr (str): Range to check
|
||||||
Return:
|
Return:
|
||||||
Number of patches that exist in the supplied range or None if none
|
Number of patches that exist in the supplied range or None if none
|
||||||
were found
|
were found
|
||||||
|
@ -186,7 +185,7 @@ def count_commits_in_range(git_dir, range_expr):
|
||||||
result = command.run_one(*cmd, capture=True, capture_stderr=True,
|
result = command.run_one(*cmd, capture=True, capture_stderr=True,
|
||||||
raise_on_error=False)
|
raise_on_error=False)
|
||||||
if result.return_code:
|
if result.return_code:
|
||||||
return None, "Range '%s' not found or is invalid" % range_expr
|
return None, f"Range '{range_expr}' not found or is invalid"
|
||||||
patch_count = len(result.stdout.splitlines())
|
patch_count = len(result.stdout.splitlines())
|
||||||
return patch_count, None
|
return patch_count, None
|
||||||
|
|
||||||
|
@ -195,8 +194,9 @@ def count_commits_in_branch(git_dir, branch, include_upstream=False):
|
||||||
"""Returns the number of commits in the given branch.
|
"""Returns the number of commits in the given branch.
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
git_dir: Directory containing git repo
|
git_dir (str): Directory containing git repo
|
||||||
branch: Name of branch
|
branch (str): Name of branch
|
||||||
|
include_upstream (bool): Include the upstream commit as well
|
||||||
Return:
|
Return:
|
||||||
Number of patches that exist on top of the branch, or None if the
|
Number of patches that exist on top of the branch, or None if the
|
||||||
branch does not exist.
|
branch does not exist.
|
||||||
|
@ -211,7 +211,7 @@ def count_commits(commit_range):
|
||||||
"""Returns the number of commits in the given range.
|
"""Returns the number of commits in the given range.
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
commit_range: Range of commits to count (e.g. 'HEAD..base')
|
commit_range (str): Range of commits to count (e.g. 'HEAD..base')
|
||||||
Return:
|
Return:
|
||||||
Number of patches that exist on top of the branch
|
Number of patches that exist on top of the branch
|
||||||
"""
|
"""
|
||||||
|
@ -226,7 +226,10 @@ def checkout(commit_hash, git_dir=None, work_tree=None, force=False):
|
||||||
"""Checkout the selected commit for this build
|
"""Checkout the selected commit for this build
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
commit_hash: Commit hash to check out
|
commit_hash (str): Commit hash to check out
|
||||||
|
git_dir (str): Directory containing git repo, or None for current dir
|
||||||
|
work_tree (str): Git worktree to use, or None if none
|
||||||
|
force (bool): True to force the checkout (git checkout -f)
|
||||||
"""
|
"""
|
||||||
pipe = ['git']
|
pipe = ['git']
|
||||||
if git_dir:
|
if git_dir:
|
||||||
|
@ -240,26 +243,28 @@ def checkout(commit_hash, git_dir=None, work_tree=None, force=False):
|
||||||
result = command.run_pipe([pipe], capture=True, raise_on_error=False,
|
result = command.run_pipe([pipe], capture=True, raise_on_error=False,
|
||||||
capture_stderr=True)
|
capture_stderr=True)
|
||||||
if result.return_code != 0:
|
if result.return_code != 0:
|
||||||
raise OSError('git checkout (%s): %s' % (pipe, result.stderr))
|
raise OSError(f'git checkout ({pipe}): {result.stderr}')
|
||||||
|
|
||||||
|
|
||||||
def clone(git_dir, output_dir):
|
def clone(repo, output_dir):
|
||||||
"""Checkout the selected commit for this build
|
"""Clone a repo
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
commit_hash: Commit hash to check out
|
repo (str): Repo to clone (e.g. web address)
|
||||||
|
output_dir (str): Directory to close into
|
||||||
"""
|
"""
|
||||||
result = command.run_one('git', 'clone', git_dir, '.', capture=True,
|
result = command.run_one('git', 'clone', repo, '.', capture=True,
|
||||||
cwd=output_dir, capture_stderr=True)
|
cwd=output_dir, capture_stderr=True)
|
||||||
if result.return_code != 0:
|
if result.return_code != 0:
|
||||||
raise OSError('git clone: %s' % result.stderr)
|
raise OSError(f'git clone: {result.stderr}')
|
||||||
|
|
||||||
|
|
||||||
def fetch(git_dir=None, work_tree=None):
|
def fetch(git_dir=None, work_tree=None):
|
||||||
"""Fetch from the origin repo
|
"""Fetch from the origin repo
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
commit_hash: Commit hash to check out
|
git_dir (str): Directory containing git repo, or None for current dir
|
||||||
|
work_tree (str or None): Git worktree to use, or None if none
|
||||||
"""
|
"""
|
||||||
cmd = ['git']
|
cmd = ['git']
|
||||||
if git_dir:
|
if git_dir:
|
||||||
|
@ -269,14 +274,14 @@ def fetch(git_dir=None, work_tree=None):
|
||||||
cmd.append('fetch')
|
cmd.append('fetch')
|
||||||
result = command.run_one(*cmd, capture=True, capture_stderr=True)
|
result = command.run_one(*cmd, capture=True, capture_stderr=True)
|
||||||
if result.return_code != 0:
|
if result.return_code != 0:
|
||||||
raise OSError('git fetch: %s' % result.stderr)
|
raise OSError(f'git fetch: {result.stderr}')
|
||||||
|
|
||||||
|
|
||||||
def check_worktree_is_available(git_dir):
|
def check_worktree_is_available(git_dir):
|
||||||
"""Check if git-worktree functionality is available
|
"""Check if git-worktree functionality is available
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
git_dir: The repository to test in
|
git_dir (str): The repository to test in
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
True if git-worktree commands will work, False otherwise.
|
True if git-worktree commands will work, False otherwise.
|
||||||
|
@ -291,9 +296,9 @@ def add_worktree(git_dir, output_dir, commit_hash=None):
|
||||||
"""Create and checkout a new git worktree for this build
|
"""Create and checkout a new git worktree for this build
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
git_dir: The repository to checkout the worktree from
|
git_dir (str): The repository to checkout the worktree from
|
||||||
output_dir: Path for the new worktree
|
output_dir (str): Path for the new worktree
|
||||||
commit_hash: Commit hash to checkout
|
commit_hash (str): Commit hash to checkout
|
||||||
"""
|
"""
|
||||||
# We need to pass --detach to avoid creating a new branch
|
# We need to pass --detach to avoid creating a new branch
|
||||||
cmd = ['git', '--git-dir', git_dir, 'worktree', 'add', '.', '--detach']
|
cmd = ['git', '--git-dir', git_dir, 'worktree', 'add', '.', '--detach']
|
||||||
|
@ -302,19 +307,19 @@ def add_worktree(git_dir, output_dir, commit_hash=None):
|
||||||
result = command.run_one(*cmd, capture=True, cwd=output_dir,
|
result = command.run_one(*cmd, capture=True, cwd=output_dir,
|
||||||
capture_stderr=True)
|
capture_stderr=True)
|
||||||
if result.return_code != 0:
|
if result.return_code != 0:
|
||||||
raise OSError('git worktree add: %s' % result.stderr)
|
raise OSError(f'git worktree add: {result.stderr}')
|
||||||
|
|
||||||
|
|
||||||
def prune_worktrees(git_dir):
|
def prune_worktrees(git_dir):
|
||||||
"""Remove administrative files for deleted worktrees
|
"""Remove administrative files for deleted worktrees
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
git_dir: The repository whose deleted worktrees should be pruned
|
git_dir (str): The repository whose deleted worktrees should be pruned
|
||||||
"""
|
"""
|
||||||
result = command.run_one('git', '--git-dir', git_dir, 'worktree', 'prune',
|
result = command.run_one('git', '--git-dir', git_dir, 'worktree', 'prune',
|
||||||
capture=True, capture_stderr=True)
|
capture=True, capture_stderr=True)
|
||||||
if result.return_code != 0:
|
if result.return_code != 0:
|
||||||
raise OSError('git worktree prune: %s' % result.stderr)
|
raise OSError(f'git worktree prune: {result.stderr}')
|
||||||
|
|
||||||
|
|
||||||
def create_patches(branch, start, count, ignore_binary, series, signoff=True):
|
def create_patches(branch, start, count, ignore_binary, series, signoff=True):
|
||||||
|
@ -324,11 +329,12 @@ def create_patches(branch, start, count, ignore_binary, series, signoff=True):
|
||||||
git format-patch.
|
git format-patch.
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
branch: Branch to create patches from (None for current branch)
|
branch (str): Branch to create patches from (None for current branch)
|
||||||
start: Commit to start from: 0=HEAD, 1=next one, etc.
|
start (int): Commit to start from: 0=HEAD, 1=next one, etc.
|
||||||
count: number of commits to include
|
count (int): number of commits to include
|
||||||
ignore_binary: Don't generate patches for binary files
|
ignore_binary (bool): Don't generate patches for binary files
|
||||||
series: Series object for this series (set of patches)
|
series (Series): Series object for this series (set of patches)
|
||||||
|
signoff (bool): True to add signoff lines automatically
|
||||||
Return:
|
Return:
|
||||||
Filename of cover letter (None if none)
|
Filename of cover letter (None if none)
|
||||||
List of filenames of patch files
|
List of filenames of patch files
|
||||||
|
@ -342,9 +348,9 @@ def create_patches(branch, start, count, ignore_binary, series, signoff=True):
|
||||||
cmd.append('--cover-letter')
|
cmd.append('--cover-letter')
|
||||||
prefix = series.GetPatchPrefix()
|
prefix = series.GetPatchPrefix()
|
||||||
if prefix:
|
if prefix:
|
||||||
cmd += ['--subject-prefix=%s' % prefix]
|
cmd += [f'--subject-prefix={prefix}']
|
||||||
brname = branch or 'HEAD'
|
brname = branch or 'HEAD'
|
||||||
cmd += ['%s~%d..%s~%d' % (brname, start + count, brname, start)]
|
cmd += [f'{brname}~{start + count}..{brname}~{start}']
|
||||||
|
|
||||||
stdout = command.run_list(cmd)
|
stdout = command.run_list(cmd)
|
||||||
files = stdout.splitlines()
|
files = stdout.splitlines()
|
||||||
|
@ -352,8 +358,7 @@ def create_patches(branch, start, count, ignore_binary, series, signoff=True):
|
||||||
# We have an extra file if there is a cover letter
|
# We have an extra file if there is a cover letter
|
||||||
if series.get('cover'):
|
if series.get('cover'):
|
||||||
return files[0], files[1:]
|
return files[0], files[1:]
|
||||||
else:
|
return None, files
|
||||||
return None, files
|
|
||||||
|
|
||||||
|
|
||||||
def build_email_list(in_list, tag=None, alias=None, warn_on_error=True):
|
def build_email_list(in_list, tag=None, alias=None, warn_on_error=True):
|
||||||
|
@ -367,11 +372,13 @@ def build_email_list(in_list, tag=None, alias=None, warn_on_error=True):
|
||||||
command line parameter) then the email address is quoted.
|
command line parameter) then the email address is quoted.
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
in_list: List of aliases/email addresses
|
in_list (list of str): List of aliases/email addresses
|
||||||
tag: Text to put before each address
|
tag (str): Text to put before each address
|
||||||
alias: Alias dictionary
|
alias (dict): Alias dictionary:
|
||||||
warn_on_error: True to raise an error when an alias fails to match,
|
key: alias
|
||||||
False to just print a message.
|
value: list of aliases or email addresses
|
||||||
|
warn_on_error (bool): True to raise an error when an alias fails to
|
||||||
|
match, False to just print a message.
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
List of email addresses
|
List of email addresses
|
||||||
|
@ -399,7 +406,7 @@ def build_email_list(in_list, tag=None, alias=None, warn_on_error=True):
|
||||||
if item not in result:
|
if item not in result:
|
||||||
result.append(item)
|
result.append(item)
|
||||||
if tag:
|
if tag:
|
||||||
return ['%s %s%s%s' % (tag, quote, email, quote) for email in result]
|
return [f'{tag} {quote}{email}{quote}' for email in result]
|
||||||
return result
|
return result
|
||||||
|
|
||||||
|
|
||||||
|
@ -407,24 +414,23 @@ def check_suppress_cc_config():
|
||||||
"""Check if sendemail.suppresscc is configured correctly.
|
"""Check if sendemail.suppresscc is configured correctly.
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
True if the option is configured correctly, False otherwise.
|
bool: True if the option is configured correctly, False otherwise.
|
||||||
"""
|
"""
|
||||||
suppresscc = command.output_one_line(
|
suppresscc = command.output_one_line(
|
||||||
'git', 'config', 'sendemail.suppresscc', raise_on_error=False)
|
'git', 'config', 'sendemail.suppresscc', raise_on_error=False)
|
||||||
|
|
||||||
# Other settings should be fine.
|
# Other settings should be fine.
|
||||||
if suppresscc == 'all' or suppresscc == 'cccmd':
|
if suppresscc in ('all', 'cccmd'):
|
||||||
col = terminal.Color()
|
col = terminal.Color()
|
||||||
|
|
||||||
print((col.build(col.RED, "error") +
|
print(col.build(col.RED, 'error') +
|
||||||
": git config sendemail.suppresscc set to %s\n"
|
f': git config sendemail.suppresscc set to {suppresscc}\n' +
|
||||||
% (suppresscc)) +
|
' patman needs --cc-cmd to be run to set the cc list.\n' +
|
||||||
" patman needs --cc-cmd to be run to set the cc list.\n" +
|
' Please run:\n' +
|
||||||
" Please run:\n" +
|
' git config --unset sendemail.suppresscc\n' +
|
||||||
" git config --unset sendemail.suppresscc\n" +
|
' Or read the man page:\n' +
|
||||||
" Or read the man page:\n" +
|
' git send-email --help\n' +
|
||||||
" git send-email --help\n" +
|
' and set an option that runs --cc-cmd\n')
|
||||||
" and set an option that runs --cc-cmd\n")
|
|
||||||
return False
|
return False
|
||||||
|
|
||||||
return True
|
return True
|
||||||
|
@ -432,24 +438,26 @@ def check_suppress_cc_config():
|
||||||
|
|
||||||
def email_patches(series, cover_fname, args, dry_run, warn_on_error, cc_fname,
|
def email_patches(series, cover_fname, args, dry_run, warn_on_error, cc_fname,
|
||||||
self_only=False, alias=None, in_reply_to=None, thread=False,
|
self_only=False, alias=None, in_reply_to=None, thread=False,
|
||||||
smtp_server=None, get_maintainer_script=None):
|
smtp_server=None):
|
||||||
"""Email a patch series.
|
"""Email a patch series.
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
series: Series object containing destination info
|
series (Series): Series object containing destination info
|
||||||
cover_fname: filename of cover letter
|
cover_fname (str or None): filename of cover letter
|
||||||
args: list of filenames of patch files
|
args (list of str): list of filenames of patch files
|
||||||
dry_run: Just return the command that would be run
|
dry_run (bool): Just return the command that would be run
|
||||||
warn_on_error: True to print a warning when an alias fails to match,
|
warn_on_error (bool): True to print a warning when an alias fails to
|
||||||
False to ignore it.
|
match, False to ignore it.
|
||||||
cc_fname: Filename of Cc file for per-commit Cc
|
cc_fname (str): Filename of Cc file for per-commit Cc
|
||||||
self_only: True to just email to yourself as a test
|
self_only (bool): True to just email to yourself as a test
|
||||||
in_reply_to: If set we'll pass this to git as --in-reply-to.
|
alias (dict or None): Alias dictionary: (None to use settings default)
|
||||||
Should be a message ID that this is in reply to.
|
key: alias
|
||||||
thread: True to add --thread to git send-email (make
|
value: list of aliases or email addresses
|
||||||
|
in_reply_to (str or None): If set we'll pass this to git as
|
||||||
|
--in-reply-to - should be a message ID that this is in reply to.
|
||||||
|
thread (bool): True to add --thread to git send-email (make
|
||||||
all patches reply to cover-letter or first patch in series)
|
all patches reply to cover-letter or first patch in series)
|
||||||
smtp_server: SMTP server to use to send patches
|
smtp_server (str or None): SMTP server to use to send patches
|
||||||
get_maintainer_script: File name of script to get maintainers emails
|
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
Git command that was/would be run
|
Git command that was/would be run
|
||||||
|
@ -500,7 +508,7 @@ send --cc-cmd cc-fname" cover p1 p2'
|
||||||
"Series-to: Fred Bloggs <f.blogs@napier.co.nz>\n"
|
"Series-to: Fred Bloggs <f.blogs@napier.co.nz>\n"
|
||||||
"Or do something like this\n"
|
"Or do something like this\n"
|
||||||
"git config sendemail.to u-boot@lists.denx.de")
|
"git config sendemail.to u-boot@lists.denx.de")
|
||||||
return
|
return None
|
||||||
cc = build_email_list(list(set(series.get('cc')) - set(series.get('to'))),
|
cc = build_email_list(list(set(series.get('cc')) - set(series.get('to'))),
|
||||||
'--cc', alias, warn_on_error)
|
'--cc', alias, warn_on_error)
|
||||||
if self_only:
|
if self_only:
|
||||||
|
@ -509,15 +517,15 @@ send --cc-cmd cc-fname" cover p1 p2'
|
||||||
cc = []
|
cc = []
|
||||||
cmd = ['git', 'send-email', '--annotate']
|
cmd = ['git', 'send-email', '--annotate']
|
||||||
if smtp_server:
|
if smtp_server:
|
||||||
cmd.append('--smtp-server=%s' % smtp_server)
|
cmd.append(f'--smtp-server={smtp_server}')
|
||||||
if in_reply_to:
|
if in_reply_to:
|
||||||
cmd.append('--in-reply-to="%s"' % in_reply_to)
|
cmd.append(f'--in-reply-to="{in_reply_to}"')
|
||||||
if thread:
|
if thread:
|
||||||
cmd.append('--thread')
|
cmd.append('--thread')
|
||||||
|
|
||||||
cmd += to
|
cmd += to
|
||||||
cmd += cc
|
cmd += cc
|
||||||
cmd += ['--cc-cmd', '"%s send --cc-cmd %s"' % (sys.argv[0], cc_fname)]
|
cmd += ['--cc-cmd', f'"{sys.argv[0]} send --cc-cmd {cc_fname}"']
|
||||||
if cover_fname:
|
if cover_fname:
|
||||||
cmd.append(cover_fname)
|
cmd.append(cover_fname)
|
||||||
cmd += args
|
cmd += args
|
||||||
|
@ -533,10 +541,13 @@ def lookup_email(lookup_name, alias=None, warn_on_error=True, level=0):
|
||||||
TODO: Why not just use git's own alias feature?
|
TODO: Why not just use git's own alias feature?
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
lookup_name: Alias or email address to look up
|
lookup_name (str): Alias or email address to look up
|
||||||
alias: Dictionary containing aliases (None to use settings default)
|
alias (dict or None): Alias dictionary: (None to use settings default)
|
||||||
warn_on_error: True to print a warning when an alias fails to match,
|
key: alias
|
||||||
False to ignore it.
|
value: list of aliases or email addresses
|
||||||
|
warn_on_error (bool): True to print a warning when an alias fails to
|
||||||
|
match, False to ignore it.
|
||||||
|
level (int): Depth of alias stack, used to detect recusion/loops
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
tuple:
|
tuple:
|
||||||
|
@ -589,16 +600,15 @@ def lookup_email(lookup_name, alias=None, warn_on_error=True, level=0):
|
||||||
|
|
||||||
out_list = []
|
out_list = []
|
||||||
if level > 10:
|
if level > 10:
|
||||||
msg = "Recursive email alias at '%s'" % lookup_name
|
msg = f"Recursive email alias at '{lookup_name}'"
|
||||||
if warn_on_error:
|
if warn_on_error:
|
||||||
raise OSError(msg)
|
raise OSError(msg)
|
||||||
else:
|
print(col.build(col.RED, msg))
|
||||||
print(col.build(col.RED, msg))
|
return out_list
|
||||||
return out_list
|
|
||||||
|
|
||||||
if lookup_name:
|
if lookup_name:
|
||||||
if lookup_name not in alias:
|
if lookup_name not in alias:
|
||||||
msg = "Alias '%s' not found" % lookup_name
|
msg = f"Alias '{lookup_name}' not found"
|
||||||
if warn_on_error:
|
if warn_on_error:
|
||||||
print(col.build(col.RED, msg))
|
print(col.build(col.RED, msg))
|
||||||
return out_list
|
return out_list
|
||||||
|
@ -615,7 +625,7 @@ def get_top_level():
|
||||||
"""Return name of top-level directory for this git repo.
|
"""Return name of top-level directory for this git repo.
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
Full path to git top-level directory
|
str: Full path to git top-level directory
|
||||||
|
|
||||||
This test makes sure that we are running tests in the right subdir
|
This test makes sure that we are running tests in the right subdir
|
||||||
|
|
||||||
|
@ -630,7 +640,7 @@ def get_alias_file():
|
||||||
"""Gets the name of the git alias file.
|
"""Gets the name of the git alias file.
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
Filename of git alias file, or None if none
|
str: Filename of git alias file, or None if none
|
||||||
"""
|
"""
|
||||||
fname = command.output_one_line('git', 'config', 'sendemail.aliasesfile',
|
fname = command.output_one_line('git', 'config', 'sendemail.aliasesfile',
|
||||||
raise_on_error=False)
|
raise_on_error=False)
|
||||||
|
@ -650,7 +660,8 @@ def get_default_user_name():
|
||||||
Returns:
|
Returns:
|
||||||
User name found in .gitconfig file, or None if none
|
User name found in .gitconfig file, or None if none
|
||||||
"""
|
"""
|
||||||
uname = command.output_one_line('git', 'config', '--global', '--includes', 'user.name')
|
uname = command.output_one_line('git', 'config', '--global', '--includes',
|
||||||
|
'user.name')
|
||||||
return uname
|
return uname
|
||||||
|
|
||||||
|
|
||||||
|
@ -660,7 +671,8 @@ def get_default_user_email():
|
||||||
Returns:
|
Returns:
|
||||||
User's email found in .gitconfig file, or None if none
|
User's email found in .gitconfig file, or None if none
|
||||||
"""
|
"""
|
||||||
uemail = command.output_one_line('git', 'config', '--global', '--includes', 'user.email')
|
uemail = command.output_one_line('git', 'config', '--global', '--includes',
|
||||||
|
'user.email')
|
||||||
return uemail
|
return uemail
|
||||||
|
|
||||||
|
|
||||||
|
@ -677,15 +689,15 @@ def get_default_subject_prefix():
|
||||||
|
|
||||||
|
|
||||||
def setup():
|
def setup():
|
||||||
"""Set up git utils, by reading the alias files."""
|
"""setup() - Set up git utils, by reading the alias files."""
|
||||||
# Check for a git alias file also
|
# Check for a git alias file also
|
||||||
global use_no_decorate
|
global USE_NO_DECORATE
|
||||||
|
|
||||||
alias_fname = get_alias_file()
|
alias_fname = get_alias_file()
|
||||||
if alias_fname:
|
if alias_fname:
|
||||||
settings.ReadGitAliases(alias_fname)
|
settings.ReadGitAliases(alias_fname)
|
||||||
cmd = log_cmd(None, count=0)
|
cmd = log_cmd(None, count=0)
|
||||||
use_no_decorate = (command.run_one(*cmd, raise_on_error=False)
|
USE_NO_DECORATE = (command.run_one(*cmd, raise_on_error=False)
|
||||||
.return_code == 0)
|
.return_code == 0)
|
||||||
|
|
||||||
|
|
||||||
|
|
Loading…
Add table
Reference in a new issue