Skip to content

App

App

Bases: EventManager, GUIManager, ConfigManager

BISCUIT CORE

Manages App Configuration, GUI (Tkinter), Events of the App.

Single point of access to all the important parts of the app. Holds reference to all the components of Biscuit and every class of biscuit have a reference back to this base class. i.e. self.base is the reference to this class from any other class of biscuit.

Usage

Example: In order to access the open editor from the git:

class Git:
    def foo(self):
        editor = self.base.editorsmanager.active_editor
        if editor.content and editor.content.exists:
            print(editor.path)

Example: Accessing the active editor instance from Foo class of biscuit:

class Foo:
    def foo(self):
        editor = self.base.editorsmanager.active_editor
        if (editor.content and editor.content.exists):
            print(editor.path)
            if (editor.content.editable):
                self.base.notifications.info(":)")
Source code in src/biscuit/app.py 
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
class App(EventManager, GUIManager, ConfigManager):
    """
    BISCUIT CORE
    ------------

    Manages App Configuration, GUI (Tkinter), Events of the App.

    Single point of access to all the important parts of the app. Holds reference to all the components
    of Biscuit and every class of biscuit have a reference back to this `base` class.
    i.e. `self.base` is the reference to this class from any other class of biscuit.

    Usage
    -----

    Example: In order to access the open editor from the git:

    ```py
    class Git:
        def foo(self):
            editor = self.base.editorsmanager.active_editor
            if editor.content and editor.content.exists:
                print(editor.path)
    ```

    Example: Accessing the active editor instance from Foo class of biscuit:

    ```py
    class Foo:
        def foo(self):
            editor = self.base.editorsmanager.active_editor
            if (editor.content and editor.content.exists):
                print(editor.path)
                if (editor.content.editable):
                    self.base.notifications.info(":)")
    ```
    """

    def __init__(self, appdir: str = "", dir: str = "", *args, **kwargs) -> None:
        """Initialize the App.

        Args:
            appdir (str, optional): Directory of the app. Defaults to "".
            dir (str, optional): Directory to open in the editor. Defaults to "".
        """

        super().__init__(*args, **kwargs)
        self.base = self
        self.appdir = appdir

        self.setup()
        self.late_setup()
        self.initialize_app(dir)

    def run(self) -> None:
        """Start the main loop of the app."""

        self.mainloop()
        self.history.dump()
        self.extensions_manager.stop_server()

    def setup(self) -> None:
        """Setup the app."""

        self.initialized = False
        self.setup_path(self.appdir)
        self.setup_configs()
        self.initialize_tk()

    def initialize_app(self, dir: str) -> None:
        """Initialize the editor.

        Args:
            dir (str): Directory to open."""

        self.initialized = True

        self.palette.generate_help_actionset()
        self.logger.info("Initializing editor finished.")

        self.update_idletasks()
        self.menubar.update()
        self.set_title()
        self.open_directory(dir)
        self.focus_force()

    def control_execute(self, text: str) -> None:
        try:
            return eval(text)
        except SyntaxError:
            try:
                exec(text)
            except Exception as e:
                return e
        except Exception as e:
            return e

__init__(appdir='', dir='', *args, **kwargs)

Initialize the App.

Parameters:

Name Type Description Default
appdir str

Directory of the app. Defaults to "".

 ''
dir str

Directory to open in the editor. Defaults to "".

 ''
Source code in src/biscuit/app.py 
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
def __init__(self, appdir: str = "", dir: str = "", *args, **kwargs) -> None:
    """Initialize the App.

    Args:
        appdir (str, optional): Directory of the app. Defaults to "".
        dir (str, optional): Directory to open in the editor. Defaults to "".
    """

    super().__init__(*args, **kwargs)
    self.base = self
    self.appdir = appdir

    self.setup()
    self.late_setup()
    self.initialize_app(dir)

initialize_app(dir)

Initialize the editor.

Parameters:

Name Type Description Default
dir str

Directory to open.

 required
Source code in src/biscuit/app.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
def initialize_app(self, dir: str) -> None:
    """Initialize the editor.

    Args:
        dir (str): Directory to open."""

    self.initialized = True

    self.palette.generate_help_actionset()
    self.logger.info("Initializing editor finished.")

    self.update_idletasks()
    self.menubar.update()
    self.set_title()
    self.open_directory(dir)
    self.focus_force()

run()

Start the main loop of the app.

Source code in src/biscuit/app.py 
59
60
61
62
63
64
def run(self) -> None:
    """Start the main loop of the app."""

    self.mainloop()
    self.history.dump()
    self.extensions_manager.stop_server()

setup()

Setup the app.

Source code in src/biscuit/app.py 
66
67
68
69
70
71
72
def setup(self) -> None:
    """Setup the app."""

    self.initialized = False
    self.setup_path(self.appdir)
    self.setup_configs()
    self.initialize_tk()