app.py is updated with comments

app.py

@@ -4,12 +4,20 @@ from gradio.blocks import Block, Blocks
 from typing import Dict
 from fastapi import FastAPI
 
+"""
+---------------------------------------------------------------------------------------------------------
+-- Base Classes
+"""
 
+
+# Base class for the RowLayout, ColumnLayout and TabLayout classes
 class LayoutBase:
-    main_layout: Block
-    name: str
-    global_children_dict: Dict[str, Block]
-    renderables: list
+    main_layout: Block  # Stores the main layout from the gradio package of this class.
+    name: str  # Name of the class. Used to differentiate from other layouts and for debug purposes.
+    global_children_dict: Dict[
+        str, Block
+    ]  # Stores the children components with given name.
+    renderables: list  # Stores the renderable elements such as components and layouts.
 
     def __init__(self) -> None:
         self.main_layout = None
@@ -17,10 +25,20 @@ class LayoutBase:
         self.global_children_dict = {}
         self.renderables = []
 
+    """
+        components are coming from the gradio package
+        these components are inherited from the Block class eventually
+    """
+
     def add_component(self, name: str, component: Block) -> None:
         self.renderables.append(component)
         self.global_children_dict[name] = component
 
+    """
+        layout has to be from RowLayout, ColumnLayout or TabLayout classes
+        the parent class includes all the components that children layouts have
+    """
+
     def add_layout(self, layout: LayoutBase) -> None:
         self.renderables.append(layout)
         self.global_children_dict.update(layout.global_children_dict)
@@ -35,25 +53,36 @@ class LayoutBase:
     def clear(self) -> None:
         self.global_children_dict.clear()
 
+        # we can be sure that all objects are cleaned
         for renderable in self.renderables:
             if isinstance(renderable, LayoutBase):
                 renderable.clear()
 
         self.renderables.clear()
 
+    """
+        the inherited class has to implement this function.
+        block_dict is coming from Application class's _attach_event function or parent class's attach_event function
+    """
+
     def attach_event(self, block_dict: Dict[str, Block]) -> None:
         raise NotImplementedError
 
 
+# Responsible for rendering, attaching events and launching
 class Application:
-    app: Blocks
-    children: list[LayoutBase]
+    app: Blocks  # Base application component from the gradio package.
+    children: list[LayoutBase]  # Stores the layouts
 
     # Blocks constructor parameters are omitted for brevity
     def __init__(self, title: str) -> None:
         self.app = Blocks(title=title)
         self.children = []
 
+    """
+        adding given RowLayout, ColumnLayout or TabLayout classes to children variable
+    """
+
     def add(self, child: LayoutBase):
         self.children.append(child)
 
@@ -77,6 +106,11 @@ class Application:
                 except NotImplementedError:
                     print(f"{child.name}'s attach_event is not implemented")
 
+    """
+        clearing the children
+        we don't need them because they are going to live in the app.blocks and app.fns functions
+    """
+
     def _clear(self):
         from gc import collect
 
@@ -126,6 +160,12 @@ class TabLayout(LayoutBase):
         self.global_children_dict[name] = self.main_layout
 
 
+"""
+---------------------------------------------------------------------------------------------------------
+-- Example
+"""
+
+
 def change_text(new_str: str):
     return Textbox(value=new_str)
 
@@ -184,6 +224,11 @@ class SecondTab(TabLayout):
         )
 
 
+"""
+---------------------------------------------------------------------------------------------------------
+-- Main
+"""
+
 gui = Application(title="Wrap Gradio")
 
 first_tab = FirstTab(name="First Tab")