Use f-string instead of str.format()

Author: philpep

doc/source/conf.py

@@ -61,7 +61,7 @@
 
 # General information about the project.
 project = "testinfra"
-copyright = "{}, Philippe Pepiot".format(datetime.date.today().year)
+copyright = f"{datetime.date.today().year}, Philippe Pepiot"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the

test/conftest.py

@@ -62,29 +62,29 @@ def has_docker():
 def setup_ansible_config(tmpdir, name, host, user, port, key):
     items = [
         name,
-        "ansible_ssh_private_key_file={}".format(key),
-        'ansible_ssh_common_args="-o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no -o LogLevel=FATAL"',  # noqa
+        f"ansible_ssh_private_key_file={key}",
+        'ansible_ssh_common_args="-o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no -o LogLevel=FATAL"',
         "myvar=foo",
-        "ansible_host={}".format(host),
-        "ansible_user={}".format(user),
-        "ansible_port={}".format(port),
+        f"ansible_host={host}",
+        f"ansible_user={user}",
+        f"ansible_port={port}",
     ]
     tmpdir.join("inventory").write("[testgroup]\n" + " ".join(items) + "\n")
     tmpdir.mkdir("host_vars").join(name).write(ANSIBLE_HOSTVARS)
     tmpdir.mkdir("group_vars").join("testgroup").write(
-        ("---\n" "myhostvar: should_be_overriden\n" "mygroupvar: qux\n")
+        "---\n" "myhostvar: should_be_overriden\n" "mygroupvar: qux\n"
     )
     vault_password_file = tmpdir.join("vault-pass.txt")
     vault_password_file.write("polichinelle\n")
     ansible_cfg = tmpdir.join("ansible.cfg")
     ansible_cfg.write(
-        (
+        
             "[defaults]\n"
-            "vault_password_file={}\n"
+            f"vault_password_file={str(vault_password_file)}\n"
             "host_key_checking=False\n\n"
             "[ssh_connection]\n"
             "pipelining=True\n"
-        ).format(str(vault_password_file))
+        
     )
 
 
@@ -119,7 +119,7 @@ def teardown():
 
         return docker_id, docker_host, port
 
-    fname = "_docker_container_{}_{}".format(image, scope)
+    fname = f"_docker_container_{image}_{scope}"
     mod = sys.modules[__name__]
     setattr(mod, fname, func)
 
@@ -147,7 +147,7 @@ def host(request, tmpdir_factory):
     else:
         scope = "session"
 
-    fname = "_docker_container_{}_{}".format(spec.name, scope)
+    fname = f"_docker_container_{spec.name}_{scope}"
     docker_id, docker_host, port = request.getfixturevalue(fname)
 
     if kw["connection"] == "docker":
@@ -168,16 +168,16 @@ def host(request, tmpdir_factory):
         else:
             ssh_config = tmpdir.join("ssh_config")
             ssh_config.write(
-                (
-                    "Host {}\n"
-                    "  Hostname {}\n"
-                    "  Port {}\n"
+                
+                    f"Host {hostname}\n"
+                    f"  Hostname {docker_host}\n"
+                    f"  Port {port}\n"
                     "  UserKnownHostsFile /dev/null\n"
                     "  StrictHostKeyChecking no\n"
-                    "  IdentityFile {}\n"
+                    f"  IdentityFile {str(key)}\n"
                     "  IdentitiesOnly yes\n"
                     "  LogLevel FATAL\n"
-                ).format(hostname, docker_host, port, str(key))
+                
             )
             kw["ssh_config"] = str(ssh_config)
 
@@ -232,7 +232,7 @@ def build_image(build_failed, dockerfile, image, image_path):
                     "-f",
                     dockerfile,
                     "-t",
-                    "testinfra:{0}".format(image),
+                    f"testinfra:{image}",
                     image_path,
                 ]
             )

test/test_backends.py

@@ -125,7 +125,7 @@ def test_sudo(host):
 def test_ansible_get_hosts():
     with tempfile.NamedTemporaryFile() as f:
         f.write(
-            (
+            
                 b"ungrp\n"
                 b"[g1]\n"
                 b"debian\n"
@@ -136,7 +136,7 @@ def test_ansible_get_hosts():
                 b"g2\n"
                 b"[g4:children]\n"
                 b"g3"
-            )
+            
         )
         f.flush()
 
@@ -158,7 +158,7 @@ def get_hosts(spec):
 def test_ansible_get_variables():
     with tempfile.NamedTemporaryFile() as f:
         f.write(
-            (
+            
                 b"debian a=b c=d\n"
                 b"rockylinux e=f\n"
                 b"[all:vars]\n"
@@ -167,7 +167,7 @@ def test_ansible_get_variables():
                 b"debian\n"
                 b"[g:vars]\n"
                 b"x=z\n"
-            )
+            
         )
         f.flush()
 
@@ -202,7 +202,7 @@ def get_vars(host):
         (
             {},
             b"host ansible_connection=local ansible_become=yes ansible_become_user=u",
-            {  # noqa
+            {
                 "NAME": "local",
                 "sudo": True,
                 "sudo_user": "u",
@@ -227,7 +227,7 @@ def get_vars(host):
         (
             {},
             b"host ansible_host=127.0.1.1 ansible_user=u ansible_ssh_private_key_file=key ansible_port=2222 ansible_become=yes ansible_become_user=u",
-            {  # noqa
+            {
                 "NAME": "ssh",
                 "sudo": True,
                 "sudo_user": "u",
@@ -239,7 +239,7 @@ def get_vars(host):
         (
             {},
             b"host ansible_host=127.0.1.1 ansible_user=u ansible_private_key_file=key ansible_port=2222 ansible_become=yes ansible_become_user=u",
-            {  # noqa
+            {
                 "NAME": "ssh",
                 "sudo": True,
                 "sudo_user": "u",
@@ -269,7 +269,7 @@ def get_vars(host):
         (
             {},
             b'host ansible_ssh_common_args="-o StrictHostKeyChecking=no" ansible_ssh_extra_args="-o LogLevel=FATAL"',
-            {  # noqa
+            {
                 "NAME": "ssh",
                 "host.name": "host",
                 "ssh_extra_args": "-o StrictHostKeyChecking=no -o LogLevel=FATAL",
@@ -296,7 +296,7 @@ def get_vars(host):
         (
             {},
             b"host ansible_connection=docker ansible_become=yes ansible_become_user=u ansible_user=z ansible_host=container",
-            {  # noqa
+            {
                 "NAME": "docker",
                 "name": "container",
                 "user": "z",
@@ -347,7 +347,7 @@ def test_ansible_get_host(kwargs, inventory, expected):
         # identity_file has highest priority
         (
             b"host ansible_user=user ansible_ssh_pass=password ansible_ssh_private_key_file=some_file",
-            (  # noqa
+            (
                 "ssh -o User=user -i some_file "
                 "-o ConnectTimeout=10 -o ControlMaster=auto "
                 "-o ControlPersist=60s host true"
@@ -373,7 +373,7 @@ def test_ansible_get_host(kwargs, inventory, expected):
         # escape %
         (
             b'host ansible_ssh_extra_args="-o ControlPath ~/.ssh/ansible/cp/%r@%h-%p"',
-            (  # noqa
+            (
                 "ssh -o ControlPath ~/.ssh/ansible/cp/%r@%h-%p -o ConnectTimeout=10 "
                 "-o ControlMaster=auto -o ControlPersist=60s host true"
             ),
@@ -419,7 +419,7 @@ def test_ansible_config():
     # test testinfra use ANSIBLE_CONFIG
     tmp = tempfile.NamedTemporaryFile
     with tmp(suffix=".cfg") as cfg, tmp() as inventory:
-        cfg.write((b"[defaults]\n" b"inventory=" + inventory.name.encode() + b"\n"))
+        cfg.write(b"[defaults]\n" b"inventory=" + inventory.name.encode() + b"\n")
         cfg.flush()
         inventory.write(b"h\n")
         inventory.flush()

test/test_modules.py

@@ -25,7 +25,7 @@
 
 all_images = pytest.mark.testinfra_hosts(
     *[
-        "docker://{}".format(image)
+        f"docker://{image}"
         for image in (
             "rockylinux9",
             "debian_bookworm",

testinfra/backend/__init__.py

@@ -13,7 +13,8 @@
 import importlib
 import os
 import urllib.parse
-from typing import TYPE_CHECKING, Any, Iterable
+from collections.abc import Iterable
+from typing import TYPE_CHECKING, Any
 
 if TYPE_CHECKING:
     import testinfra.backend.base
@@ -39,7 +40,7 @@ def get_backend_class(connection: str) -> type["testinfra.backend.base.BaseBacke
     try:
         classpath = BACKENDS[connection]
     except KeyError:
-        raise RuntimeError("Unknown connection type '{}'".format(connection))
+        raise RuntimeError(f"Unknown connection type '{connection}'")
     module, name = classpath.rsplit(".", 1)
     return getattr(importlib.import_module(module), name)  # type: ignore[no-any-return]
 

testinfra/backend/base.py

@@ -146,7 +146,7 @@ def __init__(
         **kwargs: Any,
     ):
         self._encoding: Optional[str] = None
-        self._host: Optional["testinfra.host.Host"] = None
+        self._host: Optional[testinfra.host.Host] = None
         self.hostname = hostname
         self.sudo = sudo
         self.sudo_user = sudo_user
@@ -197,16 +197,14 @@ def get_pytest_id(self) -> str:
     def get_hosts(cls, host: str, **kwargs: Any) -> list[str]:
         if host is None:
             raise RuntimeError(
-                "One or more hosts is required with the {} backend".format(
-                    cls.get_connection_type()
-                )
+                f"One or more hosts is required with the {cls.get_connection_type()} backend"
             )
         return [host]
 
     @staticmethod
     def quote(command: str, *args: str) -> str:
         if args:
-            return command % tuple(shlex.quote(a) for a in args)  # noqa: S001
+            return command % tuple(shlex.quote(a) for a in args)
         return command
 
     def get_sudo_command(self, command: str, sudo_user: Optional[str]) -> str:

testinfra/backend/chroot.py

@@ -31,7 +31,7 @@ def __init__(self, name: str, *args: Any, **kwargs: Any):
     def run(self, command: str, *args: str, **kwargs: Any) -> base.CommandResult:
         if not os.path.exists(self.name) and os.path.isdir(self.name):
             raise RuntimeError(
-                "chroot path {} not found or not a directory".format(self.name)
+                f"chroot path {self.name} not found or not a directory"
             )
         cmd = self.get_command(command, *args)
         out = self.run_local("chroot %s /bin/sh -c %s", self.name, cmd)

testinfra/backend/paramiko.py

@@ -16,10 +16,10 @@
     import paramiko
 except ImportError:
     raise RuntimeError(
-        (
+        
             "You must install paramiko package (pip install paramiko) "
             "to use the paramiko backend"
-        )
+        
     )
 
 import functools
@@ -121,7 +121,7 @@ def client(self) -> paramiko.SSHClient:
                 with open(default_ssh_config) as f:
                     ssh_config = paramiko.SSHConfig()
                     ssh_config.parse(f)
-            except IOError:
+            except OSError:
                 pass
             else:
                 self._load_ssh_config(client, cfg, ssh_config, ssh_config_dir)

testinfra/backend/salt.py

@@ -49,8 +49,8 @@ def run_salt(self, func: str, args: Any = None) -> Any:
         out = self.client.cmd(self.host, func, args or [])
         if self.host not in out:
             raise RuntimeError(
-                "Error while running {}({}): {}. "
-                "Minion not connected ?".format(func, args, out)
+                f"Error while running {func}({args}): {out}. "
+                "Minion not connected ?"
             )
         return out[self.host]
 
@@ -65,6 +65,6 @@ def get_hosts(cls, host: str, **kwargs: Any) -> list[str]:
             else:
                 hosts = client.cmd(host, "test.true").keys()
             if not hosts:
-                raise RuntimeError("No host matching '{}'".format(host))
+                raise RuntimeError(f"No host matching '{host}'")
             return sorted(hosts)
         return super().get_hosts(host, **kwargs)

testinfra/backend/ssh.py

@@ -68,21 +68,19 @@ def _build_ssh_command(self, command: str) -> tuple[list[str], list[str]]:
             cmd.append("-i %s")
             cmd_args.append(self.ssh_identity_file)
         if "connecttimeout" not in (self.ssh_extra_args or "").lower():
-            cmd.append("-o ConnectTimeout={}".format(self.timeout))
+            cmd.append(f"-o ConnectTimeout={self.timeout}")
         if self.controlpersist and (
             "controlmaster" not in (self.ssh_extra_args or "").lower()
         ):
             cmd.append(
-                "-o ControlMaster=auto -o ControlPersist={}s".format(
-                    self.controlpersist
-                )
+                f"-o ControlMaster=auto -o ControlPersist={self.controlpersist}s"
             )
         if (
             "ControlMaster" in " ".join(cmd)
             and self.controlpath
             and ("controlpath" not in (self.ssh_extra_args or "").lower())
         ):
-            cmd.append("-o ControlPath={}".format(self.controlpath))
+            cmd.append(f"-o ControlPath={self.controlpath}")
         cmd.append("%s %s")
         cmd_args.extend([self.host.name, command])
         return cmd, cmd_args
@@ -120,11 +118,11 @@ def run(self, command: str, *args: str, **kwargs: Any) -> base.CommandResult:
         orig_command = self.get_command("sh -c %s", orig_command)
 
         out = self.run_ssh(
-            (
-                """of=$(mktemp)&&ef=$(mktemp)&&{} >$of 2>$ef; r=$?;"""
+            
+                f"""of=$(mktemp)&&ef=$(mktemp)&&{orig_command} >$of 2>$ef; r=$?;"""
                 """echo "TESTINFRA_START;$r;$(base64 < $of);$(base64 < $ef);"""
                 """TESTINFRA_END";rm -f $of $ef"""
-            ).format(orig_command)
+            
         )
 
         start = out.stdout.find("TESTINFRA_START;") + len("TESTINFRA_START;")