CLN: renames for clarity

* use uppercase for constants
* ...

Author: gdementen

larray_editor/editor.py

@@ -32,8 +32,8 @@
 import larray as la
 
 from larray_editor.traceback_tools import StackSummary
-from larray_editor.utils import (_, create_action, show_figure, ima, commonpath, dependencies,
-                                 get_versions, get_documentation_url, urls, RecentlyUsedList)
+from larray_editor.utils import (_, create_action, show_figure, ima, commonpath, DEPENDENCIES,
+                                 get_versions, get_documentation_url, URLS, RecentlyUsedList)
 from larray_editor.arraywidget import ArrayEditorWidget
 from larray_editor.commands import EditSessionArrayCommand, EditCurrentArrayCommand
 
@@ -236,11 +236,11 @@ def _report_issue(*args, **kwargs):
 * Python {python} on {system} {bitness:d}bits
 """
             issue_template += f"* {package} {{{package}}}\n"
-            for dep in dependencies[package]:
+            for dep in DEPENDENCIES[package]:
                 issue_template += f"* {dep} {{{dep}}}\n"
             issue_template = issue_template.format(**versions)
 
-            url = QUrl(urls[f'new_issue_{package}'])
+            url = QUrl(URLS[f'new_issue_{package}'])
             from qtpy.QtCore import QUrlQuery
             query = QUrlQuery()
             query.addQueryItem("body", quote(issue_template))
@@ -250,15 +250,15 @@ def _report_issue(*args, **kwargs):
         return _report_issue
 
     def open_users_group(self):
-        QDesktopServices.openUrl(QUrl(urls['users_group']))
+        QDesktopServices.openUrl(QUrl(URLS['users_group']))
 
     def open_announce_group(self):
-        QDesktopServices.openUrl(QUrl(urls['announce_group']))
+        QDesktopServices.openUrl(QUrl(URLS['announce_group']))
 
     def about(self):
         """About Editor"""
         kwargs = get_versions('editor')
-        kwargs.update(urls)
+        kwargs.update(URLS)
         message = """\
 <p><b>LArray Editor</b> {editor}
 <br>The Graphical User Interface for LArray
@@ -269,7 +269,7 @@ def about(self):
 <ul>
 <li>Python {python} on {system} {bitness:d}bits</li>
 """
-        for dep in dependencies['editor']:
+        for dep in DEPENDENCIES['editor']:
             message += f"<li>{dep} {kwargs[dep]}</li>\n"
         message += "</ul>"
         QMessageBox.about(self, _("About LArray Editor"), message.format(**kwargs))

larray_editor/utils.py

@@ -32,18 +32,18 @@
 logger = logging.getLogger("editor")
 
 
-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}
+CORE_DEPENDENCIES = ['matplotlib', 'numpy', 'openpyxl', 'pandas', 'pytables', 'xlsxwriter', 'xlrd', 'xlwings']
+EDITOR_DEPENDENCIES = ['larray', 'larray_eurostat', 'qt'] + CORE_DEPENDENCIES
+EUROSTAT_DEPENDENCIES = ['larray']
+DEPENDENCIES = {'editor': EDITOR_DEPENDENCIES, 'larray': CORE_DEPENDENCIES, 'larray_eurostat': EUROSTAT_DEPENDENCIES}
 
 
-doc = "http://larray.readthedocs.io/en/{version}"
-urls = {"fpb": "http://www.plan.be/index.php?lang=en",
+DOC = "http://larray.readthedocs.io/en/{version}"
+URLS = {"fpb": "http://www.plan.be/index.php?lang=en",
         "GPL3": "https://www.gnu.org/licenses/gpl-3.0.html",
-        "doc_index": f"{doc}/index.html",
-        "doc_tutorial": f"{doc}/tutorial.html",
-        "doc_api": f"{doc}/api.html",
+        "doc_index": f"{DOC}/index.html",
+        "doc_tutorial": f"{DOC}/tutorial.html",
+        "doc_api": f"{DOC}/api.html",
         "new_issue_editor": "https://github.com/larray-project/larray-editor/issues/new",
         "new_issue_larray": "https://github.com/larray-project/larray/issues/new",
         "new_issue_larray_eurostat": "https://github.com/larray-project/larray_eurostat/issues/new",
@@ -74,19 +74,21 @@ def get_module_version(module_name):
 
 
 def get_versions(package):
-    """Get version information of dependencies of a package"""
+    """Get version information of dependencies of one of our packages
+    `package` can be one of 'editor', 'larray' or 'larray_eurostat'
+    """
     import platform
-    modules = {'editor': 'larray_editor', 'qt': 'qtpy.QtCore', 'pytables': 'tables'}
+    module_with_version = {'editor': 'larray_editor', 'qt': 'qtpy.QtCore', 'pytables': 'tables'}
 
     versions = {
         'system': platform.system() if sys.platform != 'darwin' else 'Darwin',
         'python': platform.python_version(),
         'bitness': 64 if sys.maxsize > 2**32 else 32,
     }
 
-    versions[package] = get_module_version(modules.get(package, package))
-    for dep in dependencies[package]:
-        versions[dep] = get_module_version(modules.get(dep, dep))
+    versions[package] = get_module_version(module_with_version.get(package, package))
+    for dep in DEPENDENCIES[package]:
+        versions[dep] = get_module_version(module_with_version.get(dep, dep))
 
     return versions
 
@@ -95,7 +97,7 @@ def get_documentation_url(key):
     version = get_module_version('larray')
     if version == 'N/A':
         version = 'stable'
-    return urls[key].format(version=version)
+    return URLS[key].format(version=version)
 
 
 # Note: string and unicode data types will be formatted with '%s' (see below)