Fix bug when using ipy with gnureadline and Python 3.13 (#1358)

* Fix bug when using ipy with gnureadline and Python 3.13 * Fix mypy error with IPython stuff * Fix mypy errors when importing stuff from IPython * Updated CHANGELOG with info on bug fix * Added invoke task for cleaning ruff cache directory * Added ruff cache clean invoke task to plugins * Use the "ruff clean" command to clear all ruff cache dirs * Made cmd2/parsing.py non-executable and examples executable
python-cmd2 · Nov 2, 2024 · 153c308 · 153c308
1 parent 285d959
commit 153c308
Show file tree

Hide file tree

Showing 12 changed files with 30 additions and 5 deletions.
diff --git a/.github/workflows/mypy.yml b/.github/workflows/mypy.yml
@@ -11,8 +11,8 @@ jobs:
   mypy:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4  # https://github.com/actions/checkout
-      - uses: actions/setup-python@v5  # https://github.com/actions/setup-python
+      - uses: actions/checkout@v4 # https://github.com/actions/checkout
+      - uses: actions/setup-python@v5 # https://github.com/actions/setup-python
         with:
           python-version: 3.13
           allow-prereleases: true

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+# 2.5.1 (November TBD, 2024)
+* Bug Fixes
+  * Fixed readline bug when using `ipy` command with `gnureadline` and Python 3.13
+
 ## 2.5.0 (October 23, 2024)
 * Breaking Change
   * `cmd2` 2.5 supports Python 3.8+ (removed support for Python 3.6 and 3.7)

diff --git a/cmd2/cmd2.py b/cmd2/cmd2.py
@@ -128,6 +128,13 @@
     StatementParser,
     shlex_split,
 )
+
+# NOTE: When using gnureadline with Python 3.13, start_ipython needs to be imported before any readline-related stuff
+try:
+    from IPython import start_ipython  # type: ignore[import]
+except ImportError:
+    pass
+
 from .rl_utils import (
     RlType,
     rl_escape_prompt,
@@ -4629,9 +4636,13 @@ def do_ipy(self, _: argparse.Namespace) -> Optional[bool]:  # pragma: no cover
         # Detect whether IPython is installed
         try:
             import traitlets.config.loader as TraitletsLoader  # type: ignore[import]
-            from IPython import (  # type: ignore[import]
-                start_ipython,
-            )
+
+            # Allow users to install ipython from a cmd2 prompt when needed and still have ipy command work
+            try:
+                start_ipython  # noqa F823
+            except NameError:
+                from IPython import start_ipython  # type: ignore[import]
+
             from IPython.terminal.interactiveshell import (  # type: ignore[import]
                 TerminalInteractiveShell,
             )

diff --git a/cmd2/parsing.py b/cmd2/parsing.py
diff --git a/examples/argparse_completion.py b/examples/argparse_completion.py
diff --git a/examples/default_categories.py b/examples/default_categories.py
diff --git a/examples/modular_commands_basic.py b/examples/modular_commands_basic.py
diff --git a/examples/modular_commands_dynamic.py b/examples/modular_commands_dynamic.py
diff --git a/examples/modular_commands_main.py b/examples/modular_commands_main.py
diff --git a/examples/modular_subcommands.py b/examples/modular_subcommands.py
diff --git a/examples/read_input.py b/examples/read_input.py
diff --git a/tasks.py b/tasks.py
@@ -365,3 +365,13 @@ def format(context):
 
 
 namespace.add_task(format)
+
+
+@invoke.task()
+def ruff_clean(context):
+    """Remove .ruff_cache directory"""
+    with context.cd(TASK_ROOT_STR):
+        context.run("ruff clean")
+
+
+namespace_clean.add_task(ruff_clean, 'ruff')