interlis2py 0.1.0__py3-none-any.whl

ili2py/writers/py/render.py

@@ -0,0 +1,180 @@
+import inspect
+import os
+import shutil
+from pathlib import Path
+
+import autoflake
+import black
+import isort
+from jinja2 import Environment, FileSystemLoader
+
+from ili2py.mappers.helpers import Index
+from ili2py.writers.helpers import create_file, handle_model_versions
+from ili2py.writers.py import constraints
+from ili2py.writers.py.python_structure import Library
+
+base_url_23 = "http://www.interlis.ch/INTERLIS2.3"
+base_url_24 = "http://www.interlis.ch/xtf/2.4"
+
+render_configuration = {
+    "2.3": {"selector": 23, "base_url": base_url_23, "namespace_map": {"ili": base_url_23}},
+    "2.4": {
+        "selector": 24,
+        "base_url": base_url_24,
+        "namespace_map": {
+            "ili": f"{base_url_24}/INTERLIS",
+            "geom": "http://www.interlis.ch/geometry/1.0",
+            "xsi": "http://www.w3.org/2001/XMLSchema-instance",
+        },
+    },
+}
+
+reserved_python_key_words = [
+    "False",
+    "await",
+    "else",
+    "import",
+    "pass",
+    "None",
+    "break",
+    "except",
+    "in",
+    "raise",
+    "True",
+    "class",
+    "finally",
+    "is",
+    "return",
+    "and",
+    "continue",
+    "for",
+    "lambda",
+    "try",
+    "as",
+    "def",
+    "from",
+    "nonlocal",
+    "while",
+    "assert",
+    "del",
+    "global",
+    "not",
+    "with",
+    "async",
+    "elif",
+    "if",
+    "or",
+    "yield",
+]
+
+
+def create_python_classes(
+    library: Library, index: Index, output_path: str, beautify: bool = True
+):
+    ili_version = handle_model_versions(index)
+    if ili_version == "2.3" or ili_version == "2.4":
+        reader_classes(
+            library,
+            output_path,
+            render_config=render_configuration[ili_version],
+            beautify=beautify,
+        )
+    else:
+        raise NotImplementedError(f"ili version '{ili_version}' not supported")
+
+
+def library_storage_name(library_name: str) -> str:
+    return library_name.split(".")[-1]
+
+
+def reader_classes(
+    library: Library, output_path: str, render_config: dict, beautify: bool = True
+):
+    tpl_dir = Path(__file__).parent.joinpath(
+        f"interlis{render_config['selector']}", "templates"
+    )
+    env = Environment(loader=FileSystemLoader(str(tpl_dir)), autoescape=False)  # nosec B701
+    library_content = env.get_template("library_init.jinja2").render(
+        library=library,
+        render_config=render_config,
+        reserved_python_key_words=reserved_python_key_words,
+    )
+    # we expect the name to contain dots (as python dotted path) this can be used to create the
+    # interface in the correct way for a library where it should be included to. As we always
+    # want the folder of the library package to be named after the library we expect the last
+    # element the right match in any case.
+    library_name = library_storage_name(library.name)
+    target_path = os.path.join(output_path, library_name)
+    if os.path.isdir(target_path):
+        shutil.rmtree(target_path)
+
+    library_file = create_file(output_path, library_name, "__init__.py")
+    library_file.write_text(library_content, encoding="utf-8")
+    references_content = env.get_template("references.jinja2").render(
+        render_config=render_config, reserved_python_key_words=reserved_python_key_words
+    )
+    references_file = create_file(output_path, library_name, "references.py")
+    references_file.write_text(references_content, encoding="utf-8")
+    # this way we can use the code and also deliver it to the built package
+    constraints_file = create_file(output_path, library_name, "constraints.py")
+    constraints_file.write_text(inspect.getsource(constraints), encoding="utf-8")
+    convertable_types_content = env.get_template("convertable_types.jinja2").render(
+        library=library,
+        render_config=render_config,
+        reserved_python_key_words=reserved_python_key_words,
+    )
+    convertable_types_file = create_file(output_path, library_name, "convertable_types.py")
+    convertable_types_file.write_text(convertable_types_content, encoding="utf-8")
+    xtf_opening_content = env.get_template("xtf_opening.jinja2").render(
+        library=library,
+        render_config=render_config,
+        reserved_python_key_words=reserved_python_key_words,
+    )
+    xtf_opening_file = create_file(output_path, library_name, "xtf_opening.py")
+    xtf_opening_file.write_text(xtf_opening_content, encoding="utf-8")
+    output_path = os.path.join(output_path, library_name)
+    for package in library.packages:
+        package_file = create_file(output_path, package.name, "__init__.py")
+        package_content = env.get_template("package_init.jinja2").render(
+            package=package,
+            render_config=render_config,
+            reserved_python_key_words=reserved_python_key_words,
+        )
+        package_file.write_text(package_content, encoding="utf-8")
+        for module in package.modules:
+            module_file = create_file(output_path, package.name, f"{module.name}.py")
+            module_content = env.get_template("module.jinja2").render(
+                module=module,
+                render_config=render_config,
+                package=package,
+                reserved_python_key_words=reserved_python_key_words,
+            )
+            module_file.write_text(module_content, encoding="utf-8")
+    if beautify:
+        output_path_pathlib = Path(output_path)
+        py_files = (
+            output_path_pathlib.rglob("*.py")
+            if output_path_pathlib.is_dir()
+            else [output_path_pathlib]
+        )
+
+        # run autoflake
+        for file_path in py_files:
+            code = file_path.read_text(encoding="utf-8")
+            fixed_code = autoflake.fix_code(
+                code,
+                remove_all_unused_imports=True,
+                remove_unused_variables=True,
+            )
+            file_path.write_text(fixed_code, encoding="utf-8")
+
+        # run isort
+        for file_path in py_files:
+            isort.file(file_path, profile="black", float_to_top=True)
+
+        # run black
+        mode = black.FileMode(line_length=79)
+        for file_path in py_files:
+            black.format_file_in_place(
+                file_path, fast=False, mode=mode, write_back=black.WriteBack.YES
+            )

interlis2py-0.1.0.dist-info/METADATA

@@ -0,0 +1,91 @@
+Metadata-Version: 2.4
+Name: interlis2py
+Version: 0.1.0
+Summary: Your pythonic gateway to INTERLIS
+Author-email: Clemens Rudert <rudert-geoinformatik@posteo.ch>
+Maintainer-email: Clemens Rudert <rudert-geoinformatik@posteo.ch>
+Project-URL: Tracker, https://github.com/georama/issues
+Project-URL: CI, https://github.com/rudert-geoinformatik/ili2py/actions
+Project-URL: Documentation, https://ili2py.readthedocs.io/
+Project-URL: Source, https://github.com/rudert-geoinformatik/ili2py
+Project-URL: Changelog, https://github.com/rudert-geoinformatik/ili2py/blob/master/CHANGELOG.md
+Project-URL: Contributing, https://github.com/rudert-geoinformatik/ili2py/blob/master/CONTRIBUTING.md
+Keywords: python package
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: GNU Affero General Public License v3
+Classifier: Natural Language :: English
+Classifier: Operating System :: Unix
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: MacOS
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Software Distribution
+Classifier: Typing :: Typed
+Requires-Python: >=3.12.0
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: click==8.1.8
+Requires-Dist: xsdata[cli,lxml,soap]==25.7
+Requires-Dist: autoflake==2.4.0
+Requires-Dist: black==25.1.0
+Requires-Dist: isort==6.0.1
+Requires-Dist: rich
+Dynamic: license-file
+
+[![BuildRelease](https://github.com/rudert-geoinformatik/ili2py/actions/workflows/build.yml/badge.svg?branch=master)](https://github.com/rudert-geoinformatik/ili2py/actions/workflows/build.yml)
+[![BuildDocs](https://github.com/rudert-geoinformatik/ili2py/actions/workflows/docs.yml/badge.svg?branch=master)](https://github.com/rudert-geoinformatik/ili2py/actions/workflows/docs.yml)
+[![ReadTheDocs](https://github.com/rudert-geoinformatik/ili2py/actions/workflows/pages/pages-build-deployment/badge.svg?branch=master)](https://github.com/rudert-geoinformatik/ili2py/actions/workflows/pages/pages-build-deployment)
+
+# ili2py
+
+The IlisMeta16 model in python.
+
+## Features
+
+**ili2py** `python package`
+
+1. python bindings for interlis models
+1. reader for IMD16 meta models
+1. index with mappers to easy access IlisMeta16 elements
+1. writers: PythonSource Code (can be used to read XTF), UML Charts
+
+## Install
+
+The package is published on PyPI as `interlis2py` (the name `ili2py` is not available on PyPI). Import package and command line tool are `ili2py`. Requires Python >= 3.12.
+
+```shell
+pip install interlis2py
+# or with uv
+uv add interlis2py
+```
+
+```python
+import ili2py
+```
+
+```shell
+ili2py --help
+```
+
+Binaries for Linux, macOS and Windows are attached to the [releases](https://github.com/rudert-geoinformatik/ili2py/releases).
+
+## Docs
+
+Find current version of Docs [here](https://rudert-geoinformatik.github.io/ili2py/).
+
+# Changelog
+
+From 0.1.0 on, the changes of each version are listed in the release notes on the
+[releases page](https://github.com/rudert-geoinformatik/ili2py/releases). They are generated from the merged pull requests.
+
+## 0.0.1 (2025-01-27)
+
+## 0.0.0 (2023-10-28)
+
+Initial version