[polucifier]

Description

Note: This PR description was updated post-merge to accurately reflect the final, expanded scope of the implemented features.

This PR enhances the user experience in the GRASS GUI module dialogs by introducing advanced options for copying and pasting module configurations. It streamlines the transition between GUI workflows, command-line execution, and Python scripting.

Key Features

• Advanced Copy Drop-down: Enhances the existing Copy button by adding a drop-down arrow that reveals multiple export formats.
• Copy Options Included: Shell command, Python (Script API), Python (Tools API), Python (PyGRASS), and JSON settings.
• Paste JSON Settings Button: Adds a dedicated, standalone button that allows users to instantly populate the module dialog inputs by pasting previously exported JSON settings.

[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.

[polucifier]

Hi @pesekon2, thanks for the feedback! I'm glad the functionality works well for you.

Regarding the missing arrow: I have the same version of wxPython (4.2.3). You were right—the issue was most likely caused by the previous implementation using a text-based character for the chevron, which renders inconsistently across different platforms and themes.

To resolve this and ensure a professional look on all systems, I have completely overhauled the visual implementation in the latest commit.

Technical Improvements:

• Custom Drawing with wx.GCDC: Instead of relying on text characters, I am now drawing the chevron icon manually. Using wx.GCDC ensures smooth, anti-aliased lines.
• True Transparency: I switched to wx.Bitmap.FromRGBA to create a 32-bit bitmap. This eliminates "black box" artifacts and ensures the button background blends perfectly with the native UI.
• Automatic Theme Support: The icon color is now dynamically pulled from wx.SYS_COLOUR_BTNTEXT, making it fully compatible with both light and dark system themes.
• Pixel-Perfect Alignment: I've implemented platform-specific vertical offsets (including a -2px shift for Windows). The chevron is now mathematically and visually aligned with the baseline of the "Copy" text (specifically the letter 'C'), verified down to the pixel in GIMP.

Here is the final result across different environments:

Linux - Dark Theme

Linux - Light Theme

Windows - Light Theme

[pesekon2]

Thanks. Now I got the arrow there. A weird and ugly one but something is there.

But I got two more points:

1. The button Paste is not really self-exlanatory. Could the text be clearer? Like Paste JSON settings? I don't want to make the bar too long (but cannot come with anything shorter now) but currently, the user doesn't really know what type should s/he paste there. Which comes to:
2. It should raise a clearer error message if something wrong is pasted. Currently, I just get Paste Error: Expecting value: line 1 column 1 (char 0).

[pesekon2]

2. It should raise a clearer error message if something wrong is pasted. Currently, I just get `Paste Error: Expecting value: line 1 column 1 (char 0)`.

Just an update on this: I get that error message if pasting a different thing than JSON. If pasting JSON from another module, I don't get any error message, it just doesn't do anything for the non-existing parameters and set those existing in the one they are pasted into.

[polucifier]

Changes:

• Native UI: Dropdown arrow now uses wx.RendererNative (size 23) for pixel-perfect consistency with other GRASS widgets.
• Renamed Label: Changed to _("Paste JSON settings") for better clarity.
• Module Safety: Added a validation check to warn users when pasting settings from a different GRASS module.
• Error Handling: Implemented try-except blocks with user-friendly error messages for invalid clipboard data.

Screenshots:

1. Consistent Native Arrow:

2. Module Mismatch Warning:

3. Invalid Data Handling:

[pesekon2]

Fine from my side. Approving.

@echoix: As I am not a target user for the Paste button, I am waiting for your opinion before merging it.

[echoix]

Im still favorable, as I use the equivalent with QGIS. My grass development setup is broken, so I can’t test it right away. I saw that you were able to make it run before, and checked out the rendering.

[pesekon2]

Im still favorable, as I use the equivalent with QGIS. My grass development setup is broken, so I can’t test it right away. I saw that you were able to make it run before, and checked out the rendering.

Yes, I tested it again today before approving and all seem smooth. So I take your favorable approach as yes and merge it. Thanks, @polucifier.