Merge branch 'develop' of https://github.com/ackrep-org/pyerk-core into develop

Author: JuliusFiedler

.gitignore

@@ -11,4 +11,4 @@ tmp*
 dist
 build
 .aider*
-.env_dev
+.env*

src/pyirk/irkloader.py

@@ -7,10 +7,9 @@
 import pathlib
 import functools
 import addict
+from types import ModuleType
 
 
-ModuleType = type(sys)
-
 
 def preserve_cwd(function):
     """

src/pyirk/refactor_tools.py

@@ -0,0 +1,53 @@
+from ipydex import IPS
+import re
+
+def change_entity_label(key, new_label, fpath):
+    with open(fpath, "r", encoding="utf-8") as fp:
+        src_lines = fp.readlines()
+
+    # TODO: this might be more generic
+    regex1 = re.compile(f"^{key}[ ]?=[ ]?(p|pyirk).create_(item|relation)")
+
+    matching_lines = [(i, line) for i, line in enumerate(src_lines) if regex1.match(line)]
+
+    assert len(matching_lines) == 1, "Unexpected number of matching lines"
+
+    start_idx = matching_lines[0][0]
+    end_idx = start_idx + 5
+
+    # TODO: make this more robust
+    assert len(src_lines) >= end_idx
+
+    # TODO: This is not robust if label contains quotes or spans multiple lines
+    regex2 = re.compile(r"""^\s*R1(?:__\w+)?\s*=\s*["|'](.*)["|']""")
+
+    for i, line in enumerate(src_lines[start_idx:end_idx]):
+        if match := regex2.match(line):
+            break
+    else:
+        # break was not called
+        msg = f"Could not find matching R1 pattern in lines {start_idx} to {end_idx} of {fpath}"
+        raise ValueError(msg)
+
+    original_label = match.group(1)
+    defining_line = src_lines[start_idx + i]
+    nbr_of_occurrences = defining_line.count(original_label)
+    err_msg = f"original label unexpectedly occurs {nbr_of_occurrences} times in {fpath}:{start_idx + i}"
+    assert nbr_of_occurrences == 1, err_msg
+    new_defining_line = defining_line.replace(original_label, new_label)
+
+    src_lines[start_idx + i] = new_defining_line
+
+    new_src = "".join(src_lines)
+
+    replacements = [
+        (f'{key}["{original_label}"]', f'{key}["{new_label}"]'),
+        (f"{key}['{original_label}']", f"{key}['{new_label}']"),
+        # TODO: add underscore_version
+    ]
+
+    for rplm in replacements:
+        new_src = new_src.replace(*rplm)
+
+    with open(fpath, "w", encoding="utf-8") as fp:
+        fp.write(new_src)

src/pyirk/script.py

@@ -6,16 +6,18 @@
 import argparse
 from pathlib import Path
 import re
+import types
 from typing import Tuple
 import ast
 import inspect
 from textwrap import dedent
+from addict import Addict as Container
 
 try:
     # this will be part of standard library for python >= 3.11
     import tomllib
 except ModuleNotFoundError:
-    import tomli as tomllib
+    import tomli as tomllib # type: ignore
 
 import platformdirs
 
@@ -34,8 +36,8 @@
 
 def create_parser():
     """
-    Returns the parser object which is then evaluated in  main(). This is necessary for sphinx to automatically
-    generate the cli docs.
+    Returns the parser object which is then evaluated in  main(). This is necessary for sphinx to
+    automatically generate the cli docs.
     """
 
     parser = argparse.ArgumentParser(
@@ -173,6 +175,15 @@ def create_parser():
         action="store_true",
     )
 
+    parser.add_argument(
+        "--refactor-entity-label",
+        help="change main label of entity in source file of loaded module. "
+        "Recommended: Apply ony to clean git repo.",
+        nargs=2,
+        metavar=("key", "new label")
+    )
+
+
     return parser
 
 
@@ -183,6 +194,13 @@ def main():
         debug()
         exit()
 
+    if args.refactor_entity_label:
+        from . import refactor_tools as rt
+        assert args.inputfile is not None
+        assert len(args.refactor_entity_label) == 2
+        rt.change_entity_label(*args.refactor_entity_label, args.inputfile)
+        exit()
+
     if args.version:
         print(release.__version__)
         exit()
@@ -235,15 +253,15 @@ def main():
         visualization.visualize_entity(uri, write_tmp_files=True)
     elif args.start_django:
         try:
-            import pyirkdjango.core
+            import pyirkdjango.core # type: ignore
         except ImportError:
             print(aux.bred("Error:"), "the module pyirkdjango seems not to be installed.")
             # exit(10)
             raise
         pyirkdjango.core.start_django()
     elif args.start_django_shell:
         try:
-            import pyirkdjango.core
+            import pyirkdjango.core # type: ignore
         except ImportError:
             print(aux.bred("Error:"), "the module pyirkdjango seems not to be installed.")
             # exit(10)
@@ -259,7 +277,7 @@ def main():
         print("nothing to do, see option `--help` for more info")
 
 
-def process_package(pkg_path: str) -> Tuple[irkloader.ModuleType, str]:
+def process_package(pkg_path: str) -> Tuple[types.ModuleType, str]:
     if os.path.isdir(pkg_path):
         pkg_path = os.path.join(pkg_path, "irkpackage.toml")
 
@@ -273,7 +291,7 @@ def process_package(pkg_path: str) -> Tuple[irkloader.ModuleType, str]:
     return mod, main_module_prefix
 
 
-def process_mod(path: str, prefix: str, relative_to_workdir: bool = False) -> irkloader.ModuleType:
+def process_mod(path: str, prefix: str, relative_to_workdir: bool = False) -> types.ModuleType:
     if not relative_to_workdir:
         msg = "using mod paths which are not relative to workdir is deprecated since pyirk version 0.6.0"
         raise DeprecationWarning(msg)
@@ -522,7 +540,7 @@ def process_template(template_path):
     return rendered_template
 
 
-def path_to_ast_container(mod_path: str) -> core.aux.Container:
+def path_to_ast_container(mod_path: str) -> Container:
 
     with open(mod_path) as fp:
         lines = fp.readlines()

tests/test_refactor_tools.py

@@ -0,0 +1,69 @@
+import os
+import unittest
+import tempfile
+import shutil
+
+import pyirk.refactor_tools as rt
+
+
+
+from .settings import (
+    TEST_BASE_URI,
+    TEST_DATA_DIR1,
+    HousekeeperMixin,
+    TEST_DATA_DIR_OCSE,
+    TEST_DATA_PATH3 as ocse_subset_agents_path,
+)
+
+
+# noinspection PyPep8Naming
+class Test_01_Script(HousekeeperMixin, unittest.TestCase):
+    def test_rt_a01__change_entity_label(self):
+
+        tmp_mod_fpath = make_temp_copy_of_file(ocse_subset_agents_path)
+
+        # change I9942["Stanford University"] to I9942["Renamed Stanford University"]
+        rt.change_entity_label(key="I9942", new_label="Renamed Stanford University", fpath=tmp_mod_fpath)
+
+        manually_checking_difference = False
+        if manually_checking_difference:
+            tmp_mod_fpath0 = make_temp_copy_of_file(ocse_subset_agents_path)
+            os.system(f"kdiff3 {tmp_mod_fpath0} {tmp_mod_fpath}")
+
+
+    def test_rt_a02__change_entity_label_from_cli(self):
+
+        tmp_mod_fpath = make_temp_copy_of_file(ocse_subset_agents_path)
+
+        cmd = f'pyirk --refactor-entity-label I9942 "Renamed Stanford University" {tmp_mod_fpath}'
+        os.system(cmd)
+
+
+        manually_checking_difference = False
+        if manually_checking_difference:
+            tmp_mod_fpath0 = make_temp_copy_of_file(ocse_subset_agents_path)
+            os.system(f"kdiff3 {tmp_mod_fpath0} {tmp_mod_fpath}")
+#
+# Auxiliary functions:
+#
+
+def make_temp_copy_of_file(fpath):
+    """
+    Creates a temporary file with the content of the file specified by `fpath`
+    """
+    # Create a temporary file and copy the content from the source file
+    temp_fd, temp_path = tempfile.mkstemp(suffix=".py")
+    try:
+        # Close the file descriptor since shutil.copy2 will handle the file operations
+        import os
+        os.close(temp_fd)
+        # Copy the file content and metadata
+        shutil.copy2(fpath, temp_path)
+        return temp_path
+    except Exception:
+        # Clean up the temporary file if something goes wrong
+        try:
+            os.unlink(temp_path)
+        except:
+            pass
+        raise