A IPython debugging console for Plover.
Project description
plover-debugging-console
A IPython debugging console for Plover.
See also:
plover-run-py
plugin for executing a Python command with a stroke, or from the command-line.
Usage
- Install the plugin.
- Enable the extension plugin in Plover.
- Run the command
plover-debugging-console-connect
(orplover -s plover-debugging-console-connect
) in a terminal.
The global variable engine
is given. Other objects can be accessed from engine
as public
or private members.
Alternatively, plover-debugging-console-connect qtconsole
can be used to launch a console-style application using Qt.
See documentation of jupyter qtconsole
for more details.
Or plover-debugging-console-execute
can be used to execute a file non-interactively. See note below.
Known issues
Those errors can be fixed by installing the latest version of background_zmq_ipython
manually on GitHub. Refer to
https://github.com/openstenoproject/plover/wiki/Manually-Installing-Plugins for instruction.
- https://github.com/albertz/background-zmq-ipython/issues/13
- https://github.com/user202729/plover-debugging-console/issues/1#issuecomment-1003654835
Note
-
Once started, the kernel is not stopped until Plover exits.
-
The session (kernel, global variables) are persistent, and shared between consoles.
However,
plover-debugging-console-execute <file>
uses a separate environment, see documentation of%run
IPython magic command. -
Any
print
commands are printed on Plover's console, not IPython's console. -
Error messages might be hidden (if
plover-debugging-console-execute
is used), or displayed in a different console.To view the error messages, open an interactive console.
-
On some operating systems, the plugin may set
PAGER
environment variable. (see issue #2 ofplover-run-shell
repository)
Implementation details
- The kernel can be connected to manually with
ipython console --existing <file>
orjupyter console --existing <file>
. - The IPython/Jupyter connection file path is stored in
connection_path_container
, which isplover_debugging_console_path
in the temp folder in the current version. background_zmq_ipython
package is used, which requiresjupyter
- Regarding
PAGER
,GIT_PAGER
,TERM
,CLICOLOR
environment variables being set: Either- unset/reset them manually, or
- update to a sufficiently new version of package
background-zmq-ipython
, at least commit 14d862848b7f5692412093642181718c29f57cad. (version currently not on PyPI)
- See https://stackoverflow.com/a/68769973/5267751 for the method used in
plover-debugging-console-execute
.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for plover-debugging-console-0.2.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 51059182389e49b1b3854a453961af959332b9287189ef457b4c05cd6dcbe7f2 |
|
MD5 | 7554aa48ee0399dffc25e50b8d3c6913 |
|
BLAKE2b-256 | 2c53c04a6a221772a022c4e7d9cc450a01c7cbabe58208ada002fa838c394403 |
Hashes for plover_debugging_console-0.2.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8516eaa5adb0363cdbf695334fa5e8023a7610f45b4828c3413bd7f329985a20 |
|
MD5 | d698cdf2840da06ea4e6e8928a41335f |
|
BLAKE2b-256 | cdfa204ca818a3d5348a2d87e197dacaf974acf61c89cb604e33c509fcf3bbe3 |