Merge branch 'main' into prompt-toolkit

Author: tleonhardt

CHANGELOG.md

@@ -75,6 +75,10 @@ time reading the [rich documentation](https://rich.readthedocs.io/).
         - `_set_parser_prog` renamed to `set_parser_prog` (without the leading underscore) and moved
           to `argparse_custom` module
     - Renamed history `--output_file` to `--output-file` to follow common command-line practices
+    - `cmd2.Cmd.ppretty` method removed - `rich` has more and better options for pretty printing,
+      see the
+      [pretty_print.py](https://github.com/python-cmd2/cmd2/blob/main/examples/pretty_print.py)
+      example for a demonstration of pretty-printing JSON data
 
 - Enhancements
     - Enhanced all print methods (`poutput()`, `perror()`, `ppaged()`, etc.) to natively render

docs/features/settings.md

@@ -19,13 +19,14 @@ Output generated by `cmd2` programs may contain ANSI escape sequences which inst
 apply colors or text styling (i.e. bold) to the output. The `allow_style` setting controls the
 behavior of these escape sequences in output generated with any of the following methods:
 
-- **`cmd2.Cmd.poutput`**
 - **`cmd2.Cmd.perror`**
-- **`cmd2.Cmd.pwarning`**
 - **`cmd2.Cmd.pexcept`**
 - **`cmd2.Cmd.pfeedback`**
+- **`cmd2.Cmd.poutput`**
 - **`cmd2.Cmd.ppaged`**
-- **`cmd2.Cmd.ppretty`**
+- **`cmd2.Cmd.print_to`**
+- **`cmd2.Cmd.psuccess`**
+- **`cmd2.Cmd.pwarning`**
 
 This setting can be one of three values:
 

examples/README.md

@@ -69,8 +69,8 @@ each:
 - [persistent_history.py](https://github.com/python-cmd2/cmd2/blob/main/examples/persistent_history.py)
     - Shows how to enable persistent history in your `cmd2` application
 - [pretty_print.py](https://github.com/python-cmd2/cmd2/blob/main/examples/pretty_print.py)
-    - Demonstrates use of cmd2.Cmd.ppretty() for pretty-printing arbitrary Python data structures
-      like dictionaries.
+    - Demonstrates use of rich within cmd2 for pretty-printing arbitrary Python data structures like
+      dictionaries.
 - [python_scripting.py](https://github.com/python-cmd2/cmd2/blob/main/examples/python_scripting.py)
     - Shows how cmd2's built-in `run_pyscript` command can provide advanced Python scripting of cmd2
       applications

examples/pretty_print.py

@@ -1,9 +1,11 @@
 #!/usr/bin/env python3
-"""A simple example demonstrating use of cmd2.Cmd.ppretty()."""
+"""A simple example demonstrating how to pretty print JSON data in a cmd2 app using rich."""
+
+from rich.json import JSON
 
 import cmd2
 
-data = {
+EXAMPLE_DATA = {
     "name": "John Doe",
     "age": 30,
     "address": {"street": "123 Main St", "city": "Anytown", "state": "CA"},
@@ -14,14 +16,27 @@
 class Cmd2App(cmd2.Cmd):
     def __init__(self) -> None:
         super().__init__()
+        self.data = EXAMPLE_DATA
 
     def do_normal(self, _) -> None:
         """Display the data using the normal poutput method."""
-        self.poutput(data)
+        self.poutput(self.data)
 
     def do_pretty(self, _) -> None:
-        """Display the data using the ppretty method."""
-        self.ppretty(data)
+        """Display the JSON data in a pretty way using rich."""
+
+        json_renderable = JSON.from_data(
+            self.data,
+            indent=2,
+            highlight=True,
+            skip_keys=False,
+            ensure_ascii=False,
+            check_circular=True,
+            allow_nan=True,
+            default=None,
+            sort_keys=False,
+        )
+        self.poutput(json_renderable)
 
 
 if __name__ == '__main__':