Improve Python code: address unused variables (#11049)

* Address F841 (unused variable).

* Reformat.

* Add changelog fragment.

* More cleanup.

* Remove trailing whitespace.

* Readd removed code as a comment with TODO.

tests/unit/plugins/module_utils/net_tools/pritunl/test_api.py

@@ -613,4 +613,4 @@ class TestPritunlApi:
         api.pritunl_auth_request = get_pritunl_error_mock()
 
         with pytest.raises(api.PritunlException):
-            response = api.list_pritunl_organizations(**pritunl_settings)
+            api.list_pritunl_organizations(**pritunl_settings)

tests/unit/plugins/module_utils/test_deps.py

@@ -20,7 +20,7 @@ def module():
 
 
 def test_wrong_name(module):
-    with deps.declare("sys") as sys_dep:
+    with deps.declare("sys"):
         import sys  # noqa: F401, pylint: disable=unused-import
 
     with pytest.raises(KeyError):

tests/unit/plugins/module_utils/test_saslprep.py

@@ -51,5 +51,5 @@ def test_saslprep_conversions(source, target):
 
 @pytest.mark.parametrize("source,exception", INVALID)
 def test_saslprep_exceptions(source, exception):
-    with pytest.raises(exception) as ex:
+    with pytest.raises(exception):
         saslprep(source)

tests/unit/plugins/module_utils/xenserver/test_get_object_ref.py

@@ -14,9 +14,7 @@ from .common import fake_xenapi_ref
 
 def test_get_object_ref_xenapi_failure(mocker, fake_ansible_module, XenAPI, xenserver):
     """Tests catching of XenAPI failures."""
-    mocked_xenapi = mocker.patch.object(
-        XenAPI.Session, "xenapi_request", side_effect=XenAPI.Failure("Fake XAPI method call error!")
-    )
+    mocker.patch.object(XenAPI.Session, "xenapi_request", side_effect=XenAPI.Failure("Fake XAPI method call error!"))
 
     with pytest.raises(FailJsonException) as exc_info:
         xenserver.get_object_ref(fake_ansible_module, "name")
@@ -37,9 +35,7 @@ def test_get_object_ref_bad_uuid_and_name(mocker, fake_ansible_module, XenAPI, x
 
 def test_get_object_ref_uuid_not_found(mocker, fake_ansible_module, XenAPI, xenserver):
     """Tests when object is not found by uuid."""
-    mocked_xenapi = mocker.patch.object(
-        XenAPI.Session, "xenapi_request", side_effect=XenAPI.Failure("Fake XAPI not found error!")
-    )
+    mocker.patch.object(XenAPI.Session, "xenapi_request", side_effect=XenAPI.Failure("Fake XAPI not found error!"))
 
     with pytest.raises(FailJsonException) as exc_info:
         xenserver.get_object_ref(fake_ansible_module, "name", uuid="fake-uuid", msg_prefix="Test: ")
@@ -52,7 +48,7 @@ def test_get_object_ref_uuid_not_found(mocker, fake_ansible_module, XenAPI, xens
 
 def test_get_object_ref_name_not_found(mocker, fake_ansible_module, XenAPI, xenserver):
     """Tests when object is not found by name."""
-    mocked_xenapi = mocker.patch.object(XenAPI.Session, "xenapi_request", return_value=[])
+    mocker.patch.object(XenAPI.Session, "xenapi_request", return_value=[])
 
     with pytest.raises(FailJsonException) as exc_info:
         xenserver.get_object_ref(fake_ansible_module, "name", msg_prefix="Test: ")
@@ -63,9 +59,7 @@ def test_get_object_ref_name_not_found(mocker, fake_ansible_module, XenAPI, xens
 
 def test_get_object_ref_name_multiple_found(mocker, fake_ansible_module, XenAPI, xenserver):
     """Tests when multiple objects are found by name."""
-    mocked_xenapi = mocker.patch.object(
-        XenAPI.Session, "xenapi_request", return_value=[fake_xenapi_ref("VM"), fake_xenapi_ref("VM")]
-    )
+    mocker.patch.object(XenAPI.Session, "xenapi_request", return_value=[fake_xenapi_ref("VM"), fake_xenapi_ref("VM")])
 
     error_msg = "Test: multiple VMs with name 'name' found! Please use UUID."
 

tests/unit/plugins/module_utils/xenserver/test_xapi.py

@@ -73,7 +73,7 @@ def test_xapi_connect_local_session(mocker, fake_ansible_module, XenAPI, xenserv
     """Tests that connection to localhost uses XenAPI.xapi_local() function."""
     mocker.patch("XenAPI.xapi_local")
 
-    xapi_session = xenserver.XAPI.connect(fake_ansible_module)
+    xenserver.XAPI.connect(fake_ansible_module)
 
     XenAPI.xapi_local.assert_called_once()
 
@@ -88,7 +88,7 @@ def test_xapi_connect_local_login(mocker, fake_ansible_module, XenAPI, xenserver
     """Tests that connection to localhost uses empty username and password."""
     mocker.patch.object(XenAPI.Session, "login_with_password", create=True)
 
-    xapi_session = xenserver.XAPI.connect(fake_ansible_module)
+    xenserver.XAPI.connect(fake_ansible_module)
 
     XenAPI.Session.login_with_password.assert_called_once_with("", "", ANSIBLE_VERSION, "Ansible")
 
@@ -100,7 +100,7 @@ def test_xapi_connect_login(mocker, fake_ansible_module, XenAPI, xenserver):
     """
     mocker.patch.object(XenAPI.Session, "login_with_password", create=True)
 
-    xapi_session = xenserver.XAPI.connect(fake_ansible_module)
+    xenserver.XAPI.connect(fake_ansible_module)
 
     username = fake_ansible_module.params["username"]
     password = fake_ansible_module.params["password"]
@@ -119,7 +119,7 @@ def test_xapi_connect_login_failure(mocker, fake_ansible_module, XenAPI, xenserv
     username = fake_ansible_module.params["username"]
 
     with pytest.raises(FailJsonException) as exc_info:
-        xapi_session = xenserver.XAPI.connect(fake_ansible_module)
+        xenserver.XAPI.connect(fake_ansible_module)
 
     assert (
         exc_info.value.kwargs["msg"]
@@ -137,7 +137,7 @@ def test_xapi_connect_remote_scheme(mocker, fake_ansible_module, XenAPI, xenserv
     """Tests that explicit scheme in hostname param is preserved."""
     mocker.patch("XenAPI.Session")
 
-    xapi_session = xenserver.XAPI.connect(fake_ansible_module)
+    xenserver.XAPI.connect(fake_ansible_module)
 
     hostname = fake_ansible_module.params["hostname"]
     ignore_ssl = not fake_ansible_module.params["validate_certs"]
@@ -155,7 +155,7 @@ def test_xapi_connect_remote_no_scheme(mocker, fake_ansible_module, XenAPI, xens
     """Tests that proper scheme is prepended to hostname without scheme."""
     mocker.patch("XenAPI.Session")
 
-    xapi_session = xenserver.XAPI.connect(fake_ansible_module)
+    xenserver.XAPI.connect(fake_ansible_module)
 
     hostname = fake_ansible_module.params["hostname"]
     ignore_ssl = not fake_ansible_module.params["validate_certs"]
@@ -168,11 +168,10 @@ def test_xapi_connect_support_ignore_ssl(mocker, fake_ansible_module, XenAPI, xe
     mocked_session = mocker.patch("XenAPI.Session")
     mocked_session.side_effect = TypeError()
 
-    with pytest.raises(TypeError) as exc_info:
-        xapi_session = xenserver.XAPI.connect(fake_ansible_module)
+    with pytest.raises(TypeError):
+        xenserver.XAPI.connect(fake_ansible_module)
 
     hostname = fake_ansible_module.params["hostname"]
-    ignore_ssl = not fake_ansible_module.params["validate_certs"]
 
     XenAPI.Session.assert_called_with(f"http://{hostname}")
 
@@ -181,7 +180,7 @@ def test_xapi_connect_no_disconnect_atexit(mocker, fake_ansible_module, XenAPI,
     """Tests skipping registration of atexit disconnect handler."""
     mocker.patch("atexit.register")
 
-    xapi_session = xenserver.XAPI.connect(fake_ansible_module, disconnect_atexit=False)
+    xenserver.XAPI.connect(fake_ansible_module, disconnect_atexit=False)
 
     atexit.register.assert_not_called()