GUI: Add "Copy in Python" button to module dialogs

[polucifier]

Description

This PR introduces a new button "Copy in Python" to all GRASS module dialogs in the wxGUI. While the existing "Copy" button provides the shell command, this new feature generates valid Python syntax using the grass.script library (standard gs alias).

The goal is to streamline the workflow for users transitioning from the GUI to Python scripting and to provide a quick way to prototype scripts directly from the interface.

Key Features & Improvements

• Standard Syntax: Generates code using the gs.run_command() pattern, which is the most common entry point for GRASS scripting.
• Robust String Escaping: Uses Python's built-in repr() function for parameter values. This ensures that Windows file paths (backslashes), quotes, and special characters are handled correctly without breaking the Python string literal.
• Python Keyword Handling: Automatically detects reserved Python keywords (e.g., from, in, global). If a module parameter name conflicts with a keyword, the PR uses dictionary unpacking (e.g., **{'from': 'map'}) to ensure the generated code is syntactically valid.
• Global Parameters: Correctly translates GUI-specific items like --overwrite, --verbose, and --quiet into their Pythonic True/False arguments.
• Future-Proofing: Includes a fallback for any other double-dash flags (--) that might be introduced by third-party addons.

Example Output

For a module like v.distance -p -s --overwrite from=durham@user1 to=bridges@PERMANENT upload=dist format=plain, the button generates:

gs.run_command('v.distance', flags='ps', overwrite=True, to='bridges@PERMANENT', upload='dist', format='plain', **{'from': 'durham@user1'})

Testing

• Manually tested with various modules
• Verified that the generated strings are valid and executable when pasted into the GRASS Python console.

[echoix]

I like the concept, similar to what there is in QGIS, even if I never used these in qgis (only the copy as json and paste it again later on to rehave the same parameters set)

[polucifier]

I like the concept, similar to what there is in QGIS, even if I never used these in qgis (only the copy as json and paste it again later on to rehave the same parameters set)

Thanks for the feedback, @echoix! I really like the QGIS workflow you mentioned. I'm going to convert this PR to a Draft for now while I refine the UI.

My plan is to replace the standalone 'Copy in Python' button with a MenuButton (dropdown) integrated into the main 'Copy' button. It will include:

• Copy as Shell command (default)
• Copy as Python script (using the logic from this PR)
• Copy as JSON (as you suggested)

To complete the loop, I will also try to implement a 'Paste' button that can take a JSON string and automatically populate the dialog fields. I'll push these updates later this evening.

[ninsbl]

Nice. Did you consider returning tools API syntax?

[polucifier]

Nice. Did you consider returning tools API syntax?

Hi @ninsbl, thank you very much for the suggestion! That's a great idea. Since I'm already reworking the 'Copy' button into a dropdown menu, I'll add two more options to it: 'Copy as Python (Tools API)' and 'Copy as Python (PyGRASS)'.

Combined with the Script API and JSON options, this should cover all the major Python workflows in GRASS. I'll push the updates later.

[polucifier]

I have implemented a new Split Copy Button and a Paste functionality for the module dialogs. This update provides users with multiple export formats and a way to quickly restore or share tool parameters via JSON.

New UI layout with the Split Copy button and the Paste button:

The dropdown menu offers various formats, including the new Tools API and JSON:

The following examples demonstrate the generated output. Note that Python reserved keywords (e.g., from) are correctly handled using dictionary unpacking to ensure valid, executable code:
Shell command:

v.distance -p -s --overwrite from=durham@user1 to=bridges@PERMANENT upload=dist format=plain

Python (Script API):

gs.run_command('v.distance', flags='ps', overwrite=True, to='bridges@PERMANENT', upload='dist', format='plain', **{'from': 'durham@user1'})

Python (Tools API):

Tools().v_distance(flags='ps', overwrite=True, to='bridges@PERMANENT', upload='dist', format='plain', **{'from': 'durham@user1'})

Python (PyGRASS):

Module('v.distance', flags='ps', overwrite=True, to='bridges@PERMANENT', upload='dist', format='plain', **{'from': 'durham@user1'})

JSON format:

{
    "module": "v.distance",
    "params": {
        "flags": "ps",
        "overwrite": "True",
        "from": "durham@user1",
        "to": "bridges@PERMANENT",
        "upload": "dist",
        "format": "plain"
    }
}

Demonstration of the Paste functionality, which populates dialog fields and updates the command preview in real-time:
Paste.webm

[ninsbl]

Cool. Just for clarification: does Copy as JSON copy json equivalent to --json, or just the the parameters that were set with their values?

[ninsbl]

I now see the JSON structure in your comment above... Background for my question has been: #6697

[pesekon2]

The functionality is great. I really like it. I would have some doubts about the usability of the Paste button but if @echoix says he can imagine users for that, why not having it.

I tested the functionality and it seems fine to me. However, I don't see the arrow on the dropout of the Copy button. It seems seems to me more like a wxPython issue than being connected to the PR. What is your version of wx? Mine is 4.2.3.

[github-actions]

[ruff] _{reported by reviewdog 🐶}

Suggested change

	else str(val).lower() in ("true", "1", "yes")
	else str(val).lower() in {"true", "1", "yes"}