Add plugin entry points and plugin dependency sorting

Author: goanpeca

NOTICE.txt

@@ -1090,6 +1090,59 @@ Files covered:
 spyder/plugins/onlinehelp/pydoc_patch.py
 
 
+-------------------------------------------------------------------------------
+
+
+
+toposort 1.5
+------------
+
+
+Copyright 2014 True Blade Systems, Inc.
+
+
+Author: Eric V. Smith | eric@trueblade.com | https://bitbucket.org/ericvsmith
+Site: https://pypi.org/project/toposort/
+Source: https://bitbucket.org/ericvsmith/toposort/src
+License: Apache License 2.0 | https://www.apache.org/licenses/LICENSE-2.0
+
+No modifications made.
+
+
+Copyright 2014 True Blade Systems, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+
+Use the core functionlity to sort plugin dependencies.
+
+
+See below for the full text of the Apache License, Version 2.0
+
+The current toposort license can be viewed at:
+https://bitbucket.org/ericvsmith/toposort/src/default/LICENSE.txt
+
+The current version of the original files can be viewed at:
+https://bitbucket.org/ericvsmith/toposort/src/default/toposort.py
+
+
+Files covered:
+
+spyder/utils/external/toposort/__init__.py
+spyder/utils/external/toposort/toposort.py
+spyder/utils/external/toposort/LICENSE.txt
+
+
 ===============================================================================
 
 

setup.py

@@ -21,47 +21,52 @@
 
 from __future__ import print_function
 
+# Standard library imports
+from distutils.command.install_data import install_data
 import io
 import os
 import os.path as osp
 import subprocess
 import sys
 import shutil
 
-from distutils.core import setup
-from distutils.command.install_data import install_data
+# Third party imports
+from setuptools import setup, find_packages
+from setuptools.command.install import install
 
 
-#==============================================================================
+# =============================================================================
 # Check for Python 3
-#==============================================================================
+# =============================================================================
 PY3 = sys.version_info[0] == 3
 
 
-#==============================================================================
+# =============================================================================
 # Minimal Python version sanity check
 # Taken from the notebook setup.py -- Modified BSD License
-#==============================================================================
+# =============================================================================
 v = sys.version_info
 if v[0] >= 3 and v[:2] < (3, 6):
     error = "ERROR: Spyder 5 requires Python version 3.6 or above."
     print(error, file=sys.stderr)
     sys.exit(1)
 
 
-#==============================================================================
+# =============================================================================
 # Constants
-#==============================================================================
+# =============================================================================
 NAME = 'spyder'
 LIBNAME = 'spyder'
 from spyder import __version__, __website_url__  #analysis:ignore
 
 
-#==============================================================================
+# =============================================================================
 # Auxiliary functions
-#==============================================================================
+# =============================================================================
 def get_package_data(name, extlist):
-    """Return data files for package *name* with extensions in *extlist*"""
+    """
+    Return data files for package *name* with extensions in *extlist*.
+    """
     flist = []
     # Workaround to replace os.path.relpath (not available until Python 2.6):
     offset = len(name)+len(os.pathsep)
@@ -75,17 +80,22 @@ def get_package_data(name, extlist):
 
 
 def get_subpackages(name):
-    """Return subpackages of package *name*"""
+    """
+    Return subpackages of package *name*.
+    """
     splist = []
     for dirpath, _dirnames, _filenames in os.walk(name):
         if 'tests' not in dirpath:
             if osp.isfile(osp.join(dirpath, '__init__.py')):
                 splist.append(".".join(dirpath.split(os.sep)))
+
     return splist
 
 
 def get_data_files():
-    """Return data_files in a platform dependent manner"""
+    """
+    Return data_files in a platform dependent manner.
+    """
     if sys.platform.startswith('linux'):
         if PY3:
             data_files = [('share/applications', ['scripts/spyder3.desktop']),
@@ -99,19 +109,23 @@ def get_data_files():
                                    'img_src/spyder_reset.ico'])]
     else:
         data_files = []
+
     return data_files
 
 
 def get_packages():
-    """Return package list"""
+    """
+    Return package list.
+    """
     packages = get_subpackages(LIBNAME)
     return packages
 
 
-#==============================================================================
-# Make Linux detect Spyder desktop file
-#==============================================================================
-class MyInstallData(install_data):
+# =============================================================================
+# Make Linux detect Spyder desktop file (will not work with wheels)
+# =============================================================================
+class CustomInstallData(install_data):
+
     def run(self):
         install_data.run(self)
         if sys.platform.startswith('linux'):
@@ -120,12 +134,14 @@ def run(self):
             except:
                 print("ERROR: unable to update desktop database",
                       file=sys.stderr)
-CMDCLASS = {'install_data': MyInstallData}
 
 
-#==============================================================================
+CMDCLASS = {'install_data': CustomInstallData}
+
+
+# =============================================================================
 # Main scripts
-#==============================================================================
+# =============================================================================
 # NOTE: the '[...]_win_post_install.py' script is installed even on non-Windows
 # platforms due to a bug in pip installation process
 # See spyder-ide/spyder#1158.
@@ -139,17 +155,18 @@ def run(self):
 if os.name == 'nt':
     SCRIPTS += ['spyder.bat']
 
-#==============================================================================
+
+# =============================================================================
 # Files added to the package
-#==============================================================================
+# =============================================================================
 EXTLIST = ['.pot', '.po', '.mo', '.svg', '.png', '.css', '.html', '.js',
            '.ini', '.txt', '.qss', '.ttf', '.json', '.rst', '.bloom',
            '.ico', '.gif', '.mp3', '.ogg', '.sfd', '.bat', '.sh']
 
 
-#==============================================================================
+# =============================================================================
 # Use Readme for long description
-#==============================================================================
+# =============================================================================
 with io.open('README.md', encoding='utf-8') as f:
     LONG_DESCRIPTION = f.read()
 
@@ -165,7 +182,7 @@ def run(self):
     long_description_content_type='text/markdown',
     download_url=__website_url__ + "#fh5co-download",
     author="The Spyder Project Contributors",
-    author_email="spyderlib@googlegroups.com",
+    author_email="info@spyder-ide.org",
     url=__website_url__,
     license='MIT',
     keywords='PyQt5 editor console widgets IDE science data analysis IPython',
@@ -174,32 +191,26 @@ def run(self):
     package_data={LIBNAME: get_package_data(LIBNAME, EXTLIST)},
     scripts=[osp.join('scripts', fname) for fname in SCRIPTS],
     data_files=get_data_files(),
-    classifiers=['License :: OSI Approved :: MIT License',
-                 'Operating System :: MacOS',
-                 'Operating System :: Microsoft :: Windows',
-                 'Operating System :: POSIX :: Linux',
-                 'Programming Language :: Python :: 2',
-                 'Programming Language :: Python :: 2.7',
-                 'Programming Language :: Python :: 3',
-                 'Programming Language :: Python :: 3.4',
-                 'Programming Language :: Python :: 3.5',
-                 'Programming Language :: Python :: 3.6',
-                 'Programming Language :: Python :: 3.7',
-                 'Development Status :: 5 - Production/Stable',
-                 'Intended Audience :: Education',
-                 'Intended Audience :: Science/Research',
-                 'Intended Audience :: Developers',
-                 'Topic :: Scientific/Engineering',
-                 'Topic :: Software Development :: Widget Sets'],
-    cmdclass=CMDCLASS)
+    classifiers=[
+        'License :: OSI Approved :: MIT License',
+        'Operating System :: MacOS',
+        'Operating System :: Microsoft :: Windows',
+        'Operating System :: POSIX :: Linux',
+        'Programming Language :: Python :: 3',
+        'Programming Language :: Python :: 3.6',
+        'Programming Language :: Python :: 3.7',
+        'Programming Language :: Python :: 3.8',
+        'Development Status :: 5 - Production/Stable',
+        'Intended Audience :: Education',
+        'Intended Audience :: Science/Research',
+        'Intended Audience :: Developers',
+        'Topic :: Scientific/Engineering',
+        'Topic :: Software Development :: Widget Sets',
+    ],
+    cmdclass=CMDCLASS,
+)
 
 
-#==============================================================================
-# Setuptools deps
-#==============================================================================
-if any(arg == 'bdist_wheel' for arg in sys.argv):
-    import setuptools     # analysis:ignore
-
 install_requires = [
     'applaunchservices>=0.1.7;platform_system=="Darwin"',
     'atomicwrites>=1.2.0',
@@ -264,21 +275,49 @@ def run(self):
     ],
 }
 
-if 'setuptools' in sys.modules:
-    setup_args['install_requires'] = install_requires
-    setup_args['extras_require'] = extras_require
 
-    setup_args['entry_points'] = {
-        'gui_scripts': [
-            '{} = spyder.app.start:main'.format(
-                'spyder3' if PY3 else 'spyder')
-        ]
-    }
+spyder_plugins_entry_points = [
+    'appearance = spyder.plugins.appearance.plugin:Appearance',
+    'breakpoints = spyder.plugins.breakpoints.plugin:Breakpoints',
+    'code_completion = spyder.plugins.completions.plugin:CodeCompletion',
+    'core = spyder.plugins.core.plugin:Core',
+    'editor = spyder.plugins.editor.plugin:Editor',
+    'explorer = spyder.plugins.explorer.plugin:Explorer',
+    'fallback_completion = spyder.plugins.fallback.plugin:FallbackCompletion',
+    'findinfiles = spyder.plugins.findinfiles.plugin:FindInFiles',
+    'help = spyder.plugins.help.plugin:Help',
+    'history = spyder.plugins.history.plugin:HistoryLog',
+    'ipythonconsole = spyder.plugins.ipythonconsole.plugin:IPythonConsole',
+    'kite_completion = spyder.plugins.kite.plugin:LanguageServerCompletion',
+    'onlinehelp = spyder.plugins.onlinehelp.plugin:OnlineHelp',
+    'outlineexplorer = spyder.plugins.outlineexplorer.plugin:OutlineExplorer',
+    'plots = spyder.plugins.plots.plugin:Plots',
+    'profiler = spyder.plugins.profiler.plugin:Profiler',
+    'projects = spyder.plugins.projects.plugin:Projects',
+    'pylint = spyder.plugins.pylint.plugin:Pylint',
+    ('lsp_completion = spyder.plugins.languageserver.plugin:'
+     'LanguageServerCompletion'),
+    'python = spyder.plugins.python.plugin:Python',
+    ('variableexplorer = spyder.plugins.variableexplorer.plugin:'
+     'VariableExplorer'),
+    ('workingdirectory = spyder.plugins.workingdirectory.plugin:'
+     'WorkingDirectory'),
+]
+
 
-    setup_args.pop('scripts', None)
+setup_args['install_requires'] = install_requires
+setup_args['extras_require'] = extras_require
+setup_args['entry_points'] = {
+    'gui_scripts': [
+        '{} = spyder.app.start:main'.format(
+            'spyder3' if PY3 else 'spyder')
+    ],
+    'spyder.plugins': spyder_plugins_entry_points,
+}
+setup_args.pop('scripts', None)
 
 
-#==============================================================================
+# =============================================================================
 # Main setup
-#==============================================================================
+# =============================================================================
 setup(**setup_args)

spyder/api/plugins.py

@@ -1411,7 +1411,7 @@ def add_application_status_widget(self, name, widget):
         # TODO: Check widget class
         # TODO: Check existence
         status_bar = self._main.statusBar()
-        status_bar.addWidget(widget)
+        status_bar.insertPermanentWidget(0, widget)
         self._main._STATUS_WIDGETS[name] = widget
 
     def get_application_status_widget(self, name):

spyder/app/mainwindow.py

@@ -199,10 +199,11 @@
                                     MENU_SEPARATOR, set_menu_icons)
 from spyder.otherplugins import get_spyderplugins_mods
 from spyder.app import tour
+from spyder.app.solver import find_external_plugins, solve_plugin_dependencies
 
 # Spyder API Imports
 from spyder.api.exceptions import SpyderAPIError
-from spyder.api.plugins import Plugins, SpyderDockablePlugin
+from spyder.api.plugins import Plugins, SpyderPluginV2, SpyderDockablePlugin
 
 #==============================================================================
 # Third-party library imports
@@ -1132,6 +1133,8 @@ def create_edit_action(text, tr_text, icon):
         self.console.set_exit_function(self.closing)
         self.register_plugin(self.console)
 
+        # TODO: Load and register the rest of the plugins using new API
+
         # Code completion client initialization
         self.set_splash(_("Starting code completion manager..."))
         from spyder.plugins.completion.plugin import CompletionManager
@@ -1308,6 +1311,21 @@ def create_edit_action(text, tr_text, icon):
                 print("%s: %s" % (mod, str(error)), file=STDERR)
                 traceback.print_exc(file=STDERR)
 
+        # New API: Load and register external plugins
+        external_plugins = find_external_plugins()
+        plugin_deps = solve_plugin_dependencies(external_plugins.values())
+        for plugin_class in plugin_deps:
+            if issubclass(plugin_class, SpyderPluginV2):
+                try:
+                    plugin_instance = plugin_class(
+                        self,
+                        configuration=CONF,
+                    )
+                    self.register_plugin(plugin_instance)
+                except Exception as error:
+                    print("%s: %s" % (plugin_class, str(error)), file=STDERR)
+                    traceback.print_exc(file=STDERR)
+
         self.set_splash(_("Setting up main window..."))
 
         # Help menu