Sudoku Showcase
Public Member Functions | List of all members
sudoku.cli.CLI Class Reference

Command line interface for playing Sudoku directly in the terminal. More...

Public Member Functions

def __init__ (self, bool useUI=False)
 
None run (self)
 Executed on cli without UI. More...
 

Detailed Description

Command line interface for playing Sudoku directly in the terminal.

The CLI acts as a lightweight text-based frontend around the App controller and translates terminal commands into application actions. It uses argparse with subcommands to provide an interactive shell-like experience for managing gameplay, notes, puzzle generation, and inspection utilities.

The interface supports:

The CLI intentionally keeps game logic outside of this class and forwards actions to the App controller instead. This keeps the terminal interface focused on input parsing, validation, and user interaction.

The command parser is designed to provide descriptive help messages and graceful error handling for invalid commands and arguments.

Constructor & Destructor Documentation

◆ __init__()

def sudoku.cli.CLI.__init__ (   self,
bool   useUI = False 
)

Member Function Documentation

◆ run()

None sudoku.cli.CLI.run (   self)

Executed on cli without UI.

Returns
None

The documentation for this class was generated from the following file: