ogc-na 0.3.49__tar.gz → 0.3.51__tar.gz

{ogc_na-0.3.49 → ogc_na-0.3.51}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ogc_na
-Version: 0.3.49
+Version: 0.3.51
 Summary: OGC Naming Authority tools
 Author-email: Rob Atkinson <ratkinson@ogc.org>, Piotr Zaborowski <pzaborowski@ogc.org>, Alejandro Villar <avillar@ogc.org>
 Project-URL: Homepage, https://github.com/opengeospatial/ogc-na-tools/

{ogc_na-0.3.49 → ogc_na-0.3.51}/ogc/na/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.3.49'
-__version_tuple__ = version_tuple = (0, 3, 49)
+__version__ = version = '0.3.51'
+__version_tuple__ = version_tuple = (0, 3, 51)

{ogc_na-0.3.49 → ogc_na-0.3.51}/ogc/na/annotate_schema.py

@@ -143,12 +143,18 @@ ANNOTATION_ID = f'{ANNOTATION_PREFIX}id'
 ANNOTATION_PREFIXES = f'{ANNOTATION_PREFIX}prefixes'
 ANNOTATION_EXTRA_TERMS = f'{ANNOTATION_PREFIX}extra-terms'
 ANNOTATION_BASE = f'{ANNOTATION_PREFIX}base'
+ANNOTATION_VOCAB = f'{ANNOTATION_PREFIX}vocab'
 
 ANNOTATION_IGNORE_EXPAND = [ANNOTATION_CONTEXT, ANNOTATION_EXTRA_TERMS, ANNOTATION_PREFIXES]
 
 CURIE_TERMS = '@id', '@type', '@index'
 
-UNDEFINED = object()
+class Undefined:
+
+    def __bool__(self):
+        return False
+
+UNDEFINED = Undefined()
 
 context_term_cache = LRUCache(maxsize=20)
 requests_session = requests_cache.CachedSession('ogc.na.annotate_schema', backend='memory', expire_after=180)
@@ -228,7 +234,7 @@ class SchemaResolver:
         return location, fragment
 
     def resolve_schema(self, ref: str | Path, from_schema: ReferencedSchema | None = None,
-                       force_contents: dict | None = None) -> ReferencedSchema | None:
+                       force_contents: dict | str | None = None) -> ReferencedSchema | None:
         chain = from_schema.chain + [from_schema] if from_schema else []
         try:
             schema_source, fragment = self.resolve_ref(ref, from_schema)
@@ -248,9 +254,14 @@ class SchemaResolver:
                                         ref=ref,
                                         is_json=from_schema.is_json)
 
-            contents, is_json = self.load_contents(schema_source)
             if force_contents:
-                contents = force_contents
+                is_json = False
+                if isinstance(force_contents, str):
+                    contents = load_yaml(content=force_contents)
+                else:
+                    contents = force_contents
+            else:
+                contents, is_json = self.load_contents(schema_source)
             if fragment:
                 return ReferencedSchema(location=schema_source, fragment=fragment,
                                         subschema=SchemaResolver._get_branch(contents, fragment),
@@ -635,6 +646,10 @@ class SchemaAnnotator:
 
         process_subschema(schema, [context], resolved_schema)
 
+        for key in ('@base', '@vocab'):
+            if context.get(key):
+                schema[f"{ANNOTATION_PREFIX}{key[1:]}"] = context[key]
+
         if prefixes:
             schema[ANNOTATION_PREFIXES] = prefixes
 
@@ -650,9 +665,10 @@ class ContextBuilder:
     Builds a JSON-LD context from a set of annotated JSON schemas.
     """
 
-    def __init__(self, location: Path | str = None,
+    def __init__(self, location: Path | str,
                  compact: bool = True,
                  schema_resolver: SchemaResolver = None,
+                 contents: dict | str | None = None,
                  version=1.1):
         """
         :param location: file or URL load the annotated schema from
@@ -668,19 +684,20 @@ class ContextBuilder:
 
         self.visited_properties: dict[str, str | None] = {}
         self._missed_properties: dict[str, Any] = {}  # Dict instead of set to keep order of insertion
-        context = self._build_context(self.location, compact)
+        context = self._build_context(self.location, compact, contents=contents)
         if context:
             context['@version'] = version
         self.context = {'@context': context}
 
     def _build_context(self, schema_location: str | Path,
-                       compact: bool = True) -> dict:
+                       compact: bool = True,
+                       contents: dict | str | None = None) -> dict:
 
         parsed = self._parsed_schemas.get(schema_location)
         if parsed:
             return parsed
 
-        root_schema = self.schema_resolver.resolve_schema(schema_location)
+        root_schema = self.schema_resolver.resolve_schema(schema_location, force_contents=contents)
 
         prefixes = {}
 
@@ -748,8 +765,10 @@ class ContextBuilder:
             if not isinstance(subschema, dict):
                 return {}
 
-            if subschema.get(ANNOTATION_BASE):
-                onto_context['@base'] = subschema[ANNOTATION_BASE]
+            for key in (ANNOTATION_BASE, ANNOTATION_VOCAB):
+                top_level_value = subschema.get(key)
+                if top_level_value:
+                    onto_context[f"@{key[len(ANNOTATION_PREFIX):]}"] = top_level_value
 
             read_properties(subschema, from_schema, onto_context, schema_path)
 

{ogc_na-0.3.49 → ogc_na-0.3.51}/ogc/na/ingest_json.py

@@ -686,7 +686,7 @@ def process(input_files: str | Path | Sequence[str | Path],
     if isinstance(input_files, str) or not isinstance(input_files, Sequence):
         input_files = (input_files,)
     if batch:
-        logger.info("Input files: %s", input_files)
+        logger.info("Input files: %s", [str(x) for x in input_files])
         remaining_fn: deque = deque()
         for input_file in input_files:
             if isinstance(input_file, str):
@@ -735,6 +735,8 @@ def process(input_files: str | Path | Sequence[str | Path],
                     logger.warning("Error processing JSON/JSON-LD file, skipping: %s", getattr(e, 'msg', str(e)))
                 else:
                     raise
+            except Exception as e:
+                raise IOError(f'Error processing input file {fn}') from e
     else:
         for input_file in input_files:
             try:

{ogc_na-0.3.49 → ogc_na-0.3.51}/ogc_na.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ogc_na
-Version: 0.3.49
+Version: 0.3.51
 Summary: OGC Naming Authority tools
 Author-email: Rob Atkinson <ratkinson@ogc.org>, Piotr Zaborowski <pzaborowski@ogc.org>, Alejandro Villar <avillar@ogc.org>
 Project-URL: Homepage, https://github.com/opengeospatial/ogc-na-tools/

{ogc_na-0.3.49 → ogc_na-0.3.51}/test/test_annotate_schema.py

@@ -2,7 +2,7 @@ import unittest
 from pathlib import Path
 
 from ogc.na import annotate_schema
-from ogc.na.annotate_schema import SchemaAnnotator
+from ogc.na.annotate_schema import SchemaAnnotator, ContextBuilder
 
 THIS_DIR = Path(__file__).parent
 DATA_DIR = THIS_DIR / 'data'
@@ -90,3 +90,22 @@ class AnnotateSchemaTest(unittest.TestCase):
         self.assertEqual(deep_get(schema, 'properties', 'propB', 'x-jsonld-id'), '@id')
         self.assertEqual(deep_get(schema, 'properties', 'propC', 'x-jsonld-id'), 'http://www.another.com/')
         self.assertEqual(deep_get(schema, 'properties', 'propD', 'x-jsonld-id'), vocab + 'propD')
+
+    def test_top_level_keywords(self):
+        annotator = SchemaAnnotator()
+        vocab = 'http://example.com/vocab#'
+        base = 'http://example.net/'
+        schema = annotator.process_schema(DATA_DIR / 'sample-schema-prop-c.yml', default_context={
+            '@context': {
+                '@base': base,
+                '@vocab': vocab,
+            }
+        }).schema
+
+        self.assertEqual(schema.get('x-jsonld-vocab'), vocab)
+        self.assertEqual(schema.get('x-jsonld-base'), base)
+
+        builder = ContextBuilder('http://example.com/schema.yaml', contents=schema)
+
+        self.assertEqual(deep_get(builder.context, '@context', '@vocab'), vocab)
+        self.assertEqual(deep_get(builder.context, '@context', '@base'), base)