rahix/openflexure-microscope-server
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Apply suggestions from code review of branch update-setting-manager

Browse source 
Co-authored-by: Joe Knapper <joe.knapper@glasgow.ac.uk>
Co-authored-by: Beth Probert <beth_probert@outlook.com>
This commit is contained in:
Julian Stirling 2025-07-14 15:46:13 +00:00
parent e614ec577e
commit 34f8f86ef2
2 changed files with 10 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

14
src/openflexure_microscope_server/utilities.py
View file

@ -104,7 +104,7 @@ class VersionData(BaseModel):
version_source: str version_source: str
def robust_version_strings() -> tuple[str, str]: def robust_version_strings() -> VersionData:
"""Return a version string and information on its source. """Return a version string and information on its source.
Returning a python version string is not without problems. If the package is Returning a python version string is not without problems. If the package is
@ -118,7 +118,7 @@ def robust_version_strings() -> tuple[str, str]:
installation from source. Return the version string from the toml file and installation from source. Return the version string from the toml file and
return the literal string "TOML" as its source. return the literal string "TOML" as its source.
3. If a Git directory is available but no pyproject.toml then something is very 3. If a Git directory is available but no pyproject.toml then something is very
weird log an error. Then return "Undefined" as the version string, but still weird - log an error. Then return "Undefined" as the version string, but still
return the Git hash as the source. return the Git hash as the source.
4. Finally if neither a Git directory nor a pyproject.toml are available then the 4. Finally if neither a Git directory nor a pyproject.toml are available then the
server has been installed from a distribution package (i.e. a wheel). In this server has been installed from a distribution package (i.e. a wheel). In this
@ -152,9 +152,10 @@ def robust_version_strings() -> tuple[str, str]:
ver = "Undefined" ver = "Undefined"
source = _get_hash_from_git_dir(git_dir_path) source = _get_hash_from_git_dir(git_dir_path)
else: else:
# "Neither probably installed from wheel. Note this can # Has neither .git nor pyproject.toml. It is probably installed from wheel.
# be unreliable if the package is not installed as a distribution. # This will be the expected method of packaging in the future. This option
# This is why it is the last option. # is handled last as ``importlib.metadata.version`` can be unreliable if
# the package is no installed as a distribution package.
ver = "v" + version("openflexure_microscope_server") ver = "v" + version("openflexure_microscope_server")
source = "Dist" source = "Dist"
return VersionData(version=ver, version_source=source) return VersionData(version=ver, version_source=source)
@ -222,7 +223,8 @@ def _get_version_from_toml(toml_path: str) -> str:
:param toml_path: The path to the toml file. :param toml_path: The path to the toml file.
:returns: The version string directly as reported in the toml file. :returns: The version string directly as reported in the toml file, or "Undefined"
if there is any error, errors are logged not raised.
""" """
try: try:
with open(toml_path, "rb") as toml_file: with open(toml_path, "rb") as toml_file:

4
tests/test_version_strings.py
View file

@ -80,7 +80,7 @@ def git_repo(temp_dir):
create_fake_file() create_fake_file()
create_fake_file() create_fake_file()
_git("add -A") _git("add -A")
_git("commit -m 'message'") _git("commit -m 'message2'")
yield temp_dir yield temp_dir
@ -175,7 +175,7 @@ def test_reading_hash_from_git():
create_fake_file() create_fake_file()
create_fake_file() create_fake_file()
_git("add -A") _git("add -A")
_git("commit -m 'message'") _git("commit -m 'message2'")
git_hash2 = _git("rev-parse HEAD") git_hash2 = _git("rev-parse HEAD")
assert utilities._get_hash_from_git_dir(git_dir) == git_hash2 assert utilities._get_hash_from_git_dir(git_dir) == git_hash2