drop 'full' argument from version()

Author: bimac

CHANGELOG.md

@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 
 - dropped 'verbose' argument from list_boards()
+- dropped 'full' argument from version()
 
 ## [0.1.1] - 2024-07-11
 

tests/test_tycmd.py

@@ -5,7 +5,6 @@
 import pytest
 
 import tycmd
-import re
 
 
 BLINK_HEX = Path(__file__).parent.joinpath("blink.hex").resolve()
@@ -48,12 +47,7 @@ def test_list_boards(mock_check_output):
 
 
 def test_version():
-    output = tycmd.version(full=True)
-    assert isinstance(output, str)
-    match = re.search(r"^.+(\d+\.\d+\.\d+)", output)
-    assert match is not None
-    assert match.groups()[0] == tycmd._TYCMD_VERSION
-    assert tycmd.version(full=False) == tycmd._TYCMD_VERSION
+    assert tycmd.version() == tycmd._TYCMD_VERSION
 
 
 def test__parse_firmware_file():

tycmd.py

@@ -49,27 +49,25 @@ def list_boards() -> list[dict]:
     return json.loads(return_string)
 
 
-def version(full: bool = False) -> str:
+def version() -> str:
     """
-    Return version information from tycmd.
-
-    Parameters
-    ----------
-    full : bool, optional
-        If True, return the full version string as returned by the tycmd binary. If
-        False, return only the version number. Default is False.
+    Return version information from tycmd binary.
 
     Returns
     -------
     str
         The version of tycmd.
+
+    Raises
+    ------
+    RuntimeError
+        If the version string could not be determined.
     """
     output = _call_tycmd(["--version"])
-    if full:
-        return output.strip()
+    match = re.search(r"\d+\.\d+\.\d+", output)
+    if match is None:
+        raise RuntimeError("Could not determine tycmd version")
     else:
-        if (match := re.search(r"\d+\.\d+\.\d+", output)) is None:
-            return ""
         return match.group()