Format code with Black

Author: UniversalSuperBox

README.md

@@ -34,3 +34,8 @@ optional arguments:
 | `sudo ubports-qa remove xenial_-_somebranch` | Remove the `xenial_-_somebranch` ppa and upgrade all packages |
 | `ubports-qa list` | List all installed testing-PPAs |
 | `sudo ubports-qa update` | Upgrade all packages |
+
+
+### Contributing
+
+When modifying the ubports-qa script, run [black](https://github.com/ambv/black) before you commit. This helps to reduce the diffs between commits and keeps formatting simple.

ubports-qa

@@ -14,14 +14,16 @@ import requests
 GITHUB_API_PULLREQUEST = "https://api.github.com/repos/ubports/{repo}/pulls/{num}"
 JENKINS_API_BUILD = "https://ci.ubports.com/blue/rest/organizations/jenkins/pipelines/{repo}/branches/{ref}"
 
-IS_ROOT = (os.geteuid() == 0)
+IS_ROOT = os.geteuid() == 0
+
 
 class Status(Enum):
     SUCCESS = 1
     BULDING = 2
     FAILED = 3
 
-class WritableRootFS():
+
+class WritableRootFS:
     """
     A class to be used with the `with` statement to mount `/` read-write, for example::
 
@@ -31,6 +33,7 @@ class WritableRootFS():
     `/` will be remounted read-only on close, unless the file /userdata/.writable_image
     exists.
     """
+
     def __enter__(self):
         self.attempt_writable_mount()
 
@@ -54,35 +57,45 @@ class WritableRootFS():
                 print_error("Failed to remount root filesystem read-only.")
                 print_error("Please consider rebooting your device.")
 
+
 def ensure_root():
     if not IS_ROOT:
         die("Insufficient permissions, please run with sudo.")
 
+
 def apt_update():
     try:
         subprocess.run(["apt", "update"], check=True)
     except subprocess.CalledProcessError:
         print_error("Failed to run 'apt update'. See the output above for details.")
 
+
 def apt_upgrade():
     try:
         subprocess.run(["apt", "upgrade"], check=True)
     except subprocess.CalledProcessError:
         print_error("Failed to run 'apt upgrade'. See the output above for details.")
 
+
 def get_list_file(branch):
     return "/etc/apt/sources.list.d/ubports-{}.list".format(branch)
 
+
 def get_pref_file(branch):
     return "/etc/apt/preferences.d/ubports-{}.pref".format(branch)
 
+
 def list_exists(branch):
     return os.path.isfile(get_list_file(branch))
 
+
 def list_lists():
-    return [f.split("ubports-")[1].split(".list")[0]
-            for f in os.listdir("/etc/apt/preferences.d")
-            if os.path.isfile(f) and f.startswith("ubports-")]
+    return [
+        f.split("ubports-")[1].split(".list")[0]
+        for f in os.listdir("/etc/apt/preferences.d")
+        if os.path.isfile(f) and f.startswith("ubports-")
+    ]
+
 
 def add_list(branch):
     if list_exists(branch):
@@ -92,24 +105,28 @@ def add_list(branch):
     with open(get_list_file(branch), "w+") as repo_list:
         repo_list.write("deb http://repo.ubports.com/ {} main".format(branch))
 
+
 def remove_list(branch):
     # If it does not exist, just ignore
     if not list_exists(branch):
         return
     os.remove(get_list_file(branch))
 
+
 def get_github_pr(repo, num):
     ret = requests.get(GITHUB_API_PULLREQUEST.format(repo=repo, num=num))
     if ret.status_code != 200:
         die("Pull-Request not found")
     return ret.json()
 
+
 def get_jenkins_build(repo, ref):
     ret = requests.get(JENKINS_API_BUILD.format(repo=repo, ref=ref))
     if ret.status_code != 200:
         die("Jenkins build not found")
     return ret.json()
 
+
 def get_issue_status(repo, ref):
     build = get_jenkins_build(repo, ref)["latestRun"]
     print(build)
@@ -120,18 +137,22 @@ def get_issue_status(repo, ref):
 
     return Status.FAILED
 
+
 def get_issue_branch(repo, num):
     return get_github_pr(repo, num)["head"]["ref"]
 
+
 def print_error(error_message):
     """Prints error_message in red"""
-    print('\033[91m' + error_message + '\033[0m')
+    print("\033[91m" + error_message + "\033[0m")
+
 
 def die(error_message):
     """Prints error_message in red and exits with status 3"""
     print_error(error_message)
     exit(3)
 
+
 def install_command(args):
     """Install a PPA or Pull Request"""
     if args.pr != -1:
@@ -147,6 +168,7 @@ def install_command(args):
         apt_update()
         apt_upgrade()
 
+
 def remove_command(args):
     """Remove and uninstall a PPA"""
     if not list_exists(args.repo):
@@ -156,32 +178,57 @@ def remove_command(args):
         apt_update()
         apt_upgrade()
 
+
 def list_command(args):
     """List installed PPAs"""
     print(" ".join(list_lists()))
 
+
 def update_command(args):
     """Update all packages using apt"""
     with WritableRootFS():
         apt_update()
         apt_upgrade()
 
-parser = argparse.ArgumentParser(description='The UBports QA scripts allow you to efficiently manage PPAs from repo.ubports.com for testing deb components. See http://docs.ubports.com/en/latest/about/process/ppa.html.')
-subparsers = parser.add_subparsers(help='')
 
-parser_install = subparsers.add_parser('install', help=install_command.__doc__, description='Install a ppa or pull-request. See http://docs.ubports.com/en/latest/about/process/ppa.html.')
-parser_install.add_argument('repo', type=str, help='Name of a PPA on repo.ubports.com. Alternatively, if the \'pr\' argument is provided, the name of a git repository can be specified to automatically add the PPA from a pull-request.')
-parser_install.add_argument('pr', type=int, help='Numeric ID of a pull-request on the git repository specified in the \'repo\' argument. If \'repo\' is supposed to be the name of a ppa, the \'pr\' argument should not be specified.', nargs='?', default=-1)
+parser = argparse.ArgumentParser(
+    description="The UBports QA scripts allow you to efficiently manage PPAs from repo.ubports.com for testing deb components. See http://docs.ubports.com/en/latest/about/process/ppa.html."
+)
+subparsers = parser.add_subparsers(help="")
+
+parser_install = subparsers.add_parser(
+    "install",
+    help=install_command.__doc__,
+    description="Install a ppa or pull-request. See http://docs.ubports.com/en/latest/about/process/ppa.html.",
+)
+parser_install.add_argument(
+    "repo",
+    type=str,
+    help="Name of a PPA on repo.ubports.com. Alternatively, if the 'pr' argument is provided, the name of a git repository can be specified to automatically add the PPA from a pull-request.",
+)
+parser_install.add_argument(
+    "pr",
+    type=int,
+    help="Numeric ID of a pull-request on the git repository specified in the 'repo' argument. If 'repo' is supposed to be the name of a ppa, the 'pr' argument should not be specified.",
+    nargs="?",
+    default=-1,
+)
 parser_install.set_defaults(func=install_command)
 
-parser_remove = subparsers.add_parser('remove', help=remove_command.__doc__, description='Remove and uninstall a ppa')
-parser_remove.add_argument('repo', type=str, help='Name of the ppa')
+parser_remove = subparsers.add_parser(
+    "remove", help=remove_command.__doc__, description="Remove and uninstall a ppa"
+)
+parser_remove.add_argument("repo", type=str, help="Name of the ppa")
 parser_remove.set_defaults(func=remove_command)
 
-parser_list = subparsers.add_parser('list', help=list_command.__doc__, description='List installed PPAs')
+parser_list = subparsers.add_parser(
+    "list", help=list_command.__doc__, description="List installed PPAs"
+)
 parser_list.set_defaults(func=list_command)
 
-parser_update = subparsers.add_parser('update', help=update_command.__doc__, description='Update all packages using apt')
+parser_update = subparsers.add_parser(
+    "update", help=update_command.__doc__, description="Update all packages using apt"
+)
 parser_update.set_defaults(func=update_command)
 
 try: