Expose package version as __version__

Many other packages use this convention.

Signed-off-by: John Pennycook <[email protected]>

Author: Pennycook

codebasin/__init__.py

@@ -1,5 +1,6 @@
 # Copyright (C) 2019-2024 Intel Corporation
 # SPDX-License-Identifier: BSD-3-Clause
+import importlib.metadata
 import os
 import shlex
 import warnings
@@ -19,6 +20,8 @@
     DeprecationWarning,
 )
 
+__version__ = importlib.metadata.version("codebasin")
+
 
 class CompileCommand:
     """

codebasin/__main__.py

@@ -6,16 +6,14 @@
 """
 
 import argparse
-import importlib.metadata
 import logging
 import os
 import sys
 
-from codebasin import CodeBase, config, finder, report, util
+from codebasin import CodeBase, __version__, config, finder, report, util
 from codebasin._detail.logging import Formatter, WarningAggregator
 
 log = logging.getLogger("codebasin")
-version = importlib.metadata.version("codebasin")
 
 _traceback = False
 
@@ -60,7 +58,7 @@ def _help_string(*lines: str, is_long=False, is_last=False):
 def _main():
     # Read command-line arguments
     parser = argparse.ArgumentParser(
-        description="Code Base Investigator " + str(version),
+        description="Code Base Investigator " + str(__version__),
         formatter_class=argparse.RawTextHelpFormatter,
         add_help=False,
     )
@@ -73,7 +71,7 @@ def _main():
     parser.add_argument(
         "--version",
         action="version",
-        version=f"Code Base Investigator {version}",
+        version=f"Code Base Investigator {__version__}",
         help=_help_string("Display version information and exit."),
     )
     parser.add_argument(
@@ -181,7 +179,9 @@ def _main():
     log.addHandler(file_handler)
 
     if args.debug:
-        log.debug(f"Code Base Investigator {version}; Python {sys.version}")
+        log.debug(
+            f"Code Base Investigator {__version__}; Python {sys.version}",
+        )
 
     # Inform the user that a log file has been created.
     # 'print' instead of 'log' to ensure the message is visible in the output.

codebasin/coverage/__main__.py

@@ -9,15 +9,10 @@
 import os
 import sys
 
-from codebasin import CodeBase, config, finder, util
+from codebasin import CodeBase, __version__, config, finder, util
 
 # TODO: Refactor to avoid imports from __main__
-from codebasin.__main__ import (
-    Formatter,
-    WarningAggregator,
-    _help_string,
-    version,
-)
+from codebasin.__main__ import Formatter, WarningAggregator, _help_string
 from codebasin.preprocessor import CodeNode
 
 log = logging.getLogger("codebasin")
@@ -28,7 +23,7 @@ def _build_parser() -> argparse.ArgumentParser:
     Build argument parser.
     """
     parser = argparse.ArgumentParser(
-        description="CBI Coverage Tool " + version,
+        description="CBI Coverage Tool " + __version__,
         formatter_class=argparse.RawTextHelpFormatter,
         add_help=False,
     )
@@ -42,7 +37,7 @@ def _build_parser() -> argparse.ArgumentParser:
     parser.add_argument(
         "--version",
         action="version",
-        version=f"CBI Coverage Tool {version}",
+        version=f"CBI Coverage Tool {__version__}",
         help="Display version information and exit.",
     )
 

codebasin/tree.py

@@ -7,10 +7,10 @@
 import os
 import sys
 
-from codebasin import CodeBase, config, finder, report, util
+from codebasin import CodeBase, __version__, config, finder, report, util
 
 # TODO: Refactor to avoid imports from __main__
-from codebasin.__main__ import Formatter, _help_string, version
+from codebasin.__main__ import Formatter, _help_string
 
 log = logging.getLogger("codebasin")
 
@@ -20,7 +20,7 @@ def _build_parser() -> argparse.ArgumentParser:
     Build argument parser.
     """
     parser = argparse.ArgumentParser(
-        description="CBI Tree Tool " + version,
+        description="CBI Tree Tool " + __version__,
         formatter_class=argparse.RawTextHelpFormatter,
         add_help=False,
     )
@@ -33,7 +33,7 @@ def _build_parser() -> argparse.ArgumentParser:
     parser.add_argument(
         "--version",
         action="version",
-        version=f"CBI Coverage Tool {version}",
+        version=f"CBI Coverage Tool {__version__}",
         help=_help_string("Display version information and exit."),
     )
     parser.add_argument(