🔀 Merge pull request #7 from davep/cli

Add support for passing plot parameters on the command line

Author: davep

ChangeLog.md

@@ -1,5 +1,22 @@
 # Complexitty ChangeLog
 
+## Unreleased
+
+**Released: WiP**
+
+- Added `--colour-map` as a command line switch.
+  ([#7](https://github.com/davep/complexitty/pull/7))
+- Added `--max-iteration` as a command line switch.
+  ([#7](https://github.com/davep/complexitty/pull/7))
+- Added `--multibrot` as a command line switch.
+  ([#7](https://github.com/davep/complexitty/pull/7))
+- Added `--x-position` as a command line switch.
+  ([#7](https://github.com/davep/complexitty/pull/7))
+- Added `--y-position` as a command line switch.
+  ([#7](https://github.com/davep/complexitty/pull/7))
+- Added `--zoom` as a command line switch.
+  ([#7](https://github.com/davep/complexitty/pull/7))
+
 ## v0.1.1
 
 **Released: 2025-04-19**

docs/screenshots/basic_app.py

@@ -2,6 +2,16 @@
 
 from complexitty.complexitty import Complexitty
 
-app = Complexitty(Namespace(theme="textual-dark"))
+app = Complexitty(
+    Namespace(
+        colour_map=None,
+        max_iteration=None,
+        multibrot=None,
+        theme="textual-dark",
+        x_position=None,
+        y_position=None,
+        zoom=None,
+    )
+)
 if __name__ == "__main__":
     app.run()

docs/source/index.md

@@ -51,7 +51,7 @@ command.
 
 ### Command line options
 
-Complexity has a number of command line options; they include:
+Complexitty has a number of command line options; they include:
 
 #### `-b`, `--bindings`
 
@@ -65,6 +65,10 @@ complexitty --bindings
 complexitty --bindings
 ```
 
+#### `-c`, `--colour-map`, `--color-map`
+
+Set the colour map to use in the plot.
+
 #### `-h`, `--help`
 
 Prints the help for the `complexitty` command.
@@ -76,6 +80,10 @@ complexitty --help
 complexitty --help
 ```
 
+#### `-i`, `--max-iteration`
+
+Set the maximum number of iterations for the plot's calculation.
+
 #### `--license`, `--licence`
 
 Prints a summary of [Complexitty's license](license.md).
@@ -87,6 +95,10 @@ complexitty --license
 complexitty --license
 ```
 
+#### `-m`, `--multibrot`
+
+Set the 'multibrot' parameter for the plot.
+
 #### `-t`, `--theme`
 
 Sets Complexitty's theme; this overrides and changes any previous theme choice made
@@ -112,6 +124,18 @@ complexitty --version
 complexitty --version
 ```
 
+#### `-x`, `--x-position`
+
+Set the X position of the centre of the plot.
+
+#### `-y`, `--y-position`
+
+Set the Y position of the centre of the plot.
+
+#### `-z`, `--zoom`
+
+Set the amount of zoom to use for the plot.
+
 ## Getting help
 
 A great way to get to know Complexitty is to read the help screen. Once in

src/complexitty/__main__.py

@@ -10,6 +10,7 @@
 # Local imports.
 from . import __doc__, __version__
 from .complexitty import Complexitty
+from .mandelbrot import colour_maps
 
 
 ##############################################################################
@@ -52,6 +53,56 @@ def get_args() -> Namespace:
         action="store_true",
     )
 
+    # Add --colour-map
+    parser.add_argument(
+        "-c",
+        "--colour-map",
+        "--color-map",
+        help="Set the colour map",
+        type=str,
+        choices=colour_maps(),
+    )
+
+    # Add --max-iteration
+    parser.add_argument(
+        "-i",
+        "--max-iteration",
+        help="Set maximum iterations",
+        type=int,
+    )
+
+    # Add --multibrot
+    parser.add_argument(
+        "-m",
+        "--multibrot",
+        help="Set the 'multibrot' value",
+        type=int,
+    )
+
+    # Add --x-position
+    parser.add_argument(
+        "-x",
+        "--x-position",
+        help="Set the X position",
+        type=float,
+    )
+
+    # Add --x-position
+    parser.add_argument(
+        "-y",
+        "--y-position",
+        help="Set the Y position",
+        type=float,
+    )
+
+    # Add --zoom
+    parser.add_argument(
+        "-z",
+        "--zoom",
+        help="Set the zoom level",
+        type=int,
+    )
+
     # Add --theme
     parser.add_argument(
         "-t",

src/complexitty/complexitty.py

@@ -84,7 +84,7 @@ def get_default_screen(self) -> Main:
         Returns:
             The default screen.
         """
-        return Main()
+        return Main(self._arguments)
 
 
 ### complexitty.py ends here

src/complexitty/mandelbrot/__init__.py

@@ -2,10 +2,11 @@
 
 ##############################################################################
 # Local imports.
+from .colouring import colour_maps, get_colour_map
 from .widget import Mandelbrot
 
 ##############################################################################
 # Exports.
-__all__ = ["Mandelbrot"]
+__all__ = ["Mandelbrot", "colour_maps", "get_colour_map"]
 
 ### __init__.py ends here

src/complexitty/mandelbrot/colouring.py

@@ -3,7 +3,7 @@
 ##############################################################################
 # Python imports.
 from functools import lru_cache
-from typing import Callable, TypeAlias
+from typing import Callable, Final, TypeAlias
 
 ##############################################################################
 # Textual imports.
@@ -118,4 +118,35 @@ def shades_of_blue(value: int, _: int) -> Color:
     return BLUES[value % 16]
 
 
+##############################################################################
+COLOUR_MAPS: Final[dict[str, ColourMap]] = {
+    "blue_brown_map": blue_brown_map,
+    "default_map": default_map,
+    "shades_of_blue": shades_of_blue,
+    "shades_of_green": shades_of_green,
+    "shades_of_red": shades_of_red,
+}
+"""Name to colour map function map."""
+
+
+##############################################################################
+def colour_maps() -> tuple[str, ...]:
+    """Get the names of the available colour maps."""
+    return tuple(COLOUR_MAPS.keys())
+
+
+##############################################################################
+def get_colour_map(map_name: str) -> ColourMap:
+    """Get a colour mapping function by its name.
+
+    Args:
+        map_name: The name of the map to get.
+
+    Returns:
+        The requested colour mapping function, or the default map if the
+        name isn't known.
+    """
+    return COLOUR_MAPS.get(map_name, default_map)
+
+
 ### colouring.py ends here

src/complexitty/mandelbrot/widget.py

@@ -109,6 +109,42 @@ def plot(self) -> Self:
             self.post_message(self.Plotted(self, monotonic() - start))
         return self
 
+    def set(
+        self,
+        max_iteration: int | None = None,
+        multibrot: float | None = None,
+        x_position: float | None = None,
+        y_position: float | None = None,
+        zoom: float | None = None,
+        colour_map: ColourMap | None = None,
+    ) -> Self:
+        """Set one or more properties in one go.
+
+        Args:
+            max_iteration: The maximum iteration.
+            multibrot: The 'multibrot' value.
+            x_position: The X position of the middle of the plot.
+            y_position: The Y position of the middle of the plot.
+            zoom: The zoom value for the plot.
+            colour_map: The colour map to use for the plot.
+
+        Returns:
+            Self.
+        """
+        if max_iteration is not None:
+            self.set_reactive(Mandelbrot.max_iteration, max_iteration)
+        if multibrot is not None:
+            self.set_reactive(Mandelbrot.multibrot, multibrot)
+        if x_position is not None:
+            self.set_reactive(Mandelbrot.x_position, x_position)
+        if y_position is not None:
+            self.set_reactive(Mandelbrot.y_position, y_position)
+        if zoom is not None:
+            self.set_reactive(Mandelbrot.zoom, zoom)
+        if colour_map is not None:
+            self.set_reactive(Mandelbrot.colour_map, colour_map)
+        return self
+
     def goto(self, x: float, y: float) -> Self:
         """Move the centre of the plot to the given location.
 
@@ -119,25 +155,22 @@ def goto(self, x: float, y: float) -> Self:
         Returns:
             Self.
         """
-        self.set_reactive(Mandelbrot.x_position, x)
-        self.set_reactive(Mandelbrot.y_position, y)
-        return self.plot()
+        return self.set(x_position=x, y_position=y).plot()
 
     def reset(self) -> Self:
         """Reset the plot to its default state.
 
         Returns:
             Self.
         """
-        self.set_reactive(Mandelbrot.max_iteration, 80)
-        self.set_reactive(Mandelbrot.multibrot, 2)
-        self.set_reactive(Mandelbrot.x_position, -0.5)
-        self.set_reactive(Mandelbrot.y_position, 0)
-        self.set_reactive(Mandelbrot.zoom, 50)
-        # Setting an ignore in the following line. For some reason mypy
-        # can't deal with this; pyright is fine though.
-        self.set_reactive(Mandelbrot.colour_map, default_map)  # type:ignore
-        return self.plot()
+        return self.set(
+            max_iteration=80,
+            multibrot=2,
+            x_position=-0.5,
+            y_position=0,
+            zoom=50,
+            colour_map=default_map,
+        ).plot()
 
     def _validate_zoom(self, zoom: int) -> int:
         """Ensure the zoom doesn't fall to 0.

src/complexitty/screens/main.py

@@ -2,6 +2,7 @@
 
 ##############################################################################
 # Python imports.
+from argparse import Namespace
 from re import Pattern, compile
 from typing import Final
 
@@ -49,7 +50,7 @@
     ZoomOut,
     ZoomOutFaster,
 )
-from ..mandelbrot import Mandelbrot, colouring
+from ..mandelbrot import Mandelbrot, get_colour_map
 from ..providers import MainCommands
 
 
@@ -104,12 +105,35 @@ class Main(EnhancedScreen[None]):
     COMMANDS = {MainCommands}
     HELP = "## Commands and keys"
 
+    def __init__(self, arguments: Namespace) -> None:
+        """Initialise the screen object.
+
+        Args:
+            arguments: The command line arguments.
+        """
+        self._arguments = arguments
+        """The command line arguments passed to the application."""
+        super().__init__()
+
     def compose(self) -> ComposeResult:
         """Compose the content of the main screen."""
         yield Header()
         yield Mandelbrot()
         yield Footer()
 
+    def on_mount(self) -> None:
+        """Configure the Mandelbrot once the DOM is ready."""
+        self.query_one(Mandelbrot).set(
+            max_iteration=self._arguments.max_iteration,
+            multibrot=self._arguments.multibrot,
+            zoom=self._arguments.zoom,
+            x_position=self._arguments.x_position,
+            y_position=self._arguments.y_position,
+            colour_map=None
+            if self._arguments.colour_map is None
+            else get_colour_map(self._arguments.colour_map),
+        )
+
     @on(Mandelbrot.Plotted)
     def _update_situation(self, message: Mandelbrot.Plotted) -> None:
         """Update the current situation after the latest plot.
@@ -167,7 +191,7 @@ def action_set_colour(self, colour_map: str) -> None:
         Args:
             colour_map: The name of the colour map to use.
         """
-        self.query_one(Mandelbrot).colour_map = getattr(colouring, colour_map)
+        self.query_one(Mandelbrot).colour_map = get_colour_map(colour_map)
 
     def action_multibrot(self, change: int) -> None:
         """Change the 'multibrot' value.