feat: get by subkeyword and add transform links (#735)

Co-authored-by: Mohamed Koubaa <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: pyansys-ci-bot <[email protected]>

Author: 4 people

.pre-commit-config.yaml

@@ -1,11 +1,14 @@
 files: |
     (?x)(
+        ^codegen/ |
         ^src/ansys/ |
         ^examples |
         ^.github/
     )
 exclude: |
     (?x)^(
+        codegen/kwd.json|
+        codegen/additional-cards.json|
         doc/source/|
         src/ansys/dyna/core/pre/Server/|
         src/ansys/dyna/core/pre/doc/|

codegen/README.md

@@ -29,7 +29,7 @@ The class generator uses Jinja templates to generate three distinct things:
 The python classes are what users of PyDyna interact with directly. The import machinery produces
 `auto_keywords.py`, which contains a list of import statements that import classes from the
 Python files where they are defined. The keyword to type mapping produces a dictionary mapping the
-keyword name witht he python class that defines it.
+keyword name with the python class that defines it.
 
 The primary specification for keywords is found in `kwd.json`. It contains basic definitions
 for most keywords, including their cards and fields (which are defined by offset, name, default

codegen/generate.py

@@ -29,12 +29,9 @@
 import typing
 
 from jinja2 import Environment, FileSystemLoader
-
 import keyword_generation.data_model as data_model
 from keyword_generation.generators import generate_class, generate_entrypoints
-
-from keyword_generation.utils import get_classname, get_this_folder, fix_keyword, handle_single_word_keyword
-
+from keyword_generation.utils import fix_keyword, get_classname, get_this_folder, handle_single_word_keyword
 
 SKIPPED_KEYWORDS = set(
     [
@@ -44,7 +41,7 @@
         "ELEMENT_SOLID (ten nodes format)",
         "ELEMENT_SOLID",
         "ELEMENT_SOLID_ORTHO (ten nodes format)",
-        "ELEMENT_SOLID_ORTHO"
+        "ELEMENT_SOLID_ORTHO",
         # issue #184 - this is not documented in the manual
         # "CONTROL_TIMESTEP",CONTROL_TIMESTEP is in the kwd.json now and should be generated issue #629
     ]
@@ -253,7 +250,7 @@ def parse_args():
         "--output",
         "-o",
         default="",
-        help="Output folder."
+        help="Output folder.",
         # help="Output folder. Defaults to the location of generated code in pydyna."
     )
     parser.add_argument(

codegen/keyword_generation/generators/class_generator.py

@@ -3,27 +3,24 @@
 import typing
 
 from jinja2 import Environment
-
 import keyword_generation.data_model as data_model
-
-from keyword_generation.handlers.handler_base import KeywordHandler
+from keyword_generation.handlers.add_option import AddOptionHandler
+from keyword_generation.handlers.card_set import CardSetHandler
+from keyword_generation.handlers.conditional_card import ConditionalCardHandler
 from keyword_generation.handlers.external_card import ExternalCardHandler
+from keyword_generation.handlers.handler_base import KeywordHandler
+from keyword_generation.handlers.insert_card import InsertCardHandler
+from keyword_generation.handlers.override_field import OverrideFieldHandler
+from keyword_generation.handlers.override_subkeyword import OverrideSubkeywordHandler
+from keyword_generation.handlers.rename_property import RenamePropertyHandler
+from keyword_generation.handlers.reorder_card import ReorderCardHandler
+from keyword_generation.handlers.replace_card import ReplaceCardHandler
 from keyword_generation.handlers.series_card import SeriesCardHandler
 from keyword_generation.handlers.shared_field import SharedFieldHandler
+from keyword_generation.handlers.skip_card import SkipCardHandler
 from keyword_generation.handlers.table_card import TableCardHandler
 from keyword_generation.handlers.table_card_group import TableCardGroupHandler
-from keyword_generation.handlers.override_field import OverrideFieldHandler
-from keyword_generation.handlers.rename_property import RenamePropertyHandler
-from keyword_generation.handlers.conditional_card import ConditionalCardHandler
-from keyword_generation.handlers.add_option import AddOptionHandler
-from keyword_generation.handlers.override_subkeyword import OverrideSubkeywordHandler
-from keyword_generation.handlers.skip_card import SkipCardHandler
-from keyword_generation.handlers.insert_card import InsertCardHandler
-from keyword_generation.handlers.replace_card import ReplaceCardHandler
-from keyword_generation.handlers.card_set import CardSetHandler
-from keyword_generation.handlers.reorder_card import ReorderCardHandler
-
-from keyword_generation.utils import fix_keyword, get_license_header, get_classname, handle_single_word_keyword
+from keyword_generation.utils import fix_keyword, get_classname, get_license_header, handle_single_word_keyword
 
 
 def _get_source_keyword(keyword, settings):
@@ -273,6 +270,51 @@ def _handle_keyword_data(kwd_data, settings):
     _after_handle(kwd_data)
 
 
+def _add_define_transform_link_data(link_data: typing.List[typing.Dict], link_fields: typing.List[str]):
+    transform_link_data = {
+        "classname": "DefineTransformation",
+        "modulename": "define_transformation",
+        "keyword_type": "DEFINE",
+        "keyword_subtype": "TRANSFORMATION",
+        "fields": link_fields,
+        "linkid": "tranid",
+    }
+    link_data.append(transform_link_data)
+
+
+class LinkIdentity:
+    DEFINE_TRANSFORMATION = 40
+
+
+def _get_links(kwd_data) -> typing.Optional[typing.Dict]:
+    links = {LinkIdentity.DEFINE_TRANSFORMATION: []}
+    has_link = False
+    for card in kwd_data["cards"]:
+        for field in _get_fields(card):
+            if "link" not in field:
+                continue
+            link = field["link"]
+            if link not in links.keys():
+                continue
+            has_link = True
+            links[link].append(field["name"])
+    if not has_link:
+        return None
+    return links
+
+
+def _add_links(kwd_data):
+    """Add "links", or properties that link one keyword to another."""
+    links = _get_links(kwd_data)
+    if links is None:
+        return
+    link_data = []
+    for link_type, link_fields in links.items():
+        if link_type == LinkIdentity.DEFINE_TRANSFORMATION:
+            _add_define_transform_link_data(link_data, link_fields)
+    kwd_data["links"] = link_data
+
+
 def _get_keyword_data(keyword_name, keyword, settings):
     """Gets the keyword data dict from kwdm.  Transforms it
     based on the generation settings that are passed in, if any,
@@ -288,6 +330,8 @@ def _get_keyword_data(keyword_name, keyword, settings):
 
     # default transformations to a valid format we need for jinja
     _transform_data(kwd_data)
+
+    _add_links(kwd_data)
     return kwd_data
 
 
@@ -314,8 +358,12 @@ def generate_class(env: Environment, lib_path: str, item: typing.Dict) -> None:
     keyword = item["name"]
     fixed_keyword = fix_keyword(keyword)
     classname = item["options"].get("classname", get_classname(fixed_keyword))
-    base_variable = _get_base_variable(classname, keyword, item["options"])
-    jinja_variable = _get_jinja_variable(base_variable)
-    filename = os.path.join(lib_path, "auto", fixed_keyword.lower() + ".py")
-    with open(filename, "w", encoding="utf-8") as f:
-        f.write(env.get_template("keyword.j2").render(**jinja_variable))
+    try:
+        base_variable = _get_base_variable(classname, keyword, item["options"])
+        jinja_variable = _get_jinja_variable(base_variable)
+        filename = os.path.join(lib_path, "auto", fixed_keyword.lower() + ".py")
+        with open(filename, "w", encoding="utf-8") as f:
+            f.write(env.get_template("keyword.j2").render(**jinja_variable))
+    except Exception as e:
+        print(f"Failure in generating {classname}")
+        raise e

codegen/keyword_generation/generators/entrypoints_generator.py

@@ -3,8 +3,7 @@
 import typing
 
 from jinja2 import Environment
-
-from keyword_generation.utils import fix_keyword, get_license_header
+from keyword_generation.utils import get_license_header
 
 
 def generate_entrypoints(env: Environment, lib_path: str, keywords_list: typing.List[typing.Dict]) -> None:

codegen/keyword_generation/handlers/card_set.py

@@ -1,7 +1,6 @@
 import copy
 import typing
 
-from keyword_generation.data_model import get_card
 import keyword_generation.data_model as gen
 import keyword_generation.handlers.handler_base
 

codegen/keyword_generation/handlers/insert_card.py

@@ -1,7 +1,7 @@
 import typing
 
-from keyword_generation.data_model import get_card
 import keyword_generation.data_model as gen
+from keyword_generation.data_model import get_card
 import keyword_generation.handlers.handler_base
 
 

codegen/keyword_generation/handlers/table_card_group.py

@@ -1,7 +1,7 @@
 import typing
 
-import keyword_generation.handlers.handler_base
 import keyword_generation.data_model as gen
+import keyword_generation.handlers.handler_base
 
 
 class TableCardGroupHandler(keyword_generation.handlers.handler_base.KeywordHandler):

codegen/templates/keyword.j2

@@ -32,6 +32,9 @@ from ansys.dyna.core.lib.option_card import OptionCardSet, OptionSpec
 {% endif %}
 {% endif %}
 from ansys.dyna.core.lib.keyword_base import KeywordBase
+{% for link in keyword_data.links %}
+from ansys.dyna.core.keywords.keyword_classes.auto.{{link.modulename}} import {{link.classname}}
+{% endfor %}
 
 {% if keyword_data.card_sets %}
 {% for card_set in keyword_data.card_sets.sets %}
@@ -141,4 +144,7 @@ class {{keyword_data.classname}}(KeywordBase):
 {% include 'keyword/option_card_properties.j2' %}
 {% endfor %}{# option in keyword_data.options #}
 {% endif %}{# keyword_data.options #}
+{% with links = keyword_data.links %}
+{% include 'keyword/links.j2' %}
+{% endwith %}
 {% include 'keyword/alias.j2' %}

codegen/templates/keyword/links.j2

@@ -0,0 +1,17 @@
+{% for link in links %}
+{% for field in link.fields %}
+    @property
+    def {{field}}_link(self) -> {{link.classname}}:
+        if self.deck is None:
+            return None
+        for kwd in self.deck.get_kwds_by_full_type("{{link.keyword_type}}", "{{link.keyword_subtype}}"):
+            if kwd.{{link.linkid}} == self.{{field}}:
+                return kwd
+        return None
+
+    @{{field}}_link.setter
+    def {{field}}_link(self, value: {{link.classname}}) -> None:
+        self.{{field}} = value.{{link.linkid}}
+
+{% endfor %}{# field in link.fields #}
+{% endfor %}{# link in links #}