Feature/ Added unroll command in PYQASM CLI by vinayswamik · Pull Request #224 · qBraid/pyqasm

vinayswamik · 2025-06-30T01:21:03Z

Summary of changes

Add unroll command to PyQASM CLI

Introduced a new unroll command for unrolling OpenQASM files, allowing users to process multiple files or directories.
Implemented options for skipping files (-s or --skip), overwriting original files (--overwrite), and specifying output paths (--output or -o).
Added validation to ensure output paths are only used with single input files.
Created a new unroll.py module to handle the unrolling logic.
Enhanced CLI tests to cover various scenarios for the new command, including help output, single file processing, directory handling, and error cases.

Closes #189

codecov-commenter · 2025-06-30T01:51:22Z

Codecov Report

Attention: Patch coverage is 96.21212% with 5 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
src/pyqasm/cli/unroll.py	96.36%	4 Missing ⚠️
src/pyqasm/cli/validate.py	88.88%	1 Missing ⚠️

📢 Thoughts on this report? Let us know!

src/pyqasm/cli/main.py

TheGupta2012 · 2025-06-30T06:53:44Z

src/pyqasm/cli/unroll.py

+
+        except (ValidationError, UnrollError, QasmParsingError) as err:
+            failed_files.append((file_path, err))
+        except Exception as uncaught_err:  # pylint: disable=broad-exception-caught


If we are creating the file at output_path and an error occurs, better to add a remove file in this exception block

Actually, if output path already exists, files might get effect from remove. instead i will try writing to temp file if it succeed then remove the tempfile and add it to output file.

src/pyqasm/cli/unroll.py

src/pyqasm/cli/main.py

src/pyqasm/cli/unroll.py

tests/cli/test_cli_commands.py

TheGupta2012

Hi @vinayswamik , looks good overall! Gave some comments related to refactoring and minor updates to error handling / reporting

- Added `unroll` command to PYQASM cli. - Added test cases.

- code refactor

Co-authored-by: Harshit Gupta <harshit.11235@gmail.com>

- Updated `unroll` command in `main.py` to accept optional parameters for `skip_files` and `overwrite`. - Introduced a new method in `QasmModule` to determine if files should be skipped based on specific tags. - Enhanced error reporting in the `unroll_qasm` function to include raw logger output for better debugging. - Added comprehensive tests for the `unroll` command, covering various scenarios including file skipping, output handling, and error cases.

TheGupta2012

Hi @vinayswamik , changes lgtm - just one edit about skip files and then we should be good to merge!

src/pyqasm/cli/unroll.py

TheGupta2012

Lgtm

vinayswamik requested a review from TheGupta2012 as a code owner June 30, 2025 01:21