specware 1.3.0__tar.gz → 1.3.2__tar.gz

{specware-1.3.0 → specware-1.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: specware
-Version: 1.3.0
+Version: 1.3.2
 Summary: Provides utilities to specify software.
 Keywords: certification,documentation,markdown,qualification,requirements-management,traceability
 Author: The specware Authors

{specware-1.3.0 → specware-1.3.2}/pyproject.toml

@@ -4,7 +4,7 @@
 
 [project]
 name = "specware"
-version = "1.3.0"
+version = "1.3.2"
 description = "Provides utilities to specify software."
 authors = [
     {name = "The specware Authors", email = "specthings@embedded-brains.de"}

{specware-1.3.0 → specware-1.3.2}/src/specware/clifind.py

@@ -32,7 +32,8 @@ import os
 import sys
 
 from specitems import (Item)
-from specware import (open_tree, get_items_by_type_map,
+from specware import (exit_on_config_file_error, open_tree,
+                      get_items_by_type_map,
                       get_benchmark_and_test_suite_items,
                       get_interface_and_requirement_items,
                       get_validation_items)
@@ -60,6 +61,7 @@ def _process_item_data(cwd: str, file_to_item: dict[str, list[str]],
                 os.path.normpath(os.path.relpath(item.file, cwd)))
 
 
+@exit_on_config_file_error
 def clifind(argv: list[str] = sys.argv) -> None:
     """ Find the items related to generated files. """
     cwd = os.getcwd()

{specware-1.3.0 → specware-1.3.2}/src/specware/cliview.py

@@ -35,11 +35,12 @@ from specitems import (COL_SPAN, CommonMarkContent, Item, ItemCache,
                        ItemGetValueContext, ItemMapper, Link, MarkdownContent,
                        ROW_SPAN, SphinxContent, TextContent, yield_tasks)
 
-from specware import (open_tree, augment_with_test_case_links,
-                      augment_with_test_links, gather_api_items,
-                      gather_build_files, get_register_bits_run,
-                      get_register_member_name, recursive_is_enabled,
-                      Transition, TransitionMap, validate)
+from specware import (exit_on_config_file_error, open_tree,
+                      augment_with_test_case_links, augment_with_test_links,
+                      gather_api_items, gather_build_files,
+                      get_register_bits_run, get_register_member_name,
+                      recursive_is_enabled, Transition, TransitionMap,
+                      validate)
 
 _DOC_FORMAT = {
     "commonmark": CommonMarkContent,
@@ -656,6 +657,7 @@ def _parse_args(argv: list[str]) -> argparse.Namespace:
     return parser.parse_args(argv[1:])
 
 
+@exit_on_config_file_error
 def cliview(argv: list[str] = sys.argv):
     """ View the specification. """
 

{specware-1.3.0 → specware-1.3.2}/src/specware/util.py

@@ -26,16 +26,20 @@
 
 import argparse
 import contextlib
+import functools
 import logging
 import os
 from pathlib import Path
 import subprocess
-from typing import Any, Callable, Iterator, NamedTuple, Optional, Union
+import sys
+from typing import (Any, Callable, Iterator, NamedTuple, Optional, TypeVar,
+                    Union, cast)
 
 from specitems import (ClangFormatter, IsEnabled, Item, ItemCache,
                        ItemCacheConfig, ItemDataByUID, SpecTypeProvider,
-                       create_config, find_config_file, load_config_item,
-                       monitor_logging, pickle_load_data_by_uid)
+                       create_config, create_type_provider, find_config_file,
+                       load_config_item, monitor_logging,
+                       pickle_load_data_by_uid)
 
 
 class ClangFormatError(Exception):
@@ -156,7 +160,7 @@ def run_with_clang_formatter(
     with monitor_logging() as monitor:
         try:
             run(create_clang_formatter(args))
-        except ClangFormatError as err:
+        except (ClangFormatError, ConfigFileError) as err:
             logging.error("%s", err)
         except subprocess.CalledProcessError as err:
             log_clang_format_failure(err)
@@ -214,6 +218,35 @@ def run_command(args: list[str],
         return actual_status
 
 
+class ConfigFileError(Exception):
+    """ Indicates that the configuration file is missing or invalid. """
+
+
+_Function = TypeVar("_Function", bound=Callable[..., Any])
+
+
+def exit_on_config_file_error(function: _Function) -> _Function:
+    """
+    Make the command exit with a message where its configuration file is
+    missing or invalid.
+
+    Args:
+        function: The command.
+
+    Returns:
+        The command which exits with status 1 on a :class:`ConfigFileError`.
+    """
+
+    @functools.wraps(function)
+    def _run(*args: Any, **kwargs: Any) -> Any:
+        try:
+            return function(*args, **kwargs)
+        except ConfigFileError as err:
+            sys.exit(str(err))
+
+    return cast(_Function, _run)
+
+
 class Tree(NamedTuple):
     """ Is the tree of a configuration file. """
 
@@ -243,11 +276,20 @@ def open_tree(config_file: Optional[str],
         is_item_enabled: The optional enabled status of an item.
         enabled_set: The optional enabled set of the item cache.
 
+    The configuration is verified with the types of every installed package,
+    so it may state tasks of the tools of another package.
+
     Yields:
         The tree.
+
+    Raises:
+        ConfigFileError: The configuration file is missing or invalid.
     """
+    try:
+        config = load_config_item(config_file, create_type_provider())
+    except (FileNotFoundError, ValueError) as err:
+        raise ConfigFileError(str(err)) from err
     type_provider = SpecWareTypeProvider({})
-    config = load_config_item(config_file, type_provider)
     directory = str(find_config_file(config_file).parent)
     with contextlib.chdir(directory):
         item_cache_config = create_config(config["item-cache"],