wxGUI: Add new mapset action to data catalog #731

lindakarlovska · 2020-06-23T20:00:35Z

No description provided.

…after a right click on a location. Two problems: the mapset is not created after confirmation in the dialog and the dialog box is not displayed for first location in the data tree.

petrasovaa

We discussed this with @wenzeslaus and there are couple things we would like you do, basically move some of the functionality from gis_set.py to guiutils and utils, specifically:

validation: validate legal name, ogr and if mapset already exists
- create GenericMultiValidator in gui_core/widgets, which will work as GenericValidator, but you can pass tuple of conditions and callbacks
- NewMapsetDialog will the have the callbacks defined inside the class (_nameValidaionFailed, the ogr check and also test whether the mapset already exists)
- ogr: we decided we shouldn't allow to create ogr mapset from GUI at all, so adjust the message
- create a simple function in guiutils to check if mapset exists (using os.path.exists), this will be then used for the validation
getDefaultMapsetName should be a standalone function in startup/utils

After this, adjust the code in gis_set.py to accommodate the new changes.

This allows to keep the tree.py cleaner.

Note: the goal here is to only create a mapset, not switch to it.

petrasovaa · 2020-06-24T03:01:35Z

gui/wxpython/datacatalog/tree.py

+            parent=self,
+            default=self._getDefaultMapsetName(),
+            validation_failed_handler=self._nameValidationFailed,
+            help_hanlder=self.OnHelp,


We do not need the help handler here

petrasovaa · 2020-06-24T03:02:16Z

gui/wxpython/datacatalog/tree.py

+        else:
+            return False
+
+    def CreateNewMapset(self, mapset):


This function would be basically just reduced to calling create_mapset.

petrasovaa · 2020-06-24T03:03:21Z

gui/wxpython/datacatalog/tree.py

+        self.listOfMapsets = GetListOfMapsets(self.gisdbase, 
+                                              self.selected_location[0])
+        if mapset in self.listOfMapsets:
+            GMessage(parent=self,
+                     message=_("Mapset <%s> already exists.") % mapset)
+            return False
+
+        if mapset.lower() == 'ogr':
+            dlg1 = wx.MessageDialog(
+                parent=self,
+                message=_(
+                    "Mapset <%s> is reserved for direct "
+                    "read access to OGR layers. Please consider to use "
+                    "another name for your mapset.\n\n"
+                    "Are you really sure that you want to create this mapset?") %
+                mapset,
+                caption=_("Reserved mapset name"),
+                style=wx.YES_NO | wx.NO_DEFAULT | wx.ICON_QUESTION)
+            ret = dlg1.ShowModal()
+            dlg1.Destroy()
+            if ret == wx.ID_NO:
+                dlg1.Destroy()
+                return False
+


Should be dealt with by the validator inside the dialog

petrasovaa · 2020-06-24T03:05:50Z

gui/wxpython/datacatalog/tree.py

+                return False
+
+        try:
+            create_mapset(self.gisdbase, self.selected_location[0], mapset)


there is no self.gisdbase, you can get it e.g. as gisenv()['GISDBASE']

petrasovaa · 2020-06-24T03:06:19Z

gui/wxpython/datacatalog/tree.py

+            self.OnSelectLocation(None)
+            self.lbmapsets.SetSelection(self.listOfMapsets.index(mapset))
+            self.bstart.SetFocus()
+


delete, copied from startup screen. Instead you will need to add the mapset node into the tree, see e.g. InsertLayer() in tree.py how it is done for layers (it should be simpler for mapsets).

petrasovaa · 2020-06-24T03:14:08Z

gui/wxpython/datacatalog/tree.py

+        """Create popup menu for locations"""
+        menu = Menu()
+        genv = gisenv()
+        currentLocation, currentMapset = self._isCurrent(genv)


not used, it is actually causing error when right clicking on current location, just remove it

… and callbacks. Defined callback and condition functions in NewMapsetDialog. Adjusted ogr massage in order to not allow to create ogr mapset. Deleted help handler. Created standalone function mapset_exists in utils.py. Renamed getDefaultMapsetName to get_defalt_mapset_name() and moved to utils.py. Adjusted the code in gis_set.py and in tree.py.

…ction mapset_exists moved from utils.py to guiutils.py.

lindakarlovska · 2020-06-25T10:51:06Z

We discussed this with @wenzeslaus and there are couple things we would like you do, basically move some of the functionality from gis_set.py to guiutils and utils, specifically:
* validation: validate legal name, ogr and if mapset already exists
  
  * create GenericMultiValidator in gui_core/widgets, which will work as GenericValidator, but you can pass tuple of conditions and callbacks
  * NewMapsetDialog will the have the callbacks defined inside the class (_nameValidaionFailed, the ogr check and also test whether the mapset already exists)
  * ogr: we decided we shouldn't allow to create ogr mapset from GUI at all, so adjust the message
  * create a simple function in guiutils to check if mapset exists (using os.path.exists), this will be then used for the validation

* getDefaultMapsetName should be a standalone function in startup/utils
After this, adjust the code in gis_set.py to accommodate the new changes.

This allows to keep the tree.py cleaner.

Note: the goal here is to only create a mapset, not switch to it.

Now two problems appears:

the mapset is created after confirmation in the dialog but ignore GenericMultiValidator
after adding mapset in datacatalog, this error appears:

gui/wxpython/gui_core/widgets.py

petrasovaa · 2020-06-25T14:16:12Z

gui/wxpython/datacatalog/tree.py

+            mapset = dlg.GetValue()
+            try:
+                create_mapset(self.gisdbase, self.location, mapset)
+                self.InsertMapset(name=mapset, location_node=self.location,


location_node is a of type class DictNode (treemodel.py), not string. Why to pass twice mapset?
You need to pass location node (probably self.selected_location[0] should work). Then most of the code in InsertMapset is to be removed.

Not sure how to simplify InsertMapset function. And not sure what parameter name means. I think it is necessary to include it but in this case it does not make much sense.

gui/wxpython/datacatalog/tree.py

petrasovaa · 2020-06-25T15:04:35Z

gui/wxpython/datacatalog/tree.py

+                self.InsertMapset(name=mapset, location_node=self.location,
+                                     mapset_name=mapset)
+                return True
+            except Exception as e:


It's a good practice to make the exception more specific if you can. For example, put it only around create_mapset and if you can see what type of exception it throws, it's better to limit it too.

Could you give me some example?

For type of error, either just simply try it in a python shell if that's simple, or check Python documentation. You can use OSError here.
Please also read e.g. https://realpython.com/python-exceptions/ and https://realpython.com/the-most-diabolical-python-antipattern/ (ignore the logging part), that should clarify the syntax and motivation.

gui/wxpython/datacatalog/tree.py

gui/wxpython/gis_set.py

gui/wxpython/startup/guiutils.py

gui/wxpython/startup/utils.py

…dator, corrected OnCreateMapset function in tree.py to be able to create mapsets, refactoring of code.

gui/wxpython/datacatalog/tree.py

petrasovaa · 2020-06-27T20:02:06Z

gui/wxpython/gis_set.py

+                GError(parent=self,
+                       message=_("Unable to create new mapset: %s") % e,
+                       showTraceback=False)
+                return False


similar here, I don't think you need to return T/F here

gui/wxpython/gui_core/widgets.py

gui/wxpython/startup/guiutils.py

gui/wxpython/startup/utils.py

petrasovaa · 2020-06-27T20:16:18Z

gui/wxpython/datacatalog/tree.py

+        found_element = found_element[0] if found_element else None
+        found = self._model.SearchNodes(parent=found_element, name=name)
+        if len(found) == 0:
+            self._model.AppendNode(parent=found_element, label=name,


parent is parent node (here location node), label is mapset name and type is type of node ('mapset' here)

I have a problem with parameters "name" and "mapset_name":
self.InsertMapset(name=mapset,
location_node=self.selected_location[0],
mapset_name=mapset)
I know that it is not possible to have two same parameters but do not know what else to insert for 'name' .
Now I am in this situation. I can create and refresh mapset but the tree has another branch:

I spent several hours on that and do not know how to solve it. I is probably simple but I cannot figure that out.

I am not sure what's the problem here, it is pretty simple:

def InsertMapset(self, name, location_node): """Insert mapset into model and refresh tree""" self._model.AppendNode(parent=location_node, label=name, data=dict(type='mapset', name=name)) self._model.SortChildren(location_node) self.RefreshNode(location_node, recursive=True)

petrasovaa · 2020-06-27T20:16:44Z

gui/wxpython/datacatalog/tree.py

+        found_element = self._model.SearchNodes(
+            parent=location_node, type='mapset', name=mapset_name)
+        found_element = found_element[0] if found_element else None
+        found = self._model.SearchNodes(parent=found_element, name=name)
+        if len(found) == 0:


you don't need this

petrasovaa · 2020-06-27T20:34:24Z

gui/wxpython/datacatalog/tree.py

        elif self.selected_type[0] and len(self.selected_type) == 1:
            self._popupMenuElement()
+        elif self.selected_mapset[0] and not self.selected_type[0] and len(self.selected_mapset) == 1:
+            self._popupMenuMapset()
+        elif self.selected_location[0] and not self.selected_type[0] and len(self.selected_location) == 1:


not sure why the selected_type, I think it should be selected_mapset instead, but I am not sure, please test that.

…ation, specified more particular exceptions, changed InsertMapset function.

petrasovaa · 2020-06-28T18:16:27Z

gui/wxpython/startup/guiutils.py

+        message = _(
+            "Mapset <%s> already exists. Please consider to use "
+            "another name for your location.") % {
+            'name': ctrl.GetValue()}


Please test and fix the message formatting.

petrasovaa · 2020-06-28T18:17:09Z

gui/wxpython/startup/guiutils.py

+            "Name <%s> is reserved for direct "
+            "read access to OGR layers. Please use "
+            "another name for your mapset.") % {
+            'name': ctrl.GetValue()}


Please test and fix the message formatting.

petrasovaa · 2020-06-28T18:22:47Z

gui/wxpython/datacatalog/tree.py

+                       message=_("Unable to create new mapset: %s") % err,
+                       showTraceback=False)
+            print(mapset)
+            print(self.selected_location[0])


remove print statements

gui/wxpython/datacatalog/tree.py

petrasovaa

There are still minor unresolved issues, see the comments.

…or things.

petrasovaa · 2020-06-30T13:20:49Z

gui/wxpython/startup/guiutils.py

+        message = _(
+            "Mapset <%s> already exists. Please consider to use "
+            "another name for your location.") % {
+             ctrl.GetValue()}


This is obviously not right, please fix again. Use format function.

It should look like Mapset <anna> already exists...

petrasovaa · 2020-06-30T17:50:44Z

gui/wxpython/startup/guiutils.py

+        message = _(
+            "Name '{}' is not a valid name for location or mapset. "
+            "Please use only ASCII characters excluding characters {} "
+            "and space.").format(ctrl.GetValue(),'/"\'@,=*~')


minor: missing space after comma

Add new mapset action to data catalog. Created window and dialog box …

bf8685e

…after a right click on a location. Two problems: the mapset is not created after confirmation in the dialog and the dialog box is not displayed for first location in the data tree.

lindakarlovska marked this pull request as draft June 23, 2020 20:02

petrasovaa added gsoc Reserved for Google Summer of Code student(s) GUI wxGUI related labels Jun 24, 2020

petrasovaa reviewed Jun 24, 2020

View reviewed changes

lindakladivova added 2 commits June 25, 2020 05:12

Corrected flake8, currentLocation removed from _popuMenuLocation, fun…

e47aa68

…ction mapset_exists moved from utils.py to guiutils.py.

petrasovaa reviewed Jun 25, 2020

View reviewed changes

gui/wxpython/gui_core/widgets.py Show resolved Hide resolved

petrasovaa reviewed Jun 25, 2020

View reviewed changes

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

petrasovaa reviewed Jun 25, 2020

View reviewed changes

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

petrasovaa reviewed Jun 25, 2020

View reviewed changes

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

petrasovaa reviewed Jun 25, 2020

View reviewed changes

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

petrasovaa reviewed Jun 25, 2020

View reviewed changes

gui/wxpython/gis_set.py Outdated Show resolved Hide resolved

petrasovaa reviewed Jun 25, 2020

View reviewed changes

gui/wxpython/startup/guiutils.py Outdated Show resolved Hide resolved

petrasovaa reviewed Jun 25, 2020

View reviewed changes

gui/wxpython/startup/guiutils.py Outdated Show resolved Hide resolved

petrasovaa reviewed Jun 25, 2020

View reviewed changes

gui/wxpython/startup/guiutils.py Outdated Show resolved Hide resolved

petrasovaa reviewed Jun 25, 2020

View reviewed changes

gui/wxpython/startup/guiutils.py Outdated Show resolved Hide resolved

petrasovaa reviewed Jun 25, 2020

View reviewed changes

gui/wxpython/startup/guiutils.py Outdated Show resolved Hide resolved

petrasovaa reviewed Jun 25, 2020

View reviewed changes

gui/wxpython/startup/utils.py Outdated Show resolved Hide resolved

petrasovaa linked an issue Jun 25, 2020 that may be closed by this pull request

[Feat] Add New Mapset action to the Data catalog #717

Closed

wxGUI/data catalog: Corrected Validation function in GenericMultiVali…

670fd0b

…dator, corrected OnCreateMapset function in tree.py to be able to create mapsets, refactoring of code.

petrasovaa reviewed Jun 27, 2020

View reviewed changes

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

petrasovaa reviewed Jun 27, 2020

View reviewed changes

gui/wxpython/datacatalog/tree.py Show resolved Hide resolved

petrasovaa reviewed Jun 27, 2020

View reviewed changes

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

petrasovaa reviewed Jun 27, 2020

View reviewed changes

gui/wxpython/gui_core/widgets.py Show resolved Hide resolved

petrasovaa reviewed Jun 27, 2020

View reviewed changes

gui/wxpython/startup/guiutils.py Outdated Show resolved Hide resolved

petrasovaa reviewed Jun 27, 2020

View reviewed changes

gui/wxpython/startup/utils.py Outdated Show resolved Hide resolved

petrasovaa reviewed Jun 27, 2020

View reviewed changes

wxGUI/datacatalog: Removed T/F returns from tree.py, corrected indent…

5057a27

…ation, specified more particular exceptions, changed InsertMapset function.

petrasovaa reviewed Jun 28, 2020

View reviewed changes

gui/wxpython/datacatalog/tree.py Show resolved Hide resolved

wxGUI/datacatalog: InsertMapset function edited.

3d80f6c

lindakarlovska marked this pull request as ready for review June 29, 2020 14:18

petrasovaa requested changes Jun 30, 2020

View reviewed changes

wxGUI/datacatalog: Tested and edited message formatting and other min…

feafc73

…or things.

petrasovaa reviewed Jun 30, 2020

View reviewed changes

wxGUI/Datacatalog: Messages formatted.

3feca0a

petrasovaa reviewed Jun 30, 2020

View reviewed changes

Flake8 corrected.

e2e093c

wenzeslaus added this to In progress in New GUI Startup via automation Jul 1, 2020

petrasovaa approved these changes Jul 1, 2020

View reviewed changes

petrasovaa merged commit eac40fa into OSGeo:master Jul 1, 2020

New GUI Startup automation moved this from In progress to Done Jul 1, 2020

wenzeslaus mentioned this pull request Jul 4, 2020

init: Start in last used mapset with --gui like --text #767

Merged

7 tasks

neteler added this to the 8.0.0 milestone Dec 9, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

wxGUI: Add new mapset action to data catalog #731

wxGUI: Add new mapset action to data catalog #731

lindakarlovska commented Jun 23, 2020 •

edited

Loading

petrasovaa left a comment

petrasovaa Jun 24, 2020

petrasovaa Jun 24, 2020

petrasovaa Jun 24, 2020

petrasovaa Jun 24, 2020

petrasovaa Jun 24, 2020 •

edited

Loading

petrasovaa Jun 24, 2020

lindakarlovska commented Jun 25, 2020 •

edited

Loading

petrasovaa Jun 25, 2020 •

edited

Loading

lindakarlovska Jun 27, 2020

petrasovaa Jun 25, 2020

lindakarlovska Jun 27, 2020

petrasovaa Jun 27, 2020

petrasovaa Jun 27, 2020

petrasovaa Jun 27, 2020

lindakarlovska Jun 28, 2020 •

edited

Loading

petrasovaa Jun 28, 2020

petrasovaa Jun 27, 2020

petrasovaa Jun 27, 2020

petrasovaa Jun 28, 2020

petrasovaa Jun 28, 2020

petrasovaa Jun 28, 2020

petrasovaa left a comment

petrasovaa Jun 30, 2020 •

edited

Loading

petrasovaa Jun 30, 2020

wxGUI: Add new mapset action to data catalog #731

wxGUI: Add new mapset action to data catalog #731

Conversation

lindakarlovska commented Jun 23, 2020 • edited Loading

petrasovaa left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

petrasovaa Jun 24, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lindakarlovska commented Jun 25, 2020 • edited Loading

petrasovaa Jun 25, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lindakarlovska Jun 28, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

petrasovaa left a comment

Choose a reason for hiding this comment

petrasovaa Jun 30, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lindakarlovska commented Jun 23, 2020 •

edited

Loading

petrasovaa Jun 24, 2020 •

edited

Loading

lindakarlovska commented Jun 25, 2020 •

edited

Loading

petrasovaa Jun 25, 2020 •

edited

Loading

lindakarlovska Jun 28, 2020 •

edited

Loading

petrasovaa Jun 30, 2020 •

edited

Loading