shacl2code 0.0.25__tar.gz → 1.0.1__tar.gz

shacl2code-1.0.1/.clang-format

@@ -0,0 +1,8 @@
+BasedOnStyle: LLVM
+ 
+# Breaking string literals when combined with a column limit can result in some
+# really terribly-formatted source where there are many lines in a row that each
+# consist of string literals that only contain one or two characters each.
+BreakStringLiterals: false
+ 
+ColumnLimit: 100

shacl2code-1.0.1/.flake8

@@ -0,0 +1,15 @@
+[flake8]
+# E501 line too long - Handled by black
+# E203 whitespace before ':' - Handled by black
+extend-ignore = E501,E203
+
+# These execptions are made to keep stub compact / keep imported types info
+# E301: Expected 2 blank lines, found 1
+# E302: Expected 2 blank lines, found 0
+# E305: Expected 2 blank lines after end of function or class
+# E701: Multiple statements on one line (colon)
+# F401: Module imported but unused
+per-file-ignores =
+    *.pyi: E301,E302,E305,E701,F401
+
+application-import-names = shacl2code,testfixtures

{shacl2code-0.0.25 → shacl2code-1.0.1}/.github/workflows/test.yaml

@@ -57,5 +57,13 @@ jobs:
         uses: actions/setup-python@65d7f2d534ac1bc67fcd62888c5f4f3d2cb2b236 # v4.7.1
         with:
           python-version: "3.11"
-      - uses: psf/black@8a737e727ac5ab2f1d4cf5876720ed276dc8dc4b # 25.1.0
+      - uses: psf/black@6305bf1ae645ab7541be4f5028a86239316178eb # 26.1.0
       - uses: py-actions/flake8@84ec6726560b6d5bd68f2a5bed83d62b52bb50ba # v2.3.0
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install clang-format
+      - name: Check code formatting
+        run: |
+          ./scripts/format.sh
+          git diff --exit-code

{shacl2code-0.0.25 → shacl2code-1.0.1}/.gitignore

@@ -153,12 +153,18 @@ dmypy.json
 # Cython debug symbols
 cython_debug/
 
+# Ruff
+.ruff_cache/
+
 # PyCharm
 #  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
 #  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
-#.idea/
+.idea/
+
+# VS Code
+.vscode/
 
 # macOS system files
 .DS_Store

{shacl2code-0.0.25 → shacl2code-1.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: shacl2code
-Version: 0.0.25
+Version: 1.0.1
 Summary: Convert SHACL model file to code bindings
 Project-URL: Homepage, https://github.com/JPEWdev/shacl2code
 Project-URL: Repository, https://github.com/JPEWdev/shacl2code.git
@@ -23,14 +23,16 @@ Requires-Python: >=3.8
 Requires-Dist: jinja2>=3.1.2
 Requires-Dist: rdflib>=7.0.0
 Provides-Extra: dev
+Requires-Dist: flake8-import-order>=0.19.2; extra == 'dev'
 Requires-Dist: flake8>=7.0.0; extra == 'dev'
-Requires-Dist: jsonschema>=4.21.1; extra == 'dev'
+Requires-Dist: jsonschema>=4.23.0; extra == 'dev'
 Requires-Dist: mypy>=1.14.1; extra == 'dev'
-Requires-Dist: pyrefly>=0.28.1; extra == 'dev'
+Requires-Dist: pyrefly>=0.55.0; extra == 'dev'
 Requires-Dist: pyright>=1.1.403; extra == 'dev'
 Requires-Dist: pyshacl>=0.25.0; extra == 'dev'
 Requires-Dist: pytest-cov>=4.1; extra == 'dev'
 Requires-Dist: pytest>=7.4; extra == 'dev'
+Requires-Dist: types-jsonschema>=4.23.0; extra == 'dev'
 Description-Content-Type: text/markdown
 
 # Convert SHACL Model to code bindings
@@ -54,19 +56,19 @@ python3 -m pip install shacl2code
 `shacl2code` can generate bindings from either a local file:
 
 ```shell
-shacl2code generate -i model.jsonld python -o out.py
+shacl2code generate -i model.jsonld python -o out
 ```
 
 Or from a URL:
 
 ```shell
-shacl2code generate -i https://example.com/rdf/model.jsonld python -o out.py
+shacl2code generate -i https://example.com/rdf/model.jsonld python -o out
 ```
 
 Or from stdin:
 
 ```shell
-cat model.jsonld | shacl2code generate -i - python -o - > out.py
+cat model.jsonld | shacl2code generate -i - python -o out
 ```
 
 For more information, run:

{shacl2code-0.0.25 → shacl2code-1.0.1}/README.md

@@ -19,19 +19,19 @@ python3 -m pip install shacl2code
 `shacl2code` can generate bindings from either a local file:
 
 ```shell
-shacl2code generate -i model.jsonld python -o out.py
+shacl2code generate -i model.jsonld python -o out
 ```
 
 Or from a URL:
 
 ```shell
-shacl2code generate -i https://example.com/rdf/model.jsonld python -o out.py
+shacl2code generate -i https://example.com/rdf/model.jsonld python -o out
 ```
 
 Or from stdin:
 
 ```shell
-cat model.jsonld | shacl2code generate -i - python -o - > out.py
+cat model.jsonld | shacl2code generate -i - python -o out
 ```
 
 For more information, run:

{shacl2code-0.0.25 → shacl2code-1.0.1}/pyproject.toml

@@ -29,13 +29,15 @@ license = "MIT"
 [project.optional-dependencies]
 dev = [
     "flake8 >= 7.0.0",
-    "jsonschema >= 4.21.1",
+    "flake8-import-order >= 0.19.2",
+    "jsonschema >= 4.23.0",  # latest version for Python 3.8 is 4.23.x
     "mypy >= 1.14.1",  # latest version for Python 3.8 is 1.14.x
-    "pyrefly >= 0.28.1",
+    "pyrefly >= 0.55.0",
     "pyright >= 1.1.403",
     "pyshacl >= 0.25.0",
     "pytest >= 7.4",
     "pytest-cov >= 4.1",
+    "types-jsonschema >= 4.23.0",
 ]
 
 [project.urls]
@@ -53,6 +55,22 @@ build-backend = "hatchling.build"
 [tool.hatch.version]
 path = "src/shacl2code/version.py"
 
+[tool.mypy]
+disallow_incomplete_defs = true
+# disallow_untyped_defs = true
+extra_checks = true
+mypy_path = ["testfixtures"]
+pretty = true
+show_column_numbers = true
+# strict = true
+strict_bytes = true
+# strict_equality = true
+# strict_equality_for_none = true
+warn_redundant_casts = true
+# warn_return_any = true
+# warn_unreachable = true
+# warn_unused_ignores = true
+
 [tool.pytest.ini_options]
 addopts = [
     "--import-mode=importlib",
@@ -73,4 +91,4 @@ relative_files = true
 patch = ["subprocess"]
 
 [tool.black]
-include = '(\.pyi?$)|(python\.j2$)'
+include = '(\.pyi?(\.j2)?$)|(main\.py\.j2$)'

shacl2code-1.0.1/scripts/format.sh

@@ -0,0 +1,9 @@
+#! /bin/sh
+
+set -e
+
+THIS_DIR=$(dirname "$0")
+cd $THIS_DIR/..
+
+clang-format -i $(git ls-files '*.cpp.j2' '*.cpp' '*.hpp.j2' '*.hpp', '*.h', '*.h.j2')
+gofmt -w $(git ls-files '*.go.j2' '*.go')

shacl2code-1.0.1/src/shacl2code/__init__.py

@@ -0,0 +1,17 @@
+# Copyright (c) 2024 Joshua Watt
+#
+# SPDX-License-Identifier: MIT
+
+from .main import main
+from .model import Model, ModelException
+from .urlcontext import ContextData, UrlContext
+from .version import VERSION
+
+__all__ = [
+    "VERSION",
+    "ContextData",
+    "Model",
+    "ModelException",
+    "UrlContext",
+    "main",
+]

{shacl2code-0.0.25 → shacl2code-1.0.1}/src/shacl2code/context.py

@@ -13,7 +13,10 @@ def foreach_context(contexts):
 
 
 class Context(object):
-    def __init__(self, contexts=[]):
+    def __init__(self, contexts=None):
+        if contexts is None:
+            contexts = []  # pragma: no cover
+
         self.contexts = [c for c in contexts if c]
         self.__vocabs = []
         self.__expanded_iris = {}

shacl2code-1.0.1/src/shacl2code/lang/__init__.py

@@ -0,0 +1,21 @@
+#
+# Copyright (c) 2024 Joshua Watt
+#
+# SPDX-License-Identifier: MIT
+
+# All renderers must be imported here to be registered
+from .cpp import CppRender
+from .golang import GoLangRender
+from .jinja import JinjaRender
+from .jsonschema import JsonSchemaRender
+from .lang import LANGUAGES
+from .python import PythonRender
+
+__all__ = [
+    "LANGUAGES",
+    "CppRender",
+    "GoLangRender",
+    "JinjaRender",
+    "JsonSchemaRender",
+    "PythonRender",
+]

{shacl2code-0.0.25 → shacl2code-1.0.1}/src/shacl2code/lang/common.py

@@ -2,15 +2,20 @@
 # Copyright (c) 2024 Joshua Watt
 #
 # SPDX-License-Identifier: MIT
+"""Common code for language renderers"""
 
-import sys
 import os
-from pathlib import Path
+import sys
 from contextlib import contextmanager
+from pathlib import Path
+
 import jinja2
 from jinja2 import Environment, FileSystemLoader, TemplateRuntimeError
+
 from markupsafe import Markup
+
 from rdflib.namespace import SH
+
 from ..model import SHACL2CODE
 from ..version import VERSION
 
@@ -40,14 +45,19 @@ class JinjaTemplateRender(object):
     def __init__(self, args):
         self.spdx_license = args.license
 
-    def get_additional_render_args(self):
+    def get_additional_render_args(self, model):
         return {}
 
     def get_extra_env(self):
         return {}
 
-    def render(self, template, output, *, extra_env={}, render_args={}):
-        def abort_helper(msg):
+    def render(self, template, output, *, extra_env=None, render_args=None):
+        if extra_env is None:
+            extra_env = {}  # pragma: no cover
+        if render_args is None:
+            render_args = {}  # pragma: no cover
+
+        def abort_helper(msg: str) -> None:
             raise TemplateRuntimeError(msg)
 
         env = Environment(loader=FileSystemLoader([template.parent, THIS_DIR.parent]))
@@ -60,7 +70,7 @@ class JinjaTemplateRender(object):
         template = env.get_template(template.name)
 
         render = template.render(
-            disclaimer=f"This file was automatically generated by {os.path.basename(sys.argv[0])}. DO NOT MANUALLY MODIFY IT",
+            disclaimer=f"This file was auto-generated by {os.path.basename(sys.argv[0])} {VERSION}. DO NOT MANUALLY MODIFY IT",
             spdx_license=self.spdx_license,
             **render_args,
         )
@@ -121,7 +131,7 @@ class JinjaTemplateRender(object):
             "abstract_classes": abstract_classes,
             "enums": enums,
             "context": model.context,
-            **self.get_additional_render_args(),
+            **self.get_additional_render_args(model),
         }
 
         env = {

{shacl2code-0.0.25 → shacl2code-1.0.1}/src/shacl2code/lang/cpp.py

@@ -2,15 +2,16 @@
 # Copyright (c) 2024 Joshua Watt
 #
 # SPDX-License-Identifier: MIT
-
-from .common import JinjaTemplateRender
-from .lang import language, TEMPLATE_DIR
-from ..version import VERSION
+"""C++ language binding renderer"""
 
 import re
 import textwrap
 from pathlib import Path
 
+from .common import JinjaTemplateRender
+from .lang import TEMPLATE_DIR, language
+from ..version import VERSION
+
 
 def varname(*name):
     name = "_".join(name)
@@ -144,14 +145,10 @@ class CppRender(JinjaTemplateRender):
         for s in self.HEADERS:
             guard = f"_{self.macro_prefix}_{id_str(s).upper()}"
             yield self.basename.parent / s, t / (s + ".j2"), {
-                "guard_begin": comment_wrap(
-                    textwrap.dedent(
-                        f"""\
+                "guard_begin": comment_wrap(textwrap.dedent(f"""\
                         #ifndef {guard}
                         #define {guard}
-                        """
-                    )
-                ),
+                        """)),
                 "guard_end": comment_wrap(f"#endif // {guard}"),
             }
 
@@ -188,33 +185,25 @@ class CppRender(JinjaTemplateRender):
             "prop_is_list": prop_is_list,
             "parent_cpp_classes": parent_cpp_classes,
             "macro_prefix": self.macro_prefix,
-            "api_def_begin": comment_wrap(
-                textwrap.dedent(
-                    f"""\
+            "api_def_begin": comment_wrap(textwrap.dedent(f"""\
                     #ifndef DOXYGEN_SKIP
                     #include "api.hpp"
                     // These are so that we don't have to use Jinja templates below since that messes up the formatting
                     #define EXPORT {self.macro_prefix}_API
                     #define LOCAL  {self.macro_prefix}_LOCAL
                     #endif // DOXYGEN_SKIP
-                    """
-                )
-            ),
-            "api_def_end": comment_wrap(
-                textwrap.dedent(
-                    """\
+                    """)),
+            "api_def_end": comment_wrap(textwrap.dedent("""\
                     #undef EXPORT
                     #undef LOCAL
-                    """
-                )
-            ),
+                    """)),
             "ns_begin": comment_wrap(
                 "\n".join(f"namespace {n} {{" for n in self.namespace.split("::"))
             ),
             "ns_end": comment_wrap("\n".join("}" for n in self.namespace.split("::"))),
         }
 
-    def get_additional_render_args(self):
+    def get_additional_render_args(self, model):
         return {
             "basename": self.basename.name,
             "namespace": self.namespace,

{shacl2code-0.0.25 → shacl2code-1.0.1}/src/shacl2code/lang/golang.py

@@ -2,13 +2,14 @@
 # Copyright (c) 2024 Joshua Watt
 #
 # SPDX-License-Identifier: MIT
+"""Go schema renderer"""
 
-from .common import JinjaTemplateRender
-from .lang import language, TEMPLATE_DIR
-
+import re
+import textwrap
 from pathlib import Path
 
-import re
+from .common import JinjaTemplateRender
+from .lang import TEMPLATE_DIR, language
 
 GO_KEYWORDS = (
     "break",
@@ -158,9 +159,9 @@ def prop_decode_func(cls, prop, classes):
         raise Exception("Unknown data type " + prop.datatype)  # pragma: no cover
 
     if prop_is_list(prop):
-        return f"DecodeList[{prop_go_type(prop, classes)}](value, path, {prop_ctx_name(cls, prop)}, {func}, obj.{varname(prop.varname)}())"
+        return f"DecodeList[{prop_go_type(prop, classes)}](value, path, {prop_ctx_name(cls, prop)}, {func}, obj.{varname(prop.varname)}(), state)"
 
-    return f"{func}(value, path, {prop_ctx_name(cls, prop)}, obj.{varname(prop.varname)}())"
+    return f"{func}(value, path, {prop_ctx_name(cls, prop)}, obj.{varname(prop.varname)}(), state)"
 
 
 def prop_encode_func(cls, prop, classes):
@@ -236,7 +237,14 @@ class GoLangRender(JinjaTemplateRender):
         super().__init__(args)
         self.__output = args.output
         self.__render_args = {
-            "package": args.package,
+            # This variable adds as many lines are get commented out in jinja,
+            # to keep the line numbers in the generated code the same as the
+            # template
+            "go_package": textwrap.dedent(f"""
+                */
+
+                package {args.package}
+                /*"""),
         }
 
     @classmethod
@@ -275,5 +283,5 @@ class GoLangRender(JinjaTemplateRender):
             "prop_encode_func": prop_encode_func,
         }
 
-    def get_additional_render_args(self):
+    def get_additional_render_args(self, model):
         return self.__render_args

{shacl2code-0.0.25 → shacl2code-1.0.1}/src/shacl2code/lang/jinja.py

@@ -2,6 +2,7 @@
 # Copyright (c) 2024 Joshua Watt
 #
 # SPDX-License-Identifier: MIT
+"""Jinja template renderer (for testing)"""
 
 from pathlib import Path
 

{shacl2code-0.0.25 → shacl2code-1.0.1}/src/shacl2code/lang/jsonschema.py

@@ -2,12 +2,13 @@
 # Copyright (c) 2024 Joshua Watt
 #
 # SPDX-License-Identifier: MIT
+"""JSON Schema renderer"""
 
-from .common import BasicJinjaRender
-from .lang import language, TEMPLATE_DIR
-
-import re
 import keyword
+import re
+
+from .common import BasicJinjaRender
+from .lang import TEMPLATE_DIR, language
 
 
 def varname(*name):
@@ -47,5 +48,5 @@ class JsonSchemaRender(BasicJinjaRender):
             "varname": varname,
         }
 
-    def get_additional_render_args(self):
+    def get_additional_render_args(self, model):
         return self.__render_args

{shacl2code-0.0.25 → shacl2code-1.0.1}/src/shacl2code/lang/lang.py

@@ -2,6 +2,7 @@
 # Copyright (c) 2024 Joshua Watt
 #
 # SPDX-License-Identifier: MIT
+"""Language renderers"""
 
 from pathlib import Path
 

shacl2code-1.0.1/src/shacl2code/lang/python.py

@@ -0,0 +1,139 @@
+# Copyright (c) 2024 Joshua Watt
+#
+# SPDX-License-Identifier: MIT
+"""Python language binding renderer"""
+
+import keyword
+import re
+from pathlib import Path
+
+from .common import JinjaTemplateRender
+from .lang import TEMPLATE_DIR, language
+from ..util import convert_version_string
+
+DATATYPE_CLASSES = {
+    "http://www.w3.org/2001/XMLSchema#string": "StringProp",
+    "http://www.w3.org/2001/XMLSchema#anyURI": "AnyURIProp",
+    "http://www.w3.org/2001/XMLSchema#integer": "IntegerProp",
+    "http://www.w3.org/2001/XMLSchema#positiveInteger": "PositiveIntegerProp",
+    "http://www.w3.org/2001/XMLSchema#nonNegativeInteger": "NonNegativeIntegerProp",
+    "http://www.w3.org/2001/XMLSchema#boolean": "BooleanProp",
+    "http://www.w3.org/2001/XMLSchema#decimal": "FloatProp",
+    "http://www.w3.org/2001/XMLSchema#dateTime": "DateTimeProp",
+    "http://www.w3.org/2001/XMLSchema#dateTimeStamp": "DateTimeStampProp",
+}
+
+DATATYPE_PYTHON_TYPES = {
+    "http://www.w3.org/2001/XMLSchema#string": "str",
+    "http://www.w3.org/2001/XMLSchema#anyURI": "str",
+    "http://www.w3.org/2001/XMLSchema#integer": "int",
+    "http://www.w3.org/2001/XMLSchema#positiveInteger": "int",
+    "http://www.w3.org/2001/XMLSchema#nonNegativeInteger": "int",
+    "http://www.w3.org/2001/XMLSchema#boolean": "bool",
+    "http://www.w3.org/2001/XMLSchema#decimal": "float",
+    "http://www.w3.org/2001/XMLSchema#dateTime": "datetime",
+    "http://www.w3.org/2001/XMLSchema#dateTimeStamp": "datetime",
+}
+
+
+def varname(*name):
+    """Make a valid Python variable name."""
+    name = "_".join(name)
+    # Any invalid characters at the beginning of the name are removed (except "@")
+    name = re.sub(r"^[^a-zA-Z0-9_@]*", "", name)
+    # Any other invalid characters are replaced with "_" (including "@")
+    name = re.sub(r"[^a-zA-Z0-9_]", "_", name)
+    # Consolidate runs of "_" to a single one
+    name = re.sub(r"__+", "_", name)
+    # Add a _ to anything that is a python keyword
+    while keyword.iskeyword(name):
+        name = name + "_"
+    return name
+
+
+@language("python")
+class PythonRender(JinjaTemplateRender):
+    """Render Python Language Bindings."""
+
+    HELP = "Python Language Bindings"
+
+    FILES = (
+        "__init__.py",
+        "model.py",
+        "model.pyi",
+    )
+
+    def __init__(self, args):
+        super().__init__(args)
+        self.__output = args.output
+        self.__use_slots = args.use_slots
+        self.__include_main = args.include_main == "yes"
+        self.__version_str = args.version
+        if args.version:
+            self.__version = repr(convert_version_string(args.version))
+        else:
+            self.__version = ""
+
+    @classmethod
+    def get_arguments(cls, parser):
+        parser.add_argument(
+            "--output",
+            "-o",
+            type=Path,
+            help="Output directory",
+            required=True,
+        )
+        parser.add_argument(
+            "--include-main",
+            choices=("yes", "no"),
+            default="yes",
+            help="Generate a main function for the module. Default is '%(default)s'",
+        )
+        parser.add_argument(
+            "--use-slots",
+            choices=("auto", "yes", "no"),
+            default="auto",
+            help=(
+                "Use __slot__ to reduce memory usage. "
+                "Slots prevents multiple inheritance. Default is %(default)s"
+            ),
+        )
+        parser.add_argument(
+            "--version",
+            help="Specify model version",
+        )
+
+    def get_outputs(self):
+        t = TEMPLATE_DIR / "python"
+        self.__output.mkdir(parents=True, exist_ok=True)
+
+        def get_file(name):
+            return self.__output / name, t / (name + ".j2"), {}
+
+        for s in self.FILES:
+            yield get_file(s)
+
+        if self.__include_main:
+            yield get_file("cmd.py")
+            yield get_file("__main__.py")
+
+    def get_extra_env(self):
+        return {
+            "varname": varname,
+            "DATATYPE_CLASSES": DATATYPE_CLASSES,
+            "DATATYPE_PYTHON_TYPES": DATATYPE_PYTHON_TYPES,
+        }
+
+    def get_additional_render_args(self, model):
+        if self.__use_slots == "auto":
+            use_slots = all(len(cls.parent_ids) <= 1 for cls in model.classes)
+        elif self.__use_slots == "yes":
+            use_slots = True
+        else:
+            use_slots = False
+        return {
+            "use_slots": use_slots,
+            "include_main": self.__include_main,
+            "version_str": self.__version_str,
+            "version": self.__version,
+        }