PR: Generalize Run plugin to support generic inputs and executors

[andfoy]

Description of Changes

This PR will generalize the functioning of the Run plugin, and more specifically, the Run button itself, which will allow plugins to register run inputs and executors in a generic way. This will enable plugins such as spyder-terminal to run scripts and plugin designers may create other interfaces that have an executable output, examples of this, some sort of graph editor, or even the future plots panel.

This is being done as part of the tasks necessary to migrate the editor to the new API and is being tracked as part of #17468

• Wrote at least one-line docstrings (for any new functions)
• Added unit test(s) covering the changes (if testable)

• Included a screenshot or animation (if affecting the UI, see Licecap)

sequenceDiagram
    autonumber
    actor User
    participant RunInputProvider as RunInputProvider[input T];
    participant Run
    participant RunExecutorProvider as RunExecutor[exec T]
    participant RunResultViewer as RunResultViewer[display U]
    par Providers are registered on plugin initialization
          RunInputProvider->>Run: register_input_provider
    and 
          RunExecutorProvider->>Run: register_run_executor
    and
          RunResultViewer->>Run: register_run_result_viewer
    end
    par The RunInputProvider is switched for the run button each time the focus changes
          User->>RunInputProvider: on_focus
          activate User
          RunInputProvider->>Run: update_run_focus
          deactivate User
    end
    par The user clicks the run button
          User->>Run: on_click
          activate User
          Run->>RunInputProvider: get_run_input
          activate RunInputProvider    
          RunInputProvider-->>Run: input:  class RunInformation[input T, display U]
          deactivate RunInputProvider
         Run->>Run: dispatch for input T
         alt There are multiple executors for run input type T
               Run->>User: Ask for executor
               User-->>Run: executor: class RunExecutorProvider[T]
         else There is a single executor for run input type T
               Run->>Run: executor: class RunExecutorProvider[T]
         end
         Run->>+RunExecutorProvider: executor.run_input(input: class RunInformation[T, U])
         RunExecutorProvider-->>-Run: run_result: class RunResult[U]
         Run->>Run: dispatch for result display U
         Run->>RunResultViewer: display_run_result(run_result: class RunResult[U])
         RunResultViewer-->>User: Display results
         deactivate User
    end

Loading

Issue(s) Resolved

Fixes #

Affirmation

By submitting this Pull Request or typing my (user)name below,
I affirm the Developer Certificate of Origin
with respect to all commits and content included in this PR,
and understand I am releasing the same under Spyder's MIT (Expat) license.

I certify the above statement is true and correct:

[pep8speaks]

Hello @andfoy! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

• In the file spyder/plugins/editor/plugin.py:

Line 245:9: E303 too many blank lines (2)

• In the file spyder/plugins/externalconsole/plugin.py:

Line 248:34: E124 closing bracket does not match visual indentation

• In the file spyder/plugins/run/confpage.py:

Line 162:13: E128 continuation line under-indented for visual indent
Line 166:13: E128 continuation line under-indented for visual indent

• In the file spyder/plugins/run/container.py:

Line 192:5: E303 too many blank lines (2)
Line 223:31: E222 multiple spaces after operator
Line 490:9: E731 do not assign a lambda expression, use a def

• In the file spyder/plugins/run/models.py:

Line 327:80: E501 line too long (83 > 79 characters)

• In the file spyder/plugins/run/tests/test_run.py:

Line 311:80: E501 line too long (80 > 79 characters)
Line 316:1: E302 expected 2 blank lines, found 1

Comment last updated at 2022-07-14 00:18:24 UTC

[ccordoba12]

I think this is ready, so let's merge it. It still requires more work but that can be done in follow up PRs.

[ccordoba12]

Thanks @andfoy and @steff456 for your work on this.