Centralize namespace constants in namespace.py

References:
* #38
* [UCO OC-217] (CP-107) Revise ontology IRI to be slash-based and drop
  IRI base
* [ONT-64] (CP-17) Define scheme for CASE and UCO importable versioned
  IRIs

Signed-off-by: Alex Nelson <[email protected]>

Author: ajnelson-nist

case_utils/case_file/__init__.py

@@ -26,20 +26,10 @@
 import rdflib  # type: ignore
 
 import case_utils
+from case_utils.namespace import *
 
 DEFAULT_PREFIX = "http://example.org/kb/"
 
-NS_RDF = rdflib.RDF
-NS_UCO_CORE = rdflib.Namespace("https://unifiedcyberontology.org/ontology/uco/core#")
-NS_UCO_OBSERVABLE = rdflib.Namespace(
-    "https://unifiedcyberontology.org/ontology/uco/observable#"
-)
-NS_UCO_TYPES = rdflib.Namespace("https://unifiedcyberontology.org/ontology/uco/types#")
-NS_UCO_VOCABULARY = rdflib.Namespace(
-    "https://unifiedcyberontology.org/ontology/uco/vocabulary#"
-)
-NS_XSD = rdflib.XSD
-
 # Shortcut syntax for defining an immutable named tuple is noted here:
 # https://docs.python.org/3/library/typing.html#typing.NamedTuple
 # via the "See also" box here: https://docs.python.org/3/library/collections.html#collections.namedtuple

case_utils/namespace.py

@@ -0,0 +1,38 @@
+#!/usr/bin/env python3
+
+# This software was developed at the National Institute of Standards
+# and Technology by employees of the Federal Government in the course
+# of their official duties. Pursuant to title 17 Section 105 of the
+# United States Code this software is not subject to copyright
+# protection and is in the public domain. NIST assumes no
+# responsibility whatsoever for its use by other parties, and makes
+# no guarantees, expressed or implied, about its quality,
+# reliability, or any other characteristic.
+#
+# We would appreciate acknowledgement if the software is used.
+
+"""
+This module provides importable constants for namespaces.
+
+To use, add "from case_utils.namespace import *".  Namespace variables starting with "NS_" are imported.  As needs are demonstrated in CASE tooling (both in case_utils and from downstream requests), namespaces will also be imported from rdflib for a consistent "NS_*" spelling.
+"""
+
+import rdflib  # type: ignore
+
+NS_SH = rdflib.SH
+NS_RDF = rdflib.RDF
+NS_XSD = rdflib.XSD
+
+NS_CASE_INVESTIGATION = rdflib.Namespace(
+    "https://ontology.caseontology.org/case/investigation/"
+)
+NS_UCO_ACTION = rdflib.Namespace("https://unifiedcyberontology.org/ontology/uco/action#")
+NS_UCO_CORE = rdflib.Namespace("https://unifiedcyberontology.org/ontology/uco/core#")
+NS_UCO_LOCATION = rdflib.Namespace("https://unifiedcyberontology.org/ontology/uco/location#")
+NS_UCO_OBSERVABLE = rdflib.Namespace(
+    "https://unifiedcyberontology.org/ontology/uco/observable#"
+)
+NS_UCO_TYPES = rdflib.Namespace("https://unifiedcyberontology.org/ontology/uco/types#")
+NS_UCO_VOCABULARY = rdflib.Namespace(
+    "https://unifiedcyberontology.org/ontology/uco/vocabulary#"
+)

tests/case_utils/case_file/Makefile

@@ -127,6 +127,7 @@ sample.txt.json: \
   $(tests_srcdir)/src/isomorphic_diff.py \
   $(top_srcdir)/case_utils/case_file/__init__.py \
   $(top_srcdir)/case_utils/local_uuid.py \
+  $(top_srcdir)/case_utils/namespace.py \
   sample.txt-nocompact.json
 	rm -f $@ _$@ __$@
 	export DEMO_UUID_REQUESTING_NONRANDOM=NONRANDOM_REQUESTED \
@@ -158,6 +159,7 @@ sample.txt.ttl: \
   $(tests_srcdir)/.venv.done.log \
   $(top_srcdir)/case_utils/case_file/__init__.py \
   $(top_srcdir)/case_utils/local_uuid.py \
+  $(top_srcdir)/case_utils/namespace.py \
   sample.txt.done.log
 	rm -f _$@ __$@
 	export DEMO_UUID_REQUESTING_NONRANDOM=NONRANDOM_REQUESTED \
@@ -180,6 +182,7 @@ sample.txt-disable_hashes.ttl: \
   $(tests_srcdir)/.venv.done.log \
   $(top_srcdir)/case_utils/case_file/__init__.py \
   $(top_srcdir)/case_utils/local_uuid.py \
+  $(top_srcdir)/case_utils/namespace.py \
   sample.txt.done.log
 	rm -f _$@ __$@
 	export DEMO_UUID_REQUESTING_NONRANDOM=NONRANDOM_REQUESTED \
@@ -204,6 +207,7 @@ sample.txt-nocompact.json: \
   $(tests_srcdir)/src/isomorphic_diff.py \
   $(top_srcdir)/case_utils/case_file/__init__.py \
   $(top_srcdir)/case_utils/local_uuid.py \
+  $(top_srcdir)/case_utils/namespace.py \
   sample.txt.done.log
 	rm -f _$@
 	export DEMO_UUID_REQUESTING_NONRANDOM=NONRANDOM_REQUESTED \

tests/case_utils/case_file/test_case_file.py

@@ -19,22 +19,14 @@
 import rdflib.plugins.sparql  # type: ignore
 
 import case_utils.ontology
+from case_utils.namespace import *
 
 _logger = logging.getLogger(os.path.basename(__file__))
 
-IRI_UCO_CORE = "https://unifiedcyberontology.org/ontology/uco/core#"
-IRI_UCO_OBSERVABLE = "https://unifiedcyberontology.org/ontology/uco/observable#"
-IRI_UCO_TYPES = "https://unifiedcyberontology.org/ontology/uco/types#"
-
-NS_RDF = rdflib.RDF
-NS_UCO_CORE = rdflib.Namespace(IRI_UCO_CORE)
-NS_UCO_OBSERVABLE = rdflib.Namespace(IRI_UCO_OBSERVABLE)
-NS_UCO_TYPES = rdflib.Namespace(IRI_UCO_TYPES)
-
 NSDICT = {
-    "uco-core": IRI_UCO_CORE,
-    "uco-observable": IRI_UCO_OBSERVABLE,
-    "uco-types": IRI_UCO_TYPES,
+    "uco-core": NS_UCO_CORE,
+    "uco-observable": NS_UCO_OBSERVABLE,
+    "uco-types": NS_UCO_TYPES,
 }
 
 SRCDIR = os.path.dirname(__file__)