refactor: replace all .format() with f-strings

Author: ninjinkun

.pre-commit-config.yaml

@@ -9,7 +9,7 @@ repos:
     hooks:
     - id: flake8
       args:
-        - --ignore=C901,E741
+        - --ignore=C901,E741,E126
         - --max-line-length=130
         - smart_tests/
         - tests/
@@ -34,5 +34,6 @@ repos:
         - --aggressive
         - --experimental
         - --max-line-length=130
+        - --ignore=E126
         - smart_tests/
         - tests/

pyproject.toml

@@ -49,8 +49,8 @@ dev-dependencies = [
 
 [tool.poe.tasks]
 format = "/bin/bash -c 'isort -l 130 --balanced smart_tests/*.py tests/*.py && autopep8 --in-place --recursive --aggressive --experimental --max-line-length=130 --verbose smart_tests/ tests/'"
-lint = "flake8 --count --ignore=C901,E741,F401 --show-source --max-line-length=130 --statistics smart_tests/ tests/"
-lint-warn = "flake8 --count --exit-zero --max-complexity=15 --max-line-length=130 --statistics smart_tests/ tests/"
+lint = "flake8 --count --ignore=C901,E741,F401,E126 --show-source --max-line-length=130 --statistics smart_tests/ tests/"
+lint-warn = "flake8 --count --exit-zero --max-complexity=15 --max-line-length=130 --ignore=E126 --statistics smart_tests/ tests/"
 test = "python -m unittest"
 test-xml = "python -m test-runner"
 type = "mypy smart_tests tests"

smart_tests/__main__.py

@@ -124,7 +124,7 @@ def main(
     if plugin_dir:
         for f in glob(join(plugin_dir, '*.py')):
             spec = importlib.util.spec_from_file_location(
-                "smart_tests.plugins.{}".format(basename(f)[:-3]), f)
+                f"smart_tests.plugins.{basename(f)[:-3]}", f)
             if spec is None:
                 raise ImportError(f"Failed to create module spec for plugin: {f}")
             if spec.loader is None:

smart_tests/commands/inspect/subset.py

@@ -115,11 +115,11 @@ def subset(
         rest = []
         client = LaunchableClient(app=app)
         try:
-            res = client.request("get", "subset/{}".format(subset_id))
+            res = client.request("get", f"subset/{subset_id}")
 
             if res.status_code == HTTPStatus.NOT_FOUND:
                 typer.echo(typer.style(
-                    "Subset {} not found. Check subset ID and try again.".format(subset_id), fg=typer.colors.YELLOW), err=True)
+                    f"Subset {subset_id} not found. Check subset ID and try again.", fg=typer.colors.YELLOW), err=True)
                 sys.exit(1)
 
             res.raise_for_status()

smart_tests/commands/record/attachment.py

@@ -33,11 +33,11 @@ def attachment(
         session_id = get_session_id(session, build, no_build, client)
 
         for a in attachments:
-            typer.echo("Sending {}".format(a))
+            typer.echo(f"Sending {a}")
             with open(a, mode='rb') as f:
                 res = client.request(
-                    "post", "{}/attachment".format(session_id), compress=True, payload=f,
-                    additional_headers={"Content-Disposition": "attachment;filename=\"{}\"".format(a)})
+                    "post", f"{session_id}/attachment", compress=True, payload=f,
+                    additional_headers={"Content-Disposition": f"attachment;filename=\"{a}\""})
                 res.raise_for_status()
     except Exception as e:
         client.print_exception_and_recover(e)

smart_tests/commands/record/build.py

@@ -238,13 +238,13 @@ def compute_hash_and_branch(ws: List[Workspace]):
                 kv = b.split('=')
                 if len(kv) != 2:
                     typer.secho(
-                        "Expected --branch REPO=BRANCHNAME but got {}".format(kv),
+                        f"Expected --branch REPO=BRANCHNAME but got {kv}",
                         fg=typer.colors.YELLOW, err=True)
                     raise typer.Exit(1)
 
                 if not ws_by_name.get(kv[0]):
                     typer.secho(
-                        "Invalid repository name {} in a --branch option. ".format(kv[0]),
+                        f"Invalid repository name {kv[0]} in a --branch option. ",
                         fg=typer.colors.YELLOW, err=True)
                     # TODO: is there any reason this is not an error? for now erring on caution
                     # sys.exit(1)
@@ -258,7 +258,7 @@ def compute_hash_and_branch(ws: List[Workspace]):
             except Exception as e:
                 typer.secho(
                     "Can't get commit hash for {}. Do you run command under git-controlled directory? "
-                    "If not, please set a directory use by --source option.".format(w.dir),
+                    "If not, please set a directory use by --source option.",
                     fg=typer.colors.YELLOW, err=True)
                 print(e, file=sys.stderr)
                 raise typer.Exit(1)
@@ -276,7 +276,7 @@ def synthesize_workspaces() -> List[Workspace]:
         for name, hash in parsed_commits:
             if not commit_pattern.match(hash):
                 typer.secho(
-                    "{}'s commit hash `{}` is invalid.".format(name, hash),
+                    f"{name}'s commit hash `{hash}` is invalid.",
                     fg=typer.colors.YELLOW, err=True)
                 raise typer.Exit(1)
 
@@ -328,26 +328,16 @@ def compute_links():
     def report(ws: List[Workspace], build_id: str):
         org, workspace = get_org_workspace()
         typer.echo(
-            "Launchable recorded build {} to workspace {}/{} with commits from {} {}:\n".format(
-                build_name,
-                org,
-                workspace,
-                len(ws),
-                ("repositories" if len(ws) > 1 else "repository"),
-            )
-        )
+            f"Launchable recorded build {build_name} to workspace {org}/{workspace} with commits from {
+                len(ws)} {
+                'repositories' if len(ws) > 1 else 'repository'}:\n")
 
         header = ["Name", "Path", "HEAD Commit"]
         rows = [[w.name, w.dir, w.commit_hash] for w in ws]
         typer.echo(tabulate(rows, header, tablefmt="github"))
         typer.echo(
-            "\nVisit https://app.launchableinc.com/organizations/{organization}/workspaces/"
-            "{workspace}/data/builds/{build_id} to view this build and its test sessions"
-            .format(
-                organization=org,
-                workspace=workspace,
-                build_id=build_id,
-            ))
+            f"\nVisit https://app.launchableinc.com/organizations/{org}/workspaces/"
+            f"{workspace}/data/builds/{build_id} to view this build and its test sessions")
 
     # all the logics at the high level
     if len(commits) == 0:

smart_tests/commands/record/commit.py

@@ -79,9 +79,8 @@ def commit(
             raise e
         else:
             typer.secho(
-                "Couldn't get commit history from `{}`. Do you run command root of git-controlled directory? "
-                "If not, please set a directory use by --source option."
-                .format(cwd),
+                f"Couldn't get commit history from `{cwd}`. Do you run command root of git-controlled directory? "
+                f"If not, please set a directory use by --source option.",
                 fg=typer.colors.YELLOW, err=True)
             print(e)
 
@@ -103,7 +102,7 @@ def exec_jar(source: str, max_days: int, app: Application, is_collect_message: b
         cygpath(jar_file_path),
         "ingest:commit",
         "-endpoint",
-        "{}/intake/".format(base_url),
+        f"{base_url}/intake/",
         "-max-days",
         str(max_days),
         "-scrub-pii"
@@ -151,7 +150,7 @@ def _build_proxy_option(https_proxy: str | None) -> List[str]:
 
     options = []
     if proxy_url.hostname:
-        options.append("-Dhttps.proxyHost={}".format(proxy_url.hostname))
+        options.append(f"-Dhttps.proxyHost={proxy_url.hostname}")
     if proxy_url.port:
-        options.append("-Dhttps.proxyPort={}".format(proxy_url.port))
+        options.append(f"-Dhttps.proxyPort={proxy_url.port}")
     return options

smart_tests/commands/record/session.py

@@ -130,12 +130,12 @@ def session(
     client = LaunchableClient(app=app, tracking_client=tracking_client)
 
     if session:
-        sub_path = "builds/{}/test_sessions/{}".format(build_name, session)
+        sub_path = f"builds/{build_name}/test_sessions/{session}"
         try:
             res = client.request("get", sub_path)
 
             if res.status_code != 404:
-                msg = "This session name ({}) is already used. Please set another name.".format(session)
+                msg = f"This session name ({session}) is already used. Please set another name."
                 typer.secho(msg, fg=typer.colors.RED, err=True)
                 tracking_client.send_error_event(
                     event_name=Tracking.ErrorEvent.USER_ERROR,
@@ -170,13 +170,12 @@ def session(
     payload["links"] = _links
 
     try:
-        sub_path = "builds/{}/test_sessions".format(build_name)
+        sub_path = f"builds/{build_name}/test_sessions"
         res = client.request("post", sub_path, payload=payload)
 
         if res.status_code == HTTPStatus.NOT_FOUND:
-            msg = "Build {} was not found." \
-                "Make sure to run `launchable record build --build {}` before you run this command.".format(
-                    build_name, build_name)
+            msg = f"Build {build_name} was not found." \
+                f"Make sure to run `launchable record build --build {build_name}` before you run this command."
             tracking_client.send_error_event(
                 event_name=Tracking.ErrorEvent.INTERNAL_CLI_ERROR,
                 stack_trace=msg,
@@ -190,15 +189,15 @@ def session(
         if is_no_build:
             build_name = res.json().get("buildNumber", "")
             assert build_name is not None
-            sub_path = "builds/{}/test_sessions".format(build_name)
+            sub_path = f"builds/{build_name}/test_sessions"
 
         if print_session:
             # what we print here gets captured and passed to `--session` in
             # later commands
-            typer.echo("{}/{}".format(sub_path, session_id), nl=False)
+            typer.echo(f"{sub_path}/{session_id}", nl=False)
 
         # Return the session ID for use by calling functions
-        return "{}/{}".format(sub_path, session_id)
+        return f"{sub_path}/{session_id}"
 
     except Exception as e:
         tracking_client.send_error_event(
@@ -231,22 +230,22 @@ def add_session_name(
     session_id: str,
     session_name: str,
 ):
-    sub_path = "builds/{}/test_sessions/{}".format(build_name, session_id)
+    sub_path = f"builds/{build_name}/test_sessions/{session_id}"
     payload = {
         "name": session_name
     }
     res = client.request("patch", sub_path, payload=payload)
 
     if res.status_code == HTTPStatus.NOT_FOUND:
         typer.secho(
-            "Test session {} was not found. Record session may have failed.".format(session_id),
+            f"Test session {session_id} was not found. Record session may have failed.",
             fg=typer.colors.YELLOW, err=True
         )
         sys.exit(1)
     if res.status_code == HTTPStatus.BAD_REQUEST:
         typer.secho(
             "You cannot use test session name {} since it is already used by other test session in your workspace. "
-            "The record session is completed successfully without session name.".format(session_name),
+            "The record session is completed successfully without session name.",
             fg=typer.colors.YELLOW, err=True)
         sys.exit(1)