fix: Pre-commit

Author: AlejandroFernandezLuces

src/ansys/tools/common/launcher/config.py

@@ -216,7 +216,7 @@ def save_config() -> None:
         # Convert to JSON before saving; in this way, errors during
         # JSON encoding will not clobber the config file.
         config_json = json.dumps(dataclasses.asdict(_CONFIG)["__root__"], indent=2)
-        with open(file_path, "w") as out_f:
+        with file_path.open("w") as out_f:
             out_f.write(config_json)
 
 
@@ -231,7 +231,7 @@ def _load_config() -> _LauncherConfiguration:
     config_path = _get_config_path()
     if not config_path.exists():
         return _LauncherConfiguration(__root__={})
-    with open(config_path) as in_f:
+    with config_path.open() as in_f:
         return _LauncherConfiguration(__root__={key: _ProductConfig(**val) for key, val in json.load(in_f).items()})
 
 

tests/launcher/conftest.py

@@ -19,6 +19,7 @@
 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
+"""Conftest module."""
 
 from functools import partial
 import importlib.metadata
@@ -39,6 +40,7 @@ def reset_config():
 def get_mock_entrypoints_from_plugins(
     target_plugins: dict[str, dict[str, LauncherProtocol[LAUNCHER_CONFIG_T]]],
 ):
+    """Get mock entrypoints from plugins."""
     res = []
     for product_name, launchers in target_plugins.items():
         for launch_mode, launcher_kls in launchers.items():
@@ -51,6 +53,8 @@ def get_mock_entrypoints_from_plugins(
 
 @pytest.fixture
 def monkeypatch_entrypoints_from_plugins(monkeypatch):
+    """Mock entrypoints."""
+
     def inner(target_plugins):
         monkeypatch.setattr(
             _plugins,

tests/launcher/pkg_with_entrypoint/src/pkg_with_entrypoint/__init__.py

@@ -19,6 +19,7 @@
 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
+"""Module for entrypoint package."""
 
 from .launcher import Launcher, LauncherConfig
 

tests/launcher/pkg_with_entrypoint/src/pkg_with_entrypoint/launcher.py

@@ -19,6 +19,7 @@
 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
+"""Module for package."""
 
 from dataclasses import dataclass
 
@@ -27,8 +28,12 @@
 
 @dataclass
 class LauncherConfig:
+    """Launcher configuration for the package with an entry point."""
+
     pass
 
 
 class Launcher(interface.LauncherProtocol[LauncherConfig]):
+    """Launcher for the package with an entry point."""
+
     CONFIG_MODEL = LauncherConfig

tests/launcher/test_cli/__init__.py

@@ -19,3 +19,4 @@
 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
+"""Test CLI module."""

tests/launcher/test_cli/common.py

@@ -19,11 +19,14 @@
 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
+"""Module for common testing functionalities."""
 
 import json
+from pathlib import Path
 
 
 def check_result_config(path, expected):
-    with open(path) as f:
+    """Check result from configuration."""
+    with Path(path).open() as f:
         config = json.load(f)
     assert config == expected

tests/launcher/test_cli/conftest.py

@@ -19,6 +19,7 @@
 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
+"""Conftest module."""
 
 import pytest
 
@@ -29,6 +30,7 @@
 
 @pytest.fixture
 def temp_config_file(monkeypatch, tmp_path):
+    """Fixture to create a temporary configuration file for testing."""
     output_path = tmp_path / "config.json"
 
     def get_config_path_patched():

tests/launcher/test_cli/test_multiple_plugins.py

@@ -19,6 +19,7 @@
 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
+"""Module for multiple plugins test."""
 
 from dataclasses import dataclass
 
@@ -38,28 +39,40 @@
 
 @dataclass
 class MockConfigA1:
+    """Mock config."""
+
     field_a1: int
 
 
 class MockLauncherA1(interface.LauncherProtocol[MockConfigA1]):
+    """Mock launcher."""
+
     CONFIG_MODEL = MockConfigA1
 
 
 @dataclass
 class MockConfigA2:
+    """Mock config."""
+
     field_a2: int
 
 
 class MockLauncherA2(interface.LauncherProtocol[MockConfigA2]):
+    """Mock launcher."""
+
     CONFIG_MODEL = MockConfigA2
 
 
 @dataclass
 class MockConfigB1:
+    """Mock config."""
+
     field_b1: int
 
 
 class MockLauncherB1(interface.LauncherProtocol[MockConfigB1]):
+    """Mock launcher for testing CLI configuration for product B."""
+
     CONFIG_MODEL = MockConfigB1
 
 
@@ -74,10 +87,12 @@ class MockLauncherB1(interface.LauncherProtocol[MockConfigB1]):
 
 @pytest.fixture(autouse=True)
 def monkeypatch_entrypoints(monkeypatch_entrypoints_from_plugins):
+    """Mock entrypoints for the plugins."""
     monkeypatch_entrypoints_from_plugins(PLUGINS)
 
 
 def test_cli_structure():
+    """Test CLI structure."""
     command = _cli.build_cli(_plugins.get_all_plugins())
     assert "configure" in command.commands
     configure_group = command.commands["configure"]
@@ -93,6 +108,7 @@ def test_cli_structure():
 
 
 def test_configure_single_product_launcher(temp_config_file):
+    """Test configuring a single product with a single launcher."""
     cli_command = _cli.build_cli(_plugins.get_all_plugins())
     runner = CliRunner()
     result = runner.invoke(
@@ -113,6 +129,7 @@ def test_configure_single_product_launcher(temp_config_file):
 
 
 def test_configure_two_product_launchers(temp_config_file):
+    """Test configuring two different products with different launch modes."""
     cli_command = _cli.build_cli(_plugins.get_all_plugins())
     runner = CliRunner()
     result = runner.invoke(
@@ -141,6 +158,7 @@ def test_configure_two_product_launchers(temp_config_file):
 
 
 def test_configure_two_product_launchers_overwrite(temp_config_file):
+    """Test configuring two products with overwriting configurations."""
     cli_command = _cli.build_cli(_plugins.get_all_plugins())
     runner = CliRunner()
     result = runner.invoke(
@@ -169,6 +187,7 @@ def test_configure_two_product_launchers_overwrite(temp_config_file):
 
 
 def test_configure_two_products(temp_config_file):
+    """Test configuring two products."""
     cli_command = _cli.build_cli(_plugins.get_all_plugins())
     runner = CliRunner()
     result = runner.invoke(

tests/launcher/test_cli/test_single_plugin.py

@@ -19,6 +19,7 @@
 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
+"""Module for testing plugins."""
 
 from dataclasses import dataclass, field
 
@@ -32,6 +33,8 @@
 
 @dataclass
 class MockConfig:
+    """Mock configuration for testing CLI."""
+
     int_field: int
     str_field: str
     json_field: dict[str, str]
@@ -40,6 +43,8 @@ class MockConfig:
 
 
 class MockLauncher(interface.LauncherProtocol[MockConfig]):
+    """Mock launcher for testing CLI configuration."""
+
     CONFIG_MODEL = MockConfig
 
 
@@ -64,10 +69,12 @@ class MockLauncher(interface.LauncherProtocol[MockConfig]):
 
 @pytest.fixture
 def mock_plugins():
+    """Mock plugin for testing CLI."""
     return {TEST_PRODUCT: {TEST_LAUNCH_MODE: MockLauncher}}
 
 
 def test_cli_no_plugins():
+    """Test that the CLI is built correctly with no plugins."""
     command = _cli.build_cli(dict())
     runner = CliRunner()
     result = runner.invoke(command, ["configure"])
@@ -76,6 +83,7 @@ def test_cli_no_plugins():
 
 
 def test_cli_mock_plugin(mock_plugins):
+    """Test that the CLI is built correctly with a mock plugin."""
     command = _cli.build_cli(mock_plugins)
     assert "configure" in command.commands
     configure_group = command.commands["configure"]
@@ -135,6 +143,7 @@ def test_cli_mock_plugin(mock_plugins):
     ],
 )
 def test_run_cli(temp_config_file, mock_plugins, commands, prompts):
+    """Test running the CLI."""
     cli_command = _cli.build_cli(mock_plugins)
     runner = CliRunner()
     result = runner.invoke(
@@ -148,6 +157,7 @@ def test_run_cli(temp_config_file, mock_plugins, commands, prompts):
 
 
 def test_run_cli_throws_on_incorrect_type(temp_config_file, mock_plugins):
+    """Test that the CLI throws an error when a field is given an incorrect type."""
     cli_command = _cli.build_cli(mock_plugins)
     runner = CliRunner()
     result = runner.invoke(

tests/launcher/test_entry_point.py

@@ -19,6 +19,8 @@
 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
+"""Module for entry point testing."""
+
 import pkg_with_entrypoint
 
 from ansys.tools.common.launcher._plugins import (
@@ -30,17 +32,20 @@
 
 
 def test_plugin_found():
+    """Test that the plugin is found in the plugin dictionary."""
     plugin_dict = get_all_plugins()
     assert "pkg_with_entrypoint" in plugin_dict
     assert "test_entry_point" in plugin_dict["pkg_with_entrypoint"]
 
 
 def test_get_launcher():
+    """Test that the launcher can be retrieved for a specific product and launch mode."""
     launcher = get_launcher(product_name="pkg_with_entrypoint", launch_mode="test_entry_point")
     assert launcher.__name__ == "Launcher"
 
 
 def test_fallback():
+    """Test fallback."""
     assert get_launch_mode_for(product_name="pkg_with_entrypoint") == "__fallback__"
     assert (
         get_config_for(product_name="pkg_with_entrypoint", launch_mode="__fallback__")
@@ -50,6 +55,7 @@ def test_fallback():
 
 
 def test_get_config_model():
+    """Test that get_config_model returns the correct configuration model."""
     config_model = get_config_model(product_name="pkg_with_entrypoint", launch_mode="test_entry_point")
     assert config_model.__name__ == "LauncherConfig"