ogc-na 0.4.2__tar.gz → 0.4.3__tar.gz

{ogc_na-0.4.2 → ogc_na-0.4.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ogc_na
-Version: 0.4.2
+Version: 0.4.3
 Summary: OGC Naming Authority tools
 Author-email: Rob Atkinson <ratkinson@ogc.org>, Piotr Zaborowski <pzaborowski@ogc.org>, Alejandro Villar <avillar@ogc.org>
 License-Expression: Apache-2.0

{ogc_na-0.4.2 → ogc_na-0.4.3}/ogc/na/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '0.4.2'
-__version_tuple__ = version_tuple = (0, 4, 2)
+__version__ = version = '0.4.3'
+__version_tuple__ = version_tuple = (0, 4, 3)
 
-__commit_id__ = commit_id = 'gecba92310'
+__commit_id__ = commit_id = 'gc3c617821'

{ogc_na-0.4.2 → ogc_na-0.4.3}/ogc/na/annotate_schema.py

@@ -609,7 +609,8 @@ class SchemaAnnotator:
 
             return used_terms
 
-        def process_subschema(subschema, context_stack, from_schema: ReferencedSchema, level=1) -> Iterable[str]:
+        def process_subschema(subschema, context_stack, from_schema: ReferencedSchema, level=1,
+                              in_defs=False) -> Iterable[str]:
             if not subschema or not isinstance(subschema, dict):
                 return ()
 
@@ -620,7 +621,8 @@ class SchemaAnnotator:
                 defs = subschema.get(p)
                 if defs and isinstance(defs, dict):
                     for entry in defs.values():
-                        used_terms.update(process_subschema(entry, context_stack, from_schema, level + 1))
+                        # Do not add to used_terms if only used in $defs
+                        process_subschema(entry, context_stack, from_schema, level + 1, in_defs=True)
 
             if '$ref' in subschema and id(subschema) not in updated_refs:
                 if self._ref_mapper:
@@ -628,8 +630,10 @@ class SchemaAnnotator:
                 if subschema['$ref'].startswith('#/') or subschema['$ref'].startswith(f"{from_schema.location}#/"):
                     target_schema = self.schema_resolver.resolve_schema(subschema['$ref'], from_schema)
                     if target_schema:
-                        used_terms.update(process_subschema(target_schema.subschema, context_stack,
-                                                            target_schema, level + 1))
+                        new_terms = process_subschema(target_schema.subschema, context_stack,
+                                                            target_schema, level + 1, in_defs=in_defs)
+                        if not in_defs:
+                            used_terms.update(new_terms)
                 updated_refs.add(id(subschema))
 
             # Annotate oneOf, allOf, anyOf
@@ -637,16 +641,22 @@ class SchemaAnnotator:
                 collection = subschema.get(p)
                 if collection and isinstance(collection, list):
                     for entry in collection:
-                        used_terms.update(process_subschema(entry, context_stack, from_schema, level + 1))
+                        new_terms = process_subschema(entry, context_stack, from_schema, level + 1, in_defs=in_defs)
+                        if not in_defs:
+                            used_terms.update(new_terms)
 
             for p in ('then', 'else', 'additionalProperties'):
                 branch = subschema.get(p)
                 if branch and isinstance(branch, dict):
-                    used_terms.update(process_subschema(branch, context_stack, from_schema, level))
+                    new_terms = process_subschema(branch, context_stack, from_schema, level, in_defs=in_defs)
+                    if not in_defs:
+                        used_terms.update(new_terms)
 
             for pp in subschema.get('patternProperties', {}).values():
                 if pp and isinstance(pp, dict):
-                    used_terms.update(process_subschema(pp, context_stack, from_schema, level + 1))
+                    new_terms = process_subschema(pp, context_stack, from_schema, level + 1, in_defs=in_defs)
+                    if not in_defs:
+                        used_terms.update(new_terms)
 
             # Annotate main schema
             schema_type = subschema.get('type')
@@ -657,7 +667,10 @@ class SchemaAnnotator:
                 used_terms.update(process_properties(subschema, context_stack, from_schema, level + 1))
             elif schema_type == 'array':
                 for k in ('prefixItems', 'items', 'contains'):
-                    used_terms.update(process_subschema(subschema.get(k), context_stack, from_schema, level + 1))
+                    new_terms = process_subschema(subschema.get(k), context_stack, from_schema, level + 1,
+                                                  in_defs=in_defs)
+                    if not in_defs:
+                        used_terms.update(new_terms)
 
             # Get prefixes
             for p, bu in subschema.get(ANNOTATION_PREFIXES, {}).items():

{ogc_na-0.4.2 → ogc_na-0.4.3}/ogc_na.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ogc_na
-Version: 0.4.2
+Version: 0.4.3
 Summary: OGC Naming Authority tools
 Author-email: Rob Atkinson <ratkinson@ogc.org>, Piotr Zaborowski <pzaborowski@ogc.org>, Alejandro Villar <avillar@ogc.org>
 License-Expression: Apache-2.0

{ogc_na-0.4.2 → ogc_na-0.4.3}/ogc_na.egg-info/SOURCES.txt

@@ -44,6 +44,7 @@ test/test_ingest_json.py
 test/test_input_filters_csv.py
 test/test_input_filters_xlsx.py
 test/test_profile.py
+test/data/annotate-defs-schema.yml
 test/data/empty.ttl
 test/data/headers.csv
 test/data/headers.xlsx

ogc_na-0.4.3/test/data/annotate-defs-schema.yml

@@ -0,0 +1,20 @@
+$schema: https://json-schema.org/draft/2020-12/schema
+x-jsonld-context: sample-context.jsonld
+$defs:
+  objectA:
+    type: object
+    properties:
+      propA:
+        type: string
+  objectB:
+    type: object
+    properties:
+      propB:
+        type: object
+        properties:
+          objectA:
+            $ref: '#/$defs/objectA'
+type: object
+properties:
+  objectB:
+      $ref: '#/$defs/objectB'

{ogc_na-0.4.2 → ogc_na-0.4.3}/test/test_annotate_schema.py

@@ -4,6 +4,7 @@ from pathlib import Path
 
 from ogc.na import annotate_schema
 from ogc.na.annotate_schema import SchemaAnnotator, ContextBuilder, ReferencedSchema, SchemaResolver
+from ogc.na.util import load_yaml
 
 THIS_DIR = Path(__file__).parent
 DATA_DIR = THIS_DIR / 'data'
@@ -65,12 +66,12 @@ class AnnotateSchemaTest(unittest.TestCase):
     def test_annotate_provided_context(self):
         annotator = SchemaAnnotator()
         schema = annotator.process_schema(DATA_DIR / 'sample-schema.yml', default_context={
-                                        '@context': {
-                                            'another': 'http://example.net/another/',
-                                            'propA': 'another:a',
-                                            'propC': 'another:c'
-                                        }
-                                    }).schema
+            '@context': {
+                'another': 'http://example.net/another/',
+                'propA': 'another:a',
+                'propC': 'another:c'
+            }
+        }).schema
 
         self.assertEqual(deep_get(schema, 'properties', 'propA', 'x-jsonld-id'), 'http://example.com/props/a')
         self.assertEqual(deep_get(schema, 'properties', 'propC', 'x-jsonld-id'), 'http://example.net/another/c')
@@ -121,3 +122,21 @@ class AnnotateSchemaTest(unittest.TestCase):
         self.assertEqual(SchemaResolver._get_branch(schema, '#/$defs/age'), anchors.get('age'))
         self.assertEqual(SchemaResolver._get_branch(schema, '#/$defs/deep/properties/inner'),
                          anchors.get('innerProp'))
+
+    def test_defs_annotation(self):
+        annotator = SchemaAnnotator()
+        orig_schema = load_yaml(DATA_DIR / 'annotate-defs-schema.yml')
+        schema = annotator.process_schema(DATA_DIR / 'annotate-defs-schema.yml', contents=orig_schema).schema
+        vocab = 'http://example.com/props/'
+        self.assertEqual(deep_get(schema, '$defs', 'objectA', 'properties', 'propA', 'x-jsonld-id'),
+                         vocab + 'a')
+        self.assertEqual(deep_get(schema, '$defs', 'objectB', 'properties', 'propB', 'x-jsonld-id'),
+                         vocab + 'b')
+
+        orig_schema = load_yaml(DATA_DIR / 'annotate-defs-schema.yml')
+        only_defs_schema = {k: v for k, v in orig_schema.items() if k in ('$schema', '$defs', 'x-jsonld-context')}
+        schema = annotator.process_schema(DATA_DIR / 'annotate-defs-schema.yml', contents=only_defs_schema).schema
+        self.assertEqual(deep_get(schema, '$defs', 'objectA', 'properties', 'propA', 'x-jsonld-id'),
+                         vocab + 'a')
+        self.assertEqual(deep_get(schema, '$defs', 'objectB', 'properties', 'propB', 'x-jsonld-id'),
+                         vocab + 'b')