feat: Add register and unregister entry points for Extensions Manager (#28)

Co-authored-by: pyansys-ci-bot <92810346+pyansys-ci-bot@users.noreply.github.com>

Author: ansjhenry

doc/changelog.d/28.added.md

@@ -0,0 +1 @@
+feat: Add register and unregister entry points for Extensions Manager

pyproject.toml

@@ -69,10 +69,14 @@ Homepage = "https://www.ansys.com/products/embedded-software/ansys-scade-suite"
 
 [project.entry-points."ansys.scade.registry"]
 srg = "ansys.scade.python_wrapper:srg"
+register = "ansys.scade.python_wrapper.register:register"
+unregister = "ansys.scade.python_wrapper.unregister:unregister"
 
 [project.scripts]
-register_ansys_scade_python_wrapper = "ansys.scade.python_wrapper.register:main"
 ansys_scade_python_wrapper_swanpython = "ansys.scade.python_wrapper.swanpython:main"
+# backward compatibility
+register_ansys_scade_python_wrapper = "ansys.scade.python_wrapper.register:main"
+unregister_ansys_scade_python_wrapper = "ansys.scade.python_wrapper.unregister:main"
 
 [tool.ruff]
 line-length = 99

src/ansys/scade/python_wrapper/__init__.py

@@ -27,6 +27,7 @@
 except ModuleNotFoundError:
     import importlib_metadata
 from pathlib import Path
+import sys
 
 try:
     __version__ = importlib_metadata.version(__name__.replace('.', '-'))
@@ -35,6 +36,20 @@
     __version__ = '0.0.0'
 
 
+def get_srg_name() -> str:
+    """
+    Return the name of the registration file for Ansys SCADE IDE.
+
+    It addresses SCADE 2024 R2 and prior releases.
+    SCADE 2025 R1 and above use the package's
+    ``ansys.scade.registry`` entry point.
+    """
+    # registrations depending on Python interpreter
+    python_version = str(sys.version_info.major) + str(sys.version_info.minor)
+    suffix = '23r1' if python_version == '37' else '24r2'
+    return 'python_wrapper%s.srg' % suffix
+
+
 def srg() -> str:
     r"""
     Return the path of the SCADE Studio registry file.

src/ansys/scade/python_wrapper/register.py

@@ -34,32 +34,38 @@
 import os
 from pathlib import Path
 import sys
+from typing import Tuple
+
+from ansys.scade.python_wrapper import get_srg_name
 
 _APPDATA = os.getenv('APPDATA')
 
 
 def _register_srg_file(srg: Path, install: Path):
     # copy the srg file to Customize and patch it with the installation directory.
+    assert _APPDATA
     text = srg.open().read()
     text = text.replace('%TARGETDIR%', install.as_posix())
     dst = Path(_APPDATA, 'SCADE', 'Customize', srg.name)
     dst.parent.mkdir(parents=True, exist_ok=True)
     dst.open('w').write(text)
 
 
-def _python_wrapper_config():
-    # register the Code Generator extension registry files (SRG).
+def register() -> Tuple[int, str]:
+    """Implement the ``ansys.scade.registry/register`` entry point."""
     script_dir = Path(__file__).parent
-    # registrations depending on Python interpreter
-    python_version = str(sys.version_info.major) + str(sys.version_info.minor)
-    suffix = '23r1' if python_version == '37' else '24r2'
-    _register_srg_file(script_dir / ('python_wrapper%s.srg' % suffix), script_dir)
+    _register_srg_file(script_dir / get_srg_name(), script_dir)
+    return (0, '')
 
 
 def main():
     """Implement the ``ansys.scade.python_wrapper.register`` packages's project script."""
-    _python_wrapper_config()
+    code, message = register()
+    if message:
+        print(message, file=sys.stderr if code else sys.stdout)
+    return code
 
 
 if __name__ == '__main__':
-    main()
+    code = main()
+    sys.exit(code)

src/ansys/scade/python_wrapper/unregister.py

@@ -0,0 +1,67 @@
+# Copyright (C) 2023 - 2025 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+"""
+Unregisters the Code Generator extension registry files (SRG).
+
+Refer to the :ref:`installation <getting_started/index:install in user mode>`
+steps for more information.
+
+It addresses SCADE 2024 R2 and prior releases.
+SCADE 2025 R1 and above use the package's
+``ansys.scade.registry`` entry point.
+"""
+
+import os
+from pathlib import Path
+import sys
+from typing import Tuple
+
+from ansys.scade.python_wrapper import get_srg_name
+
+_APPDATA = os.getenv('APPDATA')
+
+
+def _unregister_srg_file(name: str):
+    """Delete the srg file from Customize."""
+    assert _APPDATA
+    dst = Path(_APPDATA, 'SCADE', 'Customize', name)
+    dst.unlink(missing_ok=True)
+
+
+def unregister() -> Tuple[int, str]:
+    """Implement the ``ansys.scade.registry/unregister`` entry point."""
+    _unregister_srg_file(get_srg_name())
+    return (0, '')
+
+
+def main():
+    """Implement the ``ansys.scade.python_wrapper.unregister`` packages's project script."""
+    code, message = unregister()
+    if message:
+        print(message, file=sys.stderr if code else sys.stdout)
+    return code
+
+
+if __name__ == '__main__':
+    code = main()
+    sys.exit(code)

tests/test_entry_points.py

@@ -0,0 +1,38 @@
+# Copyright (C) 2023 - 2025 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+from pathlib import Path
+
+import ansys.scade.python_wrapper as pw
+
+
+def test_srg():
+    path = pw.srg()
+    assert path
+    assert Path(path).exists()
+
+
+def test_get_srg_name():
+    name = pw.get_srg_name()
+    assert name
+    assert name.startswith('python_wrapper2')
+    assert name.endswith('.srg')