PyDMConverter 0.0.0__tar.gz → 1.0.3__tar.gz

{pydmconverter-0.0.0 → pydmconverter-1.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyDMConverter
-Version: 0.0.0
+Version: 1.0.3
 Summary: converter to generate pydm .ui files from other display managers.
 Author: Devan Agrawal, Zach Domke, Ryan McClanahan, Alexander Ng, Logan Somoza, Alexandria Ikuma
 Author-email: Yekta Yazar <yazar@slac.stanford.edu>

{pydmconverter-0.0.0 → pydmconverter-1.0.3}/PyDMConverter.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyDMConverter
-Version: 0.0.0
+Version: 1.0.3
 Summary: converter to generate pydm .ui files from other display managers.
 Author: Devan Agrawal, Zach Domke, Ryan McClanahan, Alexander Ng, Logan Somoza, Alexandria Ikuma
 Author-email: Yekta Yazar <yazar@slac.stanford.edu>

{pydmconverter-0.0.0 → pydmconverter-1.0.3}/PyDMConverter.egg-info/SOURCES.txt

@@ -3,7 +3,6 @@
 LICENSE
 README.md
 environment.yml
-launch_gui.sh
 mkdocs.yml
 pyproject.toml
 .github/ISSUE_TEMPLATE/bug-report.yml
@@ -55,6 +54,8 @@ examples/prosilica.edl
 pydmconverter/__init__.py
 pydmconverter/__main__.py
 pydmconverter/custom_types.py
+pydmconverter/exceptions.py
+pydmconverter/launch_gui.sh
 pydmconverter/widgets.py
 pydmconverter/widgets_helpers.py
 pydmconverter/edm/__init__.py
@@ -63,7 +64,11 @@ pydmconverter/edm/converter_helpers.py
 pydmconverter/edm/menumux.py
 pydmconverter/edm/parser.py
 pydmconverter/edm/parser_helpers.py
+pydmconverter/sites/__init__.py
+pydmconverter/sites/slac.py
 tests/__init__.py
+tests/test_main.py
+tests/test_sites.py
 tests/test_widgets.py
 tests/test_widgets_helpers.py
 tests/edm/test_converter.py

{pydmconverter-0.0.0 → pydmconverter-1.0.3}/PyDMConverter.egg-info/top_level.txt

@@ -1 +1,2 @@
+app
 pydmconverter

{pydmconverter-0.0.0 → pydmconverter-1.0.3}/docs/arguments.md

@@ -15,6 +15,26 @@ This argument allows users to override the output file if it already exists. Mos
 
 This argument adds scroll bars to converted screens. It will ad a horizontal and vertical scroll bar. If this argument is not included, the screen will not contain a scroll bar.
 
+## Site
+
+`--site <name>`
+
+This argument applies site-specific conversion rules during the conversion process. Some facilities have EDM widgets or patterns that have no equivalent in PyDM and should be skipped or handled differently. The `--site` flag lets you opt into these rules without affecting the default conversion behavior.
+
+**Available sites:**
+
+| Site   | Rules Applied |
+|--------|---------------|
+| `slac` | Skips `activeExitButtonClass` (exit buttons present on every SLAC EDM screen that have no PyDM equivalent) |
+
+**Usage:**
+``` bash
+pydmconverter /path/to/file.edl output.ui --site slac
+```
+
+**Adding a new site:**
+To add conversion rules for a new site, create a new module in `pydmconverter/sites/` (e.g. `mysite.py`) that defines a `SKIP_WIDGETS` set, then register it in `pydmconverter/sites/__init__.py`.
+
 ## Help
 
 `-h` or `--help`

pydmconverter-1.0.3/docs/user_guide.md

@@ -0,0 +1,78 @@
+#Installation
+
+##Prerequisites
+
+## Installation Methods
+
+### Option 1: Install from PyPI (Recommended)
+The easiest way to install the converter is directly from PyPI:
+``` bash
+pip install PyDMConverter
+```
+
+### Option 2: Install from Source
+If you need the latest development version or want to contribute:
+
+#### Clone the Repository
+``` bash
+git clone https://github.com/slaclab/pydm-converter-tool.git
+cd pydm-converter-tool
+```
+
+#### Set up Environment
+Using `conda`:
+``` bash
+conda env create -f environment.yml
+conda activate pydm
+```
+
+Or using pip:
+``` bash
+pip install -e .
+```
+
+# How to Run the Converter
+
+The converter can be run in two ways: via the command line interface (CLI) or through the graphical user interface (GUI).
+
+## Launch the GUI
+
+To launch the graphical interface:
+``` bash
+pydmconverter
+```
+
+This will open the PyDM Converter GUI where you can:
+- Select files or folders to convert
+
+## Command Line Interface
+
+The CLI provides two main ways to run the converter: on individual files and entire folders. Users can include additional arguments described on the [Arguments] page.
+
+  [Arguments]: arguments.md
+
+## For individual files
+When using the converter on a single file, the command line is:
+``` bash
+pydmconverter '/path/old_file.edl' 'new_file_name.ui' `
+```
+## For an entire folder
+When converting an entire folder, the command line is:
+``` bash
+pydmconverter '/path_to_old_directory' '/new_file_location' 'old_file_type'
+```
+
+## Examples
+To convert EDM file called "file.edl" to PYDM file called "file.ui" :
+``` bash
+pydmconverter /afs/slac/g/lcls/edm/file.edl file.ui`
+```
+To convert EDM files in a folder called "edm" to PYDM file in the current folder :
+``` bash
+pydmconverter /afs/slac/g/lcls/edm . .edl
+```
+
+To convert with SLAC-specific rules (e.g. skipping exit buttons):
+``` bash
+pydmconverter /afs/slac/g/lcls/edm/file.edl file.ui --site slac
+```

{pydmconverter-0.0.0 → pydmconverter-1.0.3}/pydmconverter/__main__.py

@@ -7,7 +7,7 @@ from pydmconverter.edm.converter import convert
 from pathlib import Path
 import logging
 
-logging.basicConfig(level=logging.INFO)
+logging.basicConfig(level=logging.WARNING)
 
 
 IMAGE_FILE_SUFFIXES = {".png", ".jpg", ".jpeg", ".gif"}
@@ -17,11 +17,19 @@ def run_gui() -> None:
     """
     launch the PyDMConverter gui
     """
-    # subprocess.run(["pydm", "--hide-nav-bar", "--hide-menu-bar", "view/main_window.py"])
-    subprocess.run(["bash", "launch_gui.sh"], check=True)
+    # Get the directory where this package is installed
+    package_dir = Path(__file__).parent
+    launch_script = package_dir / "launch_gui.sh"
+
+    if not launch_script.exists():
+        raise FileNotFoundError(
+            f"launch_gui.sh not found at {launch_script}. Please ensure the package was installed correctly."
+        )
+
+    subprocess.run(["bash", str(launch_script)], check=True)
 
 
-def run(input_file, output_file, input_file_type=".edl", override=False, scrollable=False):
+def run(input_file, output_file, input_file_type=".edl", override=False, scrollable=False, site=None):
     input_path: Path = Path(input_file)
     output_path: Path = Path(output_file)
 
@@ -31,7 +39,7 @@ def run(input_file, output_file, input_file_type=".edl", override=False, scrolla
         if output_path.is_file() and not override:
             raise FileExistsError(f"Output file '{output_path}' already exists. Use --override or -o to overwrite it.")
         copy_img_files(input_path.parent, output_path.parent)
-        convert(str(input_path), str(output_path), scrollable)
+        convert(str(input_path), str(output_path), scrollable, site=site)
     else:
         if input_file_type[0] != ".":  # prepending . so it will not pick up other file types with same suffix
             input_file_type = "." + input_file_type
@@ -39,7 +47,7 @@ def run(input_file, output_file, input_file_type=".edl", override=False, scrolla
         files_found: int
         files_failed: list[str]
         files_found, files_failed = convert_files_in_folder(
-            input_path, output_path, input_file_type, override, scrollable
+            input_path, output_path, input_file_type, override, scrollable, site=site
         )
 
         if files_found == 0:
@@ -68,7 +76,8 @@ def run_cli(args: argparse.Namespace) -> None:
     input_file_type: str = args.output_type
     override: bool = args.override
     scrollable: bool = args.scrollable
-    run(input_file, output_file, input_file_type, override, scrollable)
+    site: str = args.site
+    run(input_file, output_file, input_file_type, override, scrollable, site=site)
 
 
 """
@@ -90,7 +99,7 @@ def run_cli(args: argparse.Namespace) -> None:
         files_found: int
         files_failed: list[str]
         files_found, files_failed = convert_files_in_folder(
-            input_path, output_path, input_file_type, override, scrollable
+            input_path, output_path, input_file_type, override, scrollable, site=site
         )
 
         if files_found == 0:
@@ -117,7 +126,7 @@ def copy_img_files(input_path: Path, output_path: Path) -> None:
 
 
 def convert_files_in_folder(
-    input_path: Path, output_path: Path, input_file_type: str, override: bool, scrollable: bool
+    input_path: Path, output_path: Path, input_file_type: str, override: bool, scrollable: bool, site=None
 ) -> tuple[int, list[str]]:
     """Recursively runs convert on files in directory and subdirectories
 
@@ -153,17 +162,16 @@ def convert_files_in_folder(
             logging.warning(f"Skipped: {output_file_path} already exists. Use --override or -o to overwrite it.")
         else:
             try:
-                convert(file, output_file_path, scrollable)
+                convert(file, output_file_path, scrollable, site=site)
             except Exception as e:
                 files_failed.append(str(file))
                 logging.warning(f"Failed to convert {file}: {e}")
-                breakpoint()
                 continue
 
     subdirectories = [item for item in input_path.iterdir() if item.is_dir()]
     for subdir in subdirectories:
         sub_found, sub_failed = convert_files_in_folder(
-            subdir, output_path / subdir.name, input_file_type, override, scrollable
+            subdir, output_path / subdir.name, input_file_type, override, scrollable, site=site
         )
         files_found += sub_found
         files_failed += sub_failed
@@ -219,6 +227,12 @@ def main() -> None:
         action="store_true",
         help="create scrollable pydm windows that replicate edm windows (may cause spacing issues for embedded displays)",
     )
+    parser.add_argument(
+        "--site",
+        type=str,
+        default=None,
+        help="Apply site-specific conversion rules (e.g., slac)",
+    )
     args: argparse.Namespace = parser.parse_args()
 
     if args.input_file:

{pydmconverter-0.0.0 → pydmconverter-1.0.3}/pydmconverter/edm/converter.py

@@ -2,7 +2,7 @@ from pydmconverter.edm.parser import EDMFileParser, EDMObject
 import xml.etree.ElementTree as ET
 from pydmconverter.edm.converter_helpers import convert_edm_to_pydm_widgets
 import logging
-from pprint import pprint
+
 from pydmconverter.widgets_helpers import PageHeader
 
 logger = logging.getLogger(__name__)
@@ -13,6 +13,7 @@ CUSTOM_WIDGET_DEFINITIONS = {
     "PyDMDrawingEllipse": {"extends": "QWidget", "header": "pydm.widgets.drawing", "container": ""},
     "PyDMDrawingLine": {"extends": "QWidget", "header": "pydm.widgets.drawing", "container": ""},
     "PyDMDrawingPolyline": {"extends": "QWidget", "header": "pydm.widgets.drawing", "container": ""},
+    "PyDMDrawingIrregularPolygon": {"extends": "QWidget", "header": "pydm.widgets.drawing", "container": ""},
     "PyDMLabel": {"extends": "QLabel", "header": "pydm.widgets.label", "container": ""},
     "PyDMEnumComboBox": {"extends": "QComboBox", "header": "pydm.widgets.enum_combo_box", "container": ""},
     "PyDMPushButton": {"extends": "QPushButton", "header": "pydm.widgets.pushbutton", "container": ""},
@@ -40,6 +41,7 @@ CUSTOM_WIDGET_DEFINITIONS = {
     "PyDMByteIndicator": {"extends": "QWidget", "header": "pydm.widgets.byte", "container": ""},
     "PyDMLineEdit": {"extends": "QLineEdit", "header": "pydm.widgets.line_edit", "container": ""},
     "PyDMDrawingArc": {"extends": "QWidget", "header": "pydm.widgets.drawing", "container": ""},
+    "PyDMDrawingPie": {"extends": "QWidget", "header": "pydm.widgets.drawing", "container": ""},
     "PyDMWaveformPlot": {"extends": "QWidget", "header": "pydm.widgets.waveformplot", "container": ""},
     "PyDMScaleIndicator": {"extends": "QWidget", "header": "pydm.widgets.scale", "container": ""},
     "PyDMShellCommand": {"extends": "QPushButton", "header": "pydm.widgets.shell_command", "container": ""},
@@ -48,10 +50,9 @@ CUSTOM_WIDGET_DEFINITIONS = {
 }
 
 
-def convert(input_path, output_path, scrollable=False):
+def convert(input_path, output_path, scrollable=False, site=None):
     try:
         edm_parser = EDMFileParser(input_path, output_path)
-        pprint(edm_parser.ui, indent=2)
         logger.info(f"Successfully parsed EDM file: {input_path}")
     except FileNotFoundError:
         logger.error("File Not Found")
@@ -59,7 +60,7 @@ def convert(input_path, output_path, scrollable=False):
 
     # edm_parser.ui, _, _ = replace_calc_and_loc_in_edm_content(edm_parser.ui, input_path)
 
-    pydm_widgets, used_classes = convert_edm_to_pydm_widgets(edm_parser)
+    pydm_widgets, used_classes = convert_edm_to_pydm_widgets(edm_parser, site=site)
     logger.info(f"Converted EDM objects to {len(pydm_widgets)} PyDM widgets.")
 
     page_header = PageHeader()
@@ -85,10 +86,15 @@ def convert(input_path, output_path, scrollable=False):
     tree.write(output_path, encoding="utf-8", xml_declaration=True)
 
 
+QT_BASE_CLASSES = {"QPushButton", "QTabWidget", "QFrame", "QLabel", "QWidget", "QLineEdit", "QComboBox", "QTableWidget"}
+
+
 def build_customwidgets_element(used_classes: set) -> ET.Element:
     customwidgets_el = ET.Element("customwidgets")
 
     for cls_name in sorted(used_classes):
+        if cls_name in QT_BASE_CLASSES:
+            continue
         if cls_name not in CUSTOM_WIDGET_DEFINITIONS:
             logger.warning(f"Could not find custom widget {cls_name} in CUSTOM_WIDGET_DEFINITIONS")
             continue