main_screen.MainScreen Class Reference

Inheritance diagram for main_screen.MainScreen:

Collaboration diagram for main_screen.MainScreen:

Public Member Functions
	on_mount (self)
	set_initial_input_file (self, str input_file)
	update_with_new_input (self, str input_file_name)
	on_configuration_controller_changed (self, event)
None	action_save_configuration (self)
None	action_save_configuration_with_message (self)
None	action_open_configuration (self)
None	action_toggle_disable (self)
	call_quit_handler (self)
None	action_request_quit (self)
	handle_sigint (self, signum, frame)
None	action_modify_relations (self)
None	action_add_configuration (self)
None	action_destroy_configuration (self)
None	action_rename_configuration (self)

Public Attributes
	logger = RichLogWError(id="main_log", highlight=True, markup=True)

Static Public Attributes
list	BINDINGS

Static Protected Attributes
	_config_controller = None
	_init_input = None

Private Member Functions
	__make_logger (self, bool splash=False)

Detailed Description

Main screen for navigating python DBE

Definition at line 21 of file main_screen.py.

Member Function Documentation

__make_logger()

main_screen.MainScreen.__make_logger ( self, bool splash = False )

private

Definition at line 41 of file main_screen.py.

    def __make_logger(self, splash: bool=False):
        self.logger = RichLogWError(id="main_log", highlight=True, markup=True)
        
        # Splash screen
        if splash:
            self.logger.write("[red]========================================================================")
            self.logger.write("    [bold yellow]Welcome to CIDER![/bold yellow]")
            self.logger.write("    [green]This is a work in progress, please use with[/green] [bold red]caution![/bold red]")
            self.logger.write("[red]========================================================================\n\n")
 

action_add_configuration()

None main_screen.MainScreen.action_add_configuration

(

self

)

Definition at line 162 of file main_screen.py.

    async def action_add_configuration(self)->None:
        try:
            self.app.push_screen(AddNewObjectScreen())
        except Exception as e:
            self.query_one(RichLogWError).write_error(e)
    

action_destroy_configuration()

None main_screen.MainScreen.action_destroy_configuration

(

self

)

Definition at line 168 of file main_screen.py.

    async def action_destroy_configuration(self)->None:
        try:
            self.app.push_screen(DeleteConfigObjectScreen())
        except Exception as e:
            self.query_one(RichLogWError).write_error(e)
    

action_modify_relations()

None main_screen.MainScreen.action_modify_relations

(

self

)

Definition at line 159 of file main_screen.py.

    async def action_modify_relations(self)->None:
        self.app.push_screen(ConfigObjectModifierScreen())     
 

action_open_configuration()

None main_screen.MainScreen.action_open_configuration

(

self

)

Activate open file splash screen

Definition at line 129 of file main_screen.py.

    async def action_open_configuration(self) -> None:
        """Activate open file splash screen
        """        
        # Push the OpenFileScreen and wait for it to be closed
        await self.app.push_screen(OpenFileScreen())
 

action_rename_configuration()

None main_screen.MainScreen.action_rename_configuration

(

self

)

Definition at line 174 of file main_screen.py.

    async def action_rename_configuration(self)->None:
        self.app.push_screen(RenameConfigObjectScreen())
        

action_request_quit()

None main_screen.MainScreen.action_request_quit

(

self

)

Quit TDBE

Definition at line 150 of file main_screen.py.

    async def action_request_quit(self)->None:
        """Quit TDBE
        """
        self.call_quit_handler()
 

action_save_configuration()

None main_screen.MainScreen.action_save_configuration

(

self

)

Save current configuration

Definition at line 118 of file main_screen.py.

    def action_save_configuration(self)->None:
        """Save current configuration
        """        
        config = self.query_one(ConfigurationController)
        config.commit_configuration("Update configuration")
 

action_save_configuration_with_message()

None main_screen.MainScreen.action_save_configuration_with_message

(

self

)

Save current configuration with an update message

Definition at line 124 of file main_screen.py.

    def action_save_configuration_with_message(self)->None:
        """Save current configuration with an update message
        """        
        self.app.push_screen(SaveWithMessageScreen())
        

action_toggle_disable()

None main_screen.MainScreen.action_toggle_disable

(

self

)

Toggle disable on the selected configuration object

Definition at line 135 of file main_screen.py.

    async def action_toggle_disable(self)->None:
        """Toggle disable on the selected configuration object
        """        
        if self._config_controller.can_be_disabled():
            await self.app.push_screen(SelectSessionScreen())
        
        else:        
            # except:
            self.query_one(RichLogWError).write_error("Could not toggle disable configuration object")
 
    

call_quit_handler()

main_screen.MainScreen.call_quit_handler

(

self

)

Call the quit handler just like action_request_quit.

Definition at line 146 of file main_screen.py.

    def call_quit_handler(self):
        """Call the quit handler just like action_request_quit."""
        self.app.push_screen(QuitScreen())  # Show the quit confirmation screen
 

handle_sigint()

main_screen.MainScreen.handle_sigint	(		self,
			signum,
			frame )

Definition at line 155 of file main_screen.py.

    def handle_sigint(self, signum, frame):
        # In the event quit is done with ctrl+c
        self.call_quit_handler()
        

on_configuration_controller_changed()

main_screen.MainScreen.on_configuration_controller_changed	(		self,
			event )

Updates table based on global state of the configuration controller

Definition at line 111 of file main_screen.py.

    def on_configuration_controller_changed(self, event):
        """Updates table based on global state of the configuration controller
        """        
        config_table = self.query_one(ConfigTable)
        if config_table is not None:
            config_table.update_table(event.dal)
        

on_mount()

main_screen.MainScreen.on_mount

(

self

)

Mount widgets with the logger appearing first

Definition at line 51 of file main_screen.py.

    async def on_mount(self):
        """Mount widgets with the logger appearing first"""
        self.__make_logger(splash=True)
        await self.mount(self.logger)  # Mount the logger first
 
        # Mount other widgets
        if self._config_controller is None:
            self._config_controller = ConfigurationController()
        await self.mount(self._config_controller)
        await self.mount(Footer())
        
        if self._init_input is not None:
            self.update_with_new_input(self._init_input)
 

set_initial_input_file()

main_screen.MainScreen.set_initial_input_file	(		self,
		str	input_file )

Definition at line 65 of file main_screen.py.

    def set_initial_input_file(self, input_file: str):
        self._init_input = input_file
 

update_with_new_input()

main_screen.MainScreen.update_with_new_input	(		self,
		str	input_file_name )

Update main screen to have a new input file.

Definition at line 68 of file main_screen.py.

    def update_with_new_input(self, input_file_name: str):
        '''
        Update main screen to have a new input file.
        '''
        self._init_input = input_file_name
        
        try:
            self._config_controller.new_handler_from_str(input_file_name)
        except Exception as e:
            self.logger.write_error(e)
            return
 
        # Add interfaces
        self._config_controller.add_interface("class-selection")
        self._config_controller.add_interface("relation-selection")
        
        # Mount the selection panel
        try:
            self.mount(SelectionPanel())
        except Exception as e:
            raise e
 
        # Mount config table
        try:
            config_table = self.query_one(ConfigTable)
            config_table.update_table(self._config_controller.current_dal)
        except:
            config_table = ConfigTable(id="main_table")
            self.mount(config_table)
 
        # Refresh the screen for safety
        self.refresh()
        
        # Get logger (defined at the start)
        
        # Get the current database name
        current_database_path = self._config_controller.configuration.databases[0]
        data_base_name = path.basename(current_database_path)
        
        # Print everything!
        self.logger.write(f"[bold green]Opened new configuration file: [/bold green][bold red]{data_base_name}[/bold red][bold green].\nConnected databases are:[/bold green]\n" \
                     + "".join([f"   - [red]{db}[/red] \n" for db in self._config_controller.configuration.get_includes()]))
            

Member Data Documentation

_config_controller

main_screen.MainScreen._config_controller = None

staticprotected

Definition at line 38 of file main_screen.py.

_init_input

main_screen.MainScreen._init_input = None

staticprotected

Definition at line 39 of file main_screen.py.

BINDINGS

list main_screen.MainScreen.BINDINGS

static

Initial value:

=  [
                # Binding("ctrl+s", "save_configuration", "Save Configuration"),
                Binding("ctrl+s", "save_configuration_with_message", "Save Configuration"),
                Binding("o", "open_configuration", "Open Configuration"),
                Binding("ctrl+q", "request_quit", "Exit Cider"),
                Binding("e", "modify_relations", "Modify Relation to Object"),
                Binding("r", "rename_configuration", "Rename Conf Object"),
                Binding("d", "toggle_disable", "Toggle Disable"),
                Binding("a", "add_configuration", "Add Conf Object"),
                Binding("ctrl+d", "destroy_configuration", "Delete Conf Object"),
            ]

Definition at line 26 of file main_screen.py.

logger

main_screen.MainScreen.logger = RichLogWError(id="main_log", highlight=True, markup=True)

Definition at line 42 of file main_screen.py.

---

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

• /github/workspace/dunedaq/sourcecode/daqconf/python/daqconf/cider/app_structures/main_screen.py