fix #113, fix #114 and fix #117 (updated items in Help menu)

* fix #113 : added larray_editor version to report issue template
* fix #114 : pytables version is detected properly by get_versions
* fix #117 : report issue on either editor, larray or larray_eurostat project

Author: alixdamman

larray_editor/editor.py

@@ -289,7 +289,13 @@ def setup_menu_bar(self):
         help_menu.addAction(create_action(self, _('Online Objects and Functions (API) &Reference'),
                                           triggered=self.open_api_documentation))
         help_menu.addSeparator()
-        help_menu.addAction(create_action(self, _('Report &Issue...'), triggered=self.report_issue))
+        report_issue_menu = help_menu.addMenu("Report &Issue...")
+        report_issue_menu.addAction(create_action(self, _('Report &Editor Issue...'),
+                                                  triggered=self.report_issue('editor')))
+        report_issue_menu.addAction(create_action(self, _('Report &LArray Issue...'),
+                                                  triggered=self.report_issue('larray')))
+        report_issue_menu.addAction(create_action(self, _('Report &LArray Eurostat Issue...'),
+                                                  triggered=self.report_issue('larray_eurostat')))
         help_menu.addAction(create_action(self, _('&Users Discussion...'), triggered=self.open_users_group))
         help_menu.addAction(create_action(self, _('New Releases And &Announces Mailing List...'),
                                           triggered=self.open_announce_group))
@@ -680,14 +686,15 @@ def open_tutorial(self):
     def open_api_documentation(self):
         QDesktopServices.openUrl(QUrl(urls['doc_api']))
 
-    def report_issue(self):
-        if PY2:
-            from urllib import quote
-        else:
-            from urllib.parse import quote
+    def report_issue(self, package):
+        def _report_issue(*args, **kwargs):
+            if PY2:
+                from urllib import quote
+            else:
+                from urllib.parse import quote
 
-        versions = get_versions()
-        issue_template = """\
+            versions = get_versions(package)
+            issue_template = """\
 ## Description
 **What steps will reproduce the problem?**
 1. 
@@ -702,21 +709,23 @@ def report_issue(self):
 
 ## Version and main components
 * Python {python} on {system} {bitness:d}bits
-* Qt {qt}, {qt_api} {qt_api_ver}
 """
-        for dep in dependencies:
-            issue_template += "* {dep} {{{dep}}}\n".format(dep=dep)
-        issue_template = issue_template.format(**versions)
-
-        url = QUrl(urls['new_issue'])
-        if PYQT5:
-            from qtpy.QtCore import QUrlQuery
-            query = QUrlQuery()
-            query.addQueryItem("body", quote(issue_template))
-            url.setQuery(query)
-        else:
-            url.addEncodedQueryItem("body", quote(issue_template))
-        QDesktopServices.openUrl(url)
+            issue_template += "* {package} {{{package}}}\n".format(package=package)
+            for dep in dependencies[package]:
+                issue_template += "* {dep} {{{dep}}}\n".format(dep=dep)
+            issue_template = issue_template.format(**versions)
+
+            url = QUrl(urls['new_issue_{}'.format(package)])
+            if PYQT5:
+                from qtpy.QtCore import QUrlQuery
+                query = QUrlQuery()
+                query.addQueryItem("body", quote(issue_template))
+                url.setQuery(query)
+            else:
+                url.addEncodedQueryItem("body", quote(issue_template))
+            QDesktopServices.openUrl(url)
+
+        return _report_issue
 
     def open_users_group(self):
         QDesktopServices.openUrl(QUrl(urls['users_group']))
@@ -726,7 +735,7 @@ def open_announce_group(self):
 
     def about(self):
         """About Editor"""
-        kwargs = get_versions()
+        kwargs = get_versions('editor')
         kwargs.update(urls)
         message = """\
 <b>LArray Editor {editor}</b>: The Graphical User Interface for LArray. 
@@ -735,9 +744,8 @@ def about(self):
 <p><b>Versions of underlying libraries</b>:
 <ul>
 <li>Python {python} on {system} {bitness:d}bits</li>
-<li>Qt {qt}, {qt_api} {qt_api_ver}</li>
 """
-        for dep in dependencies:
+        for dep in dependencies['editor']:
             if kwargs[dep] != 'N/A':
                 message += "<li>{dep} {{{dep}}}</li>\n".format(dep=dep)
         message += "</ul>"

larray_editor/utils.py

@@ -17,15 +17,20 @@
     from matplotlib.backends.backend_qt4agg import NavigationToolbar2QT as NavigationToolbar
 
 
-dependencies = ['numpy', 'pandas', 'matplotlib', 'larray', 'larray_eurostat', 'pytables', 'xlwings', 'xlsxwriter',
-                'xlrd', 'openpyxl']
+core_dependencies = ['numpy', 'pandas', 'matplotlib', 'pytables', 'xlwings', 'xlsxwriter', 'xlrd', 'openpyxl']
+editor_dependencies = ['larray', 'larray_eurostat', 'qt'] + core_dependencies
+eurostat_dependencies = ['larray']
+dependencies = {'editor': editor_dependencies, 'larray': core_dependencies, 'larray_eurostat': eurostat_dependencies}
+
 
 urls = {"fpb": "http://www.plan.be/index.php?lang=en",
         "GPL3": "https://www.gnu.org/licenses/gpl-3.0.html",
         "doc_stable": "http://larray.readthedocs.io/en/stable/",
         "doc_tutorial": "http://larray.readthedocs.io/en/stable/tutorial.html",
         "doc_api": "http://larray.readthedocs.io/en/stable/api.html",
-        "new_issue": "https://github.com/liam2/larray/issues/new",
+        "new_issue_editor": "https://github.com/larray-project/larray-editor/issues/new",
+        "new_issue_larray": "https://github.com/liam2/larray/issues/new",
+        "new_issue_larray_eurostat": "https://github.com/larray-project/larray_eurostat/issues/new",
         "announce_group": "https://groups.google.com/d/forum/larray-announce",
         "users_group": "https://groups.google.com/d/forum/larray-users"}
 
@@ -37,44 +42,39 @@ def commonpath(paths):
     commonpath = os.path.commonpath
 
 
-def get_package_version(package_name):
-    """Return the version of a package if installed, N/A otherwise"""
+def get_module_version(module_name):
+    """Return the version of a module if installed, N/A otherwise"""
     try:
         from importlib import import_module
-        package = import_module(package_name)
-        if '__version__' in dir(package):
-            return package.__version__
-        elif '__VERSION__' in dir(package):
-            return package.__VERSION__
+        module = import_module(module_name)
+        if 'qtpy' in module_name:
+            from qtpy import API_NAME, PYQT_VERSION  # API_NAME --> PyQt5 or PyQt4
+            qt_version = module.__version__
+            return '{}, {} {}'.format(qt_version, API_NAME, PYQT_VERSION)
+        elif '__version__' in dir(module):
+            return module.__version__
+        elif '__VERSION__' in dir(module):
+            return module.__VERSION__
         else:
             return 'N/A'
     except ImportError:
         return 'N/A'
 
 
-def get_versions():
-    """Get version information for components used by the Editor"""
+def get_versions(package):
+    """Get version information of dependencies of a package"""
     import platform
-    from qtpy import API_NAME, PYQT_VERSION
-    from qtpy.QtCore import __version__ as qtpy_version
-    from larray_editor import __version__ as editor_version
+    modules = {'editor': 'larray_editor', 'qt': 'qtpy.QtCore', 'pytables': 'tables'}
 
     versions = {
-        'editor': editor_version,
+        'system': platform.system() if sys.platform != 'darwin' else 'Darwin',
         'python': platform.python_version(),
         'bitness': 64 if sys.maxsize > 2**32 else 32,
-        'qt': qtpy_version,
-        'qt_api': API_NAME,                             # PyQt5 or PyQt4
-        'qt_api_ver': PYQT_VERSION,
     }
 
-    if not sys.platform == 'darwin':                    # To avoid a crash with our Mac app
-        versions['system'] = platform.system()          # Linux, Windows, ...
-    else:
-        versions['system'] = 'Darwin'
-
-    for dep in dependencies:
-        versions[dep] = get_package_version(dep)
+    versions[package] = get_module_version(modules.get(package, package))
+    for dep in dependencies[package]:
+        versions[dep] = get_module_version(modules.get(dep, dep))
 
     return versions