wxGUI: New History pane for launching commands from history log #3234

lindakarlovska · 2023-11-10T15:27:46Z

This PR creates a new History pane which allows us to launch commands contained in .wxgui_history file.
The history pane is visible on the right side:

It tries to parse the command. If the parsing is not successful, it writes the message: "History record cound not be parsed into command" into the Main window statusbar. In the case when parsing successes, it opens the dialog with filled command parameters.

History panel is also linked to mapset switching, so when mapset is switched the tree is regenerated based on the relevant wxgui_history file.

…plements the Run method

lindakarlovska · 2023-11-10T21:06:47Z

@petrasovaa why did you unassign me?

wenzeslaus · 2023-11-11T01:11:46Z

@petrasovaa why did you unassign me?

@lindakladivova Nothing changes for you, but during PSC meeting today, we agreed on an initial policy for handling PRs and this was a one of the PRs we tested the policy on. Each PR should have a assignee who is responsible for moving the PR towards being closed. We will work on making this official. While for issues, nothing changes, assignee for a PR will be someone with write access, i.e., someone who can do the actual merge when the code is ready. You can comment on that in #3235.

wenzeslaus · 2023-11-11T02:01:33Z

it write the message: "History record cound not be parsed into command"

Maybe it can open a dialog just like in the successful case, but say "...but here it is and you can copy it and modify as needed: ...".

lindakarlovska · 2023-11-13T22:08:14Z

it write the message: "History record cound not be parsed into command"

Maybe it can open a dialog just like in the successful case, but say "...but here it is and you can copy it and modify as needed: ...".

Yes, It could open the module dialog based on the module called, but the issue is that in a history file, there can be lots of mistakes (calling of nonexisting modules etc.) so probably when the module is decoded, we can launch the relevant empty module dialog but otherwise, just show the message "History record cound not be parsed into command" in the statusbar?

I was also thinking about history file itself. I would suggest changing it to JSON format and to also save dates within it or other information such as "task failed", "task succeeded". It could possibly be the tree of dates with subitems as commands. What do you think @petrasovaa ?

These improvements could be implemented in following PRs. 🙂

petrasovaa · 2023-11-16T05:01:00Z

Just a quick testing, it looks like the content is not being updated when you run a tool?

petrasovaa · 2023-11-16T14:47:26Z

I am getting:

Traceback (most recent call last):
  File "/home/anna/dev/grass/grass/dist.x86_64-pc-linux-
gnu/gui/wxpython/gui_core/forms.py", line 870, in OnRun

ret = self._gconsole.RunCmd(cmd, onDone=self.OnDone)
  File "/home/anna/dev/grass/grass/dist.x86_64-pc-linux-
gnu/gui/wxpython/core/gconsole.py", line 501, in RunCmd

self.UpdateHistoryFile(cmd_save_to_history)
  File "/home/anna/dev/grass/grass/dist.x86_64-pc-linux-
gnu/gui/wxpython/core/gconsole.py", line 823, in
UpdateHistoryFile

fileHistory = codecs.open(filePath, encoding="utf-8",
mode="a")
  File "/usr/lib/python3.8/codecs.py", line 905, in open

file = builtins.open(filename, mode, buffering)
TypeError
:
expected str, bytes or os.PathLike object, not NoneType

It looks like this happens in a new mapset.

petrasovaa

I think putting the code in menu.py and menudata.py is not a good choice, it's unrelated. Either put it all in one file history.py, which could go into lmgr/ or create a history folder (similar to datacatalog) and put the files there.

python/grass/grassdb/checks.py

…from empty history mapset, creating a new updateHistory signal

…ng history file moved to new grassdb/history.py

lindakarlovska · 2023-11-18T13:15:33Z

I think putting the code in menu.py and menudata.py is not a good choice, it's unrelated. Either put it all in one file history.py, which could go into lmgr/ or create a history folder (similar to datacatalog) and put the files there.

You are right, I created the folder history_catalog and inside there are new python files "catalog" and "tree".

lindakarlovska · 2023-11-18T13:17:28Z

Just a quick testing, it looks like the content is not being updated when you run a tool?

Now fixed. I created a new signal giface.updateHistory and connected several methods to it.

lindakarlovska · 2023-11-18T13:17:40Z

I am getting:

Traceback (most recent call last):
  File "/home/anna/dev/grass/grass/dist.x86_64-pc-linux-
gnu/gui/wxpython/gui_core/forms.py", line 870, in OnRun

ret = self._gconsole.RunCmd(cmd, onDone=self.OnDone)
  File "/home/anna/dev/grass/grass/dist.x86_64-pc-linux-
gnu/gui/wxpython/core/gconsole.py", line 501, in RunCmd

self.UpdateHistoryFile(cmd_save_to_history)
  File "/home/anna/dev/grass/grass/dist.x86_64-pc-linux-
gnu/gui/wxpython/core/gconsole.py", line 823, in
UpdateHistoryFile

fileHistory = codecs.open(filePath, encoding="utf-8",
mode="a")
  File "/usr/lib/python3.8/codecs.py", line 905, in open

file = builtins.open(filename, mode, buffering)
TypeError
:
expected str, bytes or os.PathLike object, not NoneType

It looks like this happens in a new mapset.

Fixed.

landam

Currently wxGUI fails when wxgui_history file is missing (open GUI first time in a new mapset):

  File "/usr/lib/python3/dist-packages/wx/core.py", line 3427, in <lambda>
    lambda event: event.callable(*event.args, **event.kw) )
                  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/martin/src/grass/dist.x86_64-pc-linux-gnu/gui/wxpython/wxgui.py", line 93, in show_main_gui
    mainframe = GMFrame(
                ^^^^^^^^
  File "/home/martin/src/grass/dist.x86_64-pc-linux-gnu/gui/wxpython/main_window/frame.py", line 184, in __init__
    self.BuildPanes()
  File "/home/martin/src/grass/dist.x86_64-pc-linux-gnu/gui/wxpython/main_window/frame.py", line 571, in BuildPanes
    self._createConsole(parent=self)
  File "/home/martin/src/grass/dist.x86_64-pc-linux-gnu/gui/wxpython/main_window/frame.py", line 370, in _createConsole
    self.goutput = GConsoleWindow(
                   ^^^^^^^^^^^^^^^
  File "/home/martin/src/grass/dist.x86_64-pc-linux-gnu/gui/wxpython/gui_core/goutput.py", line 146, in __init__
    self._loadHistory()
  File "/home/martin/src/grass/dist.x86_64-pc-linux-gnu/gui/wxpython/gui_core/goutput.py", line 263, in _loadHistory
    self.cmdPrompt.cmdbuffer = read_history(history_path)
                               ^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/martin/src/grass/dist.x86_64-pc-linux-gnu/etc/python/grass/grassdb/history.py", line 38, in read_history
    fileHistory = codecs.open(
                  ^^^^^^^^^^^^
  File "<frozen codecs>", line 918, in open
TypeError: expected str, bytes or os.PathLike object, not NoneType

lindakarlovska · 2023-11-19T12:15:56Z

Currently wxGUI fails when wxgui_history file is missing (open GUI first time in a new mapset):

  File "/usr/lib/python3/dist-packages/wx/core.py", line 3427, in <lambda>

    lambda event: event.callable(*event.args, **event.kw) )

                  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

  File "/home/martin/src/grass/dist.x86_64-pc-linux-gnu/gui/wxpython/wxgui.py", line 93, in show_main_gui

    mainframe = GMFrame(

                ^^^^^^^^

  File "/home/martin/src/grass/dist.x86_64-pc-linux-gnu/gui/wxpython/main_window/frame.py", line 184, in __init__

    self.BuildPanes()

  File "/home/martin/src/grass/dist.x86_64-pc-linux-gnu/gui/wxpython/main_window/frame.py", line 571, in BuildPanes

    self._createConsole(parent=self)

  File "/home/martin/src/grass/dist.x86_64-pc-linux-gnu/gui/wxpython/main_window/frame.py", line 370, in _createConsole

    self.goutput = GConsoleWindow(

                   ^^^^^^^^^^^^^^^

  File "/home/martin/src/grass/dist.x86_64-pc-linux-gnu/gui/wxpython/gui_core/goutput.py", line 146, in __init__

    self._loadHistory()

  File "/home/martin/src/grass/dist.x86_64-pc-linux-gnu/gui/wxpython/gui_core/goutput.py", line 263, in _loadHistory

    self.cmdPrompt.cmdbuffer = read_history(history_path)

                               ^^^^^^^^^^^^^^^^^^^^^^^^^^

  File "/home/martin/src/grass/dist.x86_64-pc-linux-gnu/etc/python/grass/grassdb/history.py", line 38, in read_history

    fileHistory = codecs.open(

                  ^^^^^^^^^^^^

  File "<frozen codecs>", line 918, in open

TypeError: expected str, bytes or os.PathLike object, not NoneType

Ah ok, thanks for catching Martin. I had fixed it but probably through several iterations, it has occured again… I will look at it.

python/grass/grassdb/history.py

gui/wxpython/history_catalog/catalog.py

…is not created yet

gui/wxpython/history/browser.py

python/grass/grassdb/history.py

gui/wxpython/history/tree.py

gui/wxpython/gui_core/goutput.py

gui/wxpython/history/browser.py

python/grass/grassdb/history.py

Co-authored-by: Anna Petrasova <kratochanna@gmail.com>

petrasovaa

Almost there!

gui/wxpython/history/browser.py

gui/wxpython/gui_core/goutput.py

already adressed

…o#3234)

lindakladivova added 4 commits November 7, 2023 12:52

rebase 1

fd91365

work in process

ff31b27

fixes loading of history model when the switching between mapsets, im…

61c2963

…plements the Run method

simplification

e46dfcb

lindakarlovska self-assigned this Nov 10, 2023

lindakarlovska added enhancement New feature or request GUI wxGUI related labels Nov 10, 2023

lindakarlovska added this to the 8.4.0 milestone Nov 10, 2023

lindakarlovska requested review from landam and petrasovaa November 10, 2023 15:38

black

13917c0

lindakarlovska force-pushed the wxGUI-simple-module-history-tab branch from 3375976 to 13917c0 Compare November 10, 2023 15:49

petrasovaa assigned petrasovaa and unassigned lindakarlovska Nov 10, 2023

petrasovaa requested changes Nov 17, 2023

View reviewed changes

petrasovaa reviewed Nov 17, 2023

View reviewed changes

python/grass/grassdb/checks.py Outdated Show resolved Hide resolved

lindakladivova added 2 commits November 18, 2023 10:56

fix updating tree after launching the command, fix launching command …

95ebd1a

…from empty history mapset, creating a new updateHistory signal

created new directory history_catalog and functions related to managi…

c624eb4

…ng history file moved to new grassdb/history.py

lindakladivova added 3 commits November 18, 2023 15:34

obecna funkce get_mapset_history_path

09ade10

optimalization

7b02711

black

b483b7c

compilation error fixed

16ea6b6

landam previously requested changes Nov 19, 2023

View reviewed changes

fix os.PathLike object None error

9b752b7

petrasovaa reviewed Nov 27, 2023

View reviewed changes

python/grass/grassdb/history.py Outdated Show resolved Hide resolved

petrasovaa reviewed Nov 27, 2023

View reviewed changes

python/grass/grassdb/history.py Outdated Show resolved Hide resolved

petrasovaa reviewed Nov 27, 2023

View reviewed changes

python/grass/grassdb/history.py Outdated Show resolved Hide resolved

petrasovaa reviewed Nov 28, 2023

View reviewed changes

python/grass/grassdb/history.py Outdated Show resolved Hide resolved

petrasovaa reviewed Nov 28, 2023

View reviewed changes

gui/wxpython/history_catalog/catalog.py Outdated Show resolved Hide resolved

incorporating Anna's comments and fixing the error when history file …

596c50c

…is not created yet

petrasovaa reviewed Dec 1, 2023

View reviewed changes

gui/wxpython/history/browser.py Outdated Show resolved Hide resolved

petrasovaa reviewed Dec 1, 2023

View reviewed changes

python/grass/grassdb/history.py Outdated Show resolved Hide resolved

petrasovaa reviewed Dec 1, 2023

View reviewed changes

python/grass/grassdb/history.py Outdated Show resolved Hide resolved

petrasovaa reviewed Dec 1, 2023

View reviewed changes

gui/wxpython/history/tree.py Outdated Show resolved Hide resolved

petrasovaa reviewed Dec 1, 2023

View reviewed changes

gui/wxpython/gui_core/goutput.py Outdated Show resolved Hide resolved

petrasovaa reviewed Dec 1, 2023

View reviewed changes

gui/wxpython/history/browser.py Outdated Show resolved Hide resolved

petrasovaa reviewed Dec 1, 2023

View reviewed changes

python/grass/grassdb/history.py Outdated Show resolved Hide resolved

lindakarlovska and others added 5 commits December 1, 2023 16:50

Update gui/wxpython/history/browser.py

a57a8f6

Co-authored-by: Anna Petrasova <kratochanna@gmail.com>

Update gui/wxpython/history/browser.py

f5b2c63

Co-authored-by: Anna Petrasova <kratochanna@gmail.com>

Update python/grass/grassdb/history.py

99ddf96

Co-authored-by: Anna Petrasova <kratochanna@gmail.com>

exception chaining and other small edits

c842d0f

exception chaining and removing codecs dependancy

d36cfb5

lindakarlovska requested a review from petrasovaa December 1, 2023 20:57

petrasovaa requested changes Dec 7, 2023

View reviewed changes

gui/wxpython/history/browser.py Outdated Show resolved Hide resolved

gui/wxpython/history/browser.py Outdated Show resolved Hide resolved

gui/wxpython/gui_core/goutput.py Outdated Show resolved Hide resolved

minor improvements

b03d006

lindakarlovska requested a review from petrasovaa December 7, 2023 18:45

petrasovaa approved these changes Dec 8, 2023

View reviewed changes

petrasovaa merged commit 8fd28c4 into OSGeo:main Dec 8, 2023
18 checks passed

HuidaeCho pushed a commit to HuidaeCho/grass that referenced this pull request Jan 9, 2024

wxGUI: New History pane for launching commands from history log (OSGe…

cac9e17

…o#3234)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

wxGUI: New History pane for launching commands from history log #3234

wxGUI: New History pane for launching commands from history log #3234

lindakarlovska commented Nov 10, 2023 •

edited

Loading

lindakarlovska commented Nov 10, 2023

wenzeslaus commented Nov 11, 2023

wenzeslaus commented Nov 11, 2023

lindakarlovska commented Nov 13, 2023

petrasovaa commented Nov 16, 2023

petrasovaa commented Nov 16, 2023

petrasovaa left a comment

lindakarlovska commented Nov 18, 2023

lindakarlovska commented Nov 18, 2023

lindakarlovska commented Nov 18, 2023

landam left a comment

lindakarlovska commented Nov 19, 2023

petrasovaa left a comment

wxGUI: New History pane for launching commands from history log #3234

wxGUI: New History pane for launching commands from history log #3234

Conversation

lindakarlovska commented Nov 10, 2023 • edited Loading

lindakarlovska commented Nov 10, 2023

wenzeslaus commented Nov 11, 2023

wenzeslaus commented Nov 11, 2023

lindakarlovska commented Nov 13, 2023

petrasovaa commented Nov 16, 2023

petrasovaa commented Nov 16, 2023

petrasovaa left a comment

Choose a reason for hiding this comment

lindakarlovska commented Nov 18, 2023

lindakarlovska commented Nov 18, 2023

lindakarlovska commented Nov 18, 2023

landam left a comment

Choose a reason for hiding this comment

lindakarlovska commented Nov 19, 2023

petrasovaa left a comment

Choose a reason for hiding this comment

lindakarlovska commented Nov 10, 2023 •

edited

Loading