specitems 1.7.1__tar.gz → 1.7.2__tar.gz

{specitems-1.7.1 → specitems-1.7.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: specitems
-Version: 1.7.1
+Version: 1.7.2
 Summary: Provides interfaces to work with specification items.
 Keywords: certification,documentation,markdown,qualification,requirements-management,traceability
 Author: The specitems Authors

{specitems-1.7.1 → specitems-1.7.2}/pyproject.toml

@@ -4,7 +4,7 @@
 
 [project]
 name = "specitems"
-version = "1.7.1"
+version = "1.7.2"
 description = "Provides interfaces to work with specification items."
 authors = [
     {name = "The specitems Authors", email = "specthings@embedded-brains.de"}

{specitems-1.7.1 → specitems-1.7.2}/src/specitems/__init__.py

@@ -145,9 +145,10 @@ from .itemmapper import (
 from .licenseinfo import (LicenseAggregate, LicenseEntry, LicenseProvider)
 from .spdx import (get_license_list_version, parse_license_expression,
                    parse_license_identifier, permits)
-from .specconfig import (CONFIG_FILE, CONFIG_UID, check_license_items,
-                         create_content_context, create_type_provider,
-                         find_config_file, load_config_item, yield_tasks)
+from .specconfig import (CONFIG_FILE, CONFIG_UID, add_inline_items,
+                         check_license_items, create_content_context,
+                         create_type_provider, find_config_file,
+                         load_config_item, yield_tasks)
 from .specdoc import (SpecDocumentConfig, add_specification_documentation,
                       generate_specification_documentation)
 from .specformatter import SpecYAMLFormatter
@@ -218,6 +219,7 @@ __all__ = [
     "SubstitutionError",
     "TextContent",
     "TextMapper",
+    "add_inline_items",
     "add_license_arguments",
     "add_specification_documentation",
     "atomic_dump_to_file",

{specitems-1.7.1 → specitems-1.7.2}/src/specitems/specconfig.py

@@ -24,6 +24,7 @@
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 # POSSIBILITY OF SUCH DAMAGE.
 
+import copy
 import logging
 from pathlib import Path
 from typing import Any, Iterator, Optional
@@ -31,8 +32,8 @@ from typing import Any, Iterator, Optional
 from .cliutil import load_config
 from .content import ContentContext
 from .licenseinfo import LicenseAggregate, LicenseProvider
-from .items import (EmptyItemCache, Item, ItemDataByUID, ItemTypeProvider,
-                    SpecTypeProvider)
+from .items import (EmptyItemCache, Item, ItemCache, ItemDataByUID,
+                    ItemTypeProvider, SpecTypeProvider)
 from .specverify import SpecVerifier
 
 #: The name of the configuration file of a tree.
@@ -204,6 +205,41 @@ def check_license_items(config: Item, provider: LicenseProvider) -> None:
         raise ValueError("\n".join(errors))
 
 
+def add_inline_items(config: Item, item_cache: ItemCache) -> None:
+    """
+    Add the inline items of the configuration to the item cache.
+
+    An inline item is part of the configuration file.  It takes the license
+    and the copyrights of the configuration item, unless it states its own.
+    An inline item without links gets an empty list of links.  An inline item
+    without an enabled-by attribute is enabled.  An inline item without a type
+    has the inline type.  An inline item may link to another inline item.
+
+    Args:
+        config: The configuration item.
+        item_cache: The item cache of the tree.
+
+    Raises:
+        ValueError: An inline item exists already in the item cache or in the
+            configuration.
+    """
+    data_by_uid: ItemDataByUID = {}
+    for entry in config.get("inline-items", []):
+        uid = entry["uid"]
+        if (uid in item_cache or uid in item_cache.proxies
+                or uid in data_by_uid):
+            raise ValueError(f"the inline item {uid} exists already")
+        data = copy.deepcopy(entry["data"])
+        for key, value in (("SPDX-License-Identifier",
+                            config["SPDX-License-Identifier"]),
+                           ("copyrights", config["copyrights"]),
+                           ("enabled-by", True), ("links", []), ("type",
+                                                                 "inline")):
+            data.setdefault(key, copy.deepcopy(value))
+        data_by_uid[uid] = data
+    item_cache.add_items(data_by_uid)
+
+
 def yield_tasks(config: Item, task_type: str) -> Iterator[dict]:
     """
     Yield the tasks of the type in the order of the configuration.