updated examples to reflect pypackage install, updated serve_folder example to exclude the set_file_handler portion, commented out set_file_handler and set_file_handler_window

SageCreations · SageCreations · commit ab34be06267c · 2025-02-05T22:58:59.000-06:00
diff --git a/PyPI/Package/src/webui/webui.py b/PyPI/Package/src/webui/webui.py
@@ -1,5 +1,7 @@
 # webui.py
 from __future__ import annotations
+
+import warnings
 from typing import Callable, Optional
 from ctypes import *
 
@@ -712,7 +714,10 @@ def show_browser(self, content: str, browser: Browser) -> bool:
             success = my_window.show_browser("<html>...</html>", Browser.Chrome)
             success = my_window.show_browser("index.html", Browser.Firefox)
         """
-        return _raw.webui_show_browser(c_size_t(self._window), c_char_p(content.encode("utf-8")), c_size_t(browser.value))
+        success = bool(_raw.webui_show_browser(c_size_t(self._window), c_char_p(content.encode("utf-8")), c_size_t(browser.value)))
+        if not success: warnings.warn("The browser you selected might not be installed on your system.")
+
+        return success
 
     # -- start_server -------------------------------
     def start_server(self, content: str) -> str:
@@ -864,113 +869,113 @@ def set_root_folder(self, path: str) -> bool:
         """
         return bool(_raw.webui_set_root_folder(c_size_t(self._window), path.encode("utf-8")))
 
-    # -- set_file_handler ---------------------------
-    def set_file_handler(self, handler: Callable[[str], Optional[str]]) -> None:
-        """Set a custom file handler for serving files.
-
-        This function registers a custom file handler that processes file requests
-        and serves HTTP responses. The handler must return a full HTTP response
-        (headers and body) as a UTF-8 encoded string. Setting a new handler overrides
-        any previously registered file handler.
-
-        Args:
-            handler (Callable[[str], str]): A function that takes a filename as input
-                and returns a complete HTTP response as a string.
-
-        Returns:
-            None
-
-        Example:
-            def my_handler(filename: str) -> str:
-                response_body = "Hello, World!"
-                response_headers = (
-                    "HTTP/1.1 200 OK\r\n"
-                    "Content-Type: text/plain\r\n"
-                    f"Content-Length: {len(response_body)}\r\n"
-                    "\r\n"
-                )
-                return response_headers + response_body
-
-            my_window.set_file_handler(my_handler)
-        """
-        def _internal_file_handler(filename_ptr: c_char_p, length_ptr: POINTER(c_int)) -> c_void_p:
-            """
-            Internal C callback that matches the signature required by webui_set_file_handler_window.
-            """
-            # Decode the incoming filename from C
-            filename = filename_ptr.decode('utf-8') if filename_ptr else ""
-
-            # Call the Python-level handler to get the HTTP response
-            response_bytes = handler(filename).encode("utf-8")
-
-            # Create a ctypes buffer from the Python bytes; this buffer must remain alive
-            # at least until WebUI is done with it.
-            buf = create_string_buffer(response_bytes)
-
-            # Set the length (the int* that C expects)
-            length_ptr[0] = len(response_bytes)
-
-            # Return a pointer (void*) to the buffer
-            return cast(buf, c_void_p)
-
-        # Keep a reference so it doesn't get garbage collected
-        self._file_handler_cb = filehandler_window_callback(_internal_file_handler)
-        _raw.webui_set_file_handler_window(c_size_t(self._window), _raw.FILE_HANDLER_CB(self._file_handler_cb))
-
-
-    # -- set_file_handler_window --------------------
-    def set_file_handler_window(self, handler: Callable[[int, str], Optional[str]]) -> None:
-        """Set a custom file handler for a specific window.
-
-        This function registers a custom file handler that processes file requests
-        for a specific window and serves HTTP responses. The handler must return
-        a full HTTP response (headers and body) as a UTF-8 encoded string.
-        Setting a new handler overrides any previously registered file handler.
-
-        Args:
-            handler (Callable[[int, str], str]): A function that takes a window ID
-                and a filename as input and returns a complete HTTP response as a string.
-
-        Returns:
-            None
-
-        Example:
-            def my_handler(window_id: int, filename: str) -> str:
-                response_body = "Hello, World!"
-                response_headers = (
-                    "HTTP/1.1 200 OK\r\n"
-                    "Content-Type: text/plain\r\n"
-                    f"Content-Length: {len(response_body)}\r\n"
-                    "\r\n"
-                )
-                return response_headers + response_body
-
-            my_window.set_file_handler_window(my_handler)
-        """
-        def _internal_file_handler(window_id: c_size_t, filename_ptr: c_char_p, length_ptr: POINTER(c_int)) -> c_void_p:
-            """
-            Internal C callback that matches the signature required by webui_set_file_handler_window.
-            """
-            # Decode the incoming filename from C
-            filename = filename_ptr.decode('utf-8') if filename_ptr else ""
-
-            # Call the Python-level handler to get the HTTP response
-            response_bytes = handler(int(window_id), filename).encode("utf-8")
-
-            # Create a ctypes buffer from the Python bytes; this buffer must remain alive
-            # at least until WebUI is done with it.
-            buf = create_string_buffer(response_bytes)
-
-            # Set the length (the int* that C expects)
-            length_ptr[0] = len(response_bytes)
-
-            # Return a pointer (void*) to the buffer
-            return cast(buf, c_void_p)
-
-        # Keep a reference so it doesn't get garbage collected
-        self._file_handler_cb = filehandler_window_callback(_internal_file_handler)
-
-        _raw.webui_set_file_handler_window(c_size_t(self._window), self._file_handler_cb)
+    # -- set_file_handler ---------------------------  # TODO: still errors on call to c bind
+    # def set_file_handler(self, handler: Callable[[str], Optional[str]]) -> None:
+    #     """Set a custom file handler for serving files.
+    #
+    #     This function registers a custom file handler that processes file requests
+    #     and serves HTTP responses. The handler must return a full HTTP response
+    #     (headers and body) as a UTF-8 encoded string. Setting a new handler overrides
+    #     any previously registered file handler.
+    #
+    #     Args:
+    #         handler (Callable[[str], str]): A function that takes a filename as input
+    #             and returns a complete HTTP response as a string.
+    #
+    #     Returns:
+    #         None
+    #
+    #     Example:
+    #         def my_handler(filename: str) -> str:
+    #             response_body = "Hello, World!"
+    #             response_headers = (
+    #                 "HTTP/1.1 200 OK\r\n"
+    #                 "Content-Type: text/plain\r\n"
+    #                 f"Content-Length: {len(response_body)}\r\n"
+    #                 "\r\n"
+    #             )
+    #             return response_headers + response_body
+    #
+    #         my_window.set_file_handler(my_handler)
+    #     """
+    #     def _internal_file_handler(filename_ptr: c_char_p, length_ptr: POINTER(c_int)) -> c_void_p:
+    #         """
+    #         Internal C callback that matches the signature required by webui_set_file_handler_window.
+    #         """
+    #         # Decode the incoming filename from C
+    #         filename = filename_ptr.decode('utf-8') if filename_ptr else ""
+    #
+    #         # Call the Python-level handler to get the HTTP response
+    #         response_bytes = handler(filename).encode("utf-8")
+    #
+    #         # Create a ctypes buffer from the Python bytes; this buffer must remain alive
+    #         # at least until WebUI is done with it.
+    #         buf = create_string_buffer(response_bytes)
+    #
+    #         # Set the length (the int* that C expects)
+    #         length_ptr[0] = len(response_bytes)
+    #
+    #         # Return a pointer (void*) to the buffer
+    #         return cast(buf, c_void_p)
+    #
+    #     # Keep a reference so it doesn't get garbage collected
+    #     self._file_handler_cb = filehandler_window_callback(_internal_file_handler)
+    #     _raw.webui_set_file_handler_window(c_size_t(self._window), _raw.FILE_HANDLER_CB(self._file_handler_cb))
+
+
+    # -- set_file_handler_window --------------------  # TODO: still errors on call to c bind
+    # def set_file_handler_window(self, handler: Callable[[int, str], Optional[str]]) -> None:
+    #     """Set a custom file handler for a specific window.
+    #
+    #     This function registers a custom file handler that processes file requests
+    #     for a specific window and serves HTTP responses. The handler must return
+    #     a full HTTP response (headers and body) as a UTF-8 encoded string.
+    #     Setting a new handler overrides any previously registered file handler.
+    #
+    #     Args:
+    #         handler (Callable[[int, str], str]): A function that takes a window ID
+    #             and a filename as input and returns a complete HTTP response as a string.
+    #
+    #     Returns:
+    #         None
+    #
+    #     Example:
+    #         def my_handler(window_id: int, filename: str) -> str:
+    #             response_body = "Hello, World!"
+    #             response_headers = (
+    #                 "HTTP/1.1 200 OK\r\n"
+    #                 "Content-Type: text/plain\r\n"
+    #                 f"Content-Length: {len(response_body)}\r\n"
+    #                 "\r\n"
+    #             )
+    #             return response_headers + response_body
+    #
+    #         my_window.set_file_handler_window(my_handler)
+    #     """
+    #     def _internal_file_handler(window_id: c_size_t, filename_ptr: c_char_p, length_ptr: POINTER(c_int)) -> c_void_p:
+    #         """
+    #         Internal C callback that matches the signature required by webui_set_file_handler_window.
+    #         """
+    #         # Decode the incoming filename from C
+    #         filename = filename_ptr.decode('utf-8') if filename_ptr else ""
+    #
+    #         # Call the Python-level handler to get the HTTP response
+    #         response_bytes = handler(int(window_id), filename).encode("utf-8")
+    #
+    #         # Create a ctypes buffer from the Python bytes; this buffer must remain alive
+    #         # at least until WebUI is done with it.
+    #         buf = create_string_buffer(response_bytes)
+    #
+    #         # Set the length (the int* that C expects)
+    #         length_ptr[0] = len(response_bytes)
+    #
+    #         # Return a pointer (void*) to the buffer
+    #         return cast(buf, c_void_p)
+    #
+    #     # Keep a reference so it doesn't get garbage collected
+    #     self._file_handler_cb = filehandler_window_callback(_internal_file_handler)
+    #
+    #     _raw.webui_set_file_handler_window(c_size_t(self._window), self._file_handler_cb)
 
     # -- is_shown -----------------------------------
     def is_shown(self) -> bool:
diff --git a/examples/andershell3000/andershell3000.py b/examples/andershell3000/andershell3000.py
@@ -1,10 +1,6 @@
-import sys
-sys.path.append('../../PyPI/Package/src/webui')
-import webui
-
 # Install WebUI
 # pip install --upgrade webui2
-# from webui import webui
+from webui import webui
 import subprocess
 import time
 
@@ -53,6 +49,6 @@ def run_command(e : webui.Event):
 MyWindow = webui.Window()
 MyWindow.bind("Run", run_command)
 MyWindow.set_root_folder("ui/")
-MyWindow.show_browser('index.html', webui.Browser.Chrome)
+MyWindow.show_browser('index.html', webui.Browser.AnyBrowser)
 webui.wait()
 executor.close()
diff --git a/examples/hello_world.py b/examples/hello_world.py
@@ -1,10 +1,6 @@
-import sys
-sys.path.append('../PyPI/Package/src/webui')
-import webui
-
 # Install WebUI
 # pip install --upgrade webui2
-# from webui import webui
+from webui import webui
 
 # CSS
 css = """
diff --git a/examples/minimal.py b/examples/minimal.py
@@ -1,11 +1,7 @@
-import sys
-sys.path.append('../PyPI/Package/src/webui')
-import webui
-
 # Install WebUI
 # pip install --upgrade webui2
 
-# from webui import webui
+from webui import webui
 
 MyWindow = webui.Window()
 MyWindow.show('<html><head><script src=\"webui.js\"></script></head> Hello World ! </html>')
diff --git a/examples/public_ui.py b/examples/public_ui.py
@@ -1,8 +1,4 @@
-import sys
-sys.path.append('../PyPI/Package/src/webui')
-import webui
-
-# from webui import webui # GUI
+from webui import webui # GUI
 import socket # To get local IP
 
 
diff --git a/examples/serve_folder/index.html b/examples/serve_folder/index.html
@@ -81,8 +81,8 @@ <h4><a href="second.html">Second Page As A Simple Link (Local file)</a></h4>
 		<br />
 		<button id="OpenNewWindow">Open The Second Window (Local file)</button>
 		<br />
-		<h4><a href="test.txt">Static file example (Embedded)</a></h4>
-		<h4><a href="dynamic.html">Dynamic file example (Embedded)</a></h4>
+<!--		<h4><a href="test.txt">Static file example (Embedded)</a></h4>-->
+<!--		<h4><a href="dynamic.html">Dynamic file example (Embedded)</a></h4>-->
 		<p>
 			Unicode Test:<br /><br />
 			مرحبًا<br /> <!-- Arabic -->
diff --git a/examples/serve_folder/main.py b/examples/serve_folder/main.py
diff --git a/examples/serve_folder/node_test.js b/examples/serve_folder/node_test.js
diff --git a/examples/text-editor/main.py b/examples/text-editor/main.py
