External assets

reflex/__init__.py

@@ -116,7 +116,7 @@
 _MAPPING = {
     "reflex.experimental": ["_x"],
     "reflex.admin": ["admin", "AdminDash"],
-    "reflex.app": ["app", "App", "UploadFile"],
+    "reflex.app": ["app", "App", "UploadFile", "asset"],
     "reflex.base": ["base", "Base"],
     "reflex.compiler": ["compiler"],
     "reflex.compiler.utils": ["get_asset_path"],

reflex/__init__.pyi

@@ -4,6 +4,7 @@ from reflex.admin import AdminDash as AdminDash
 from reflex import app as app
 from reflex.app import App as App
 from reflex.app import UploadFile as UploadFile
+from reflex.app import asset as asset
 from reflex import base as base
 from reflex.base import Base as Base
 from reflex import compiler as compiler

reflex/app.py

@@ -7,10 +7,13 @@
 import contextlib
 import copy
 import functools
+import inspect
 import io
 import multiprocessing
 import os
 import platform
+import shutil
+from pathlib import Path
 from typing import (
     Any,
     AsyncIterator,
@@ -1317,3 +1320,40 @@ async def on_ping(self, sid):
         """
         # Emit the test event.
         await self.emit(str(constants.SocketEvent.PING), "pong", to=sid)
+
+
+def asset(relative_filename: str, dir: str = ".") -> str:
+    """Add an asset to the app.
+    Place the file next to your including python file.
+    Copies the file to the app's external assets directory.
+
+    Example:
+    ```python
+    rx.script(src=rx.asset("my_custom_javascript.js"))
+    rx.image(src=rx.asset("test_image.png","subfolder"))
+    ```
+
+    Args:
+        relative_filename: The relative filename of the asset.
+        dir: The directory to place the asset in.
+
+    Returns:
+        The relative URL to the copied asset.
+
+    """
+    calling_file = inspect.stack()[1].filename
+    cwd = Path.cwd()
+
+    module = inspect.getmodule(inspect.stack()[1][0])
+    assert module is not None
+
+    caller_module_path = module.__name__.replace(".", "/")
+    dir = caller_module_path if dir == "." else caller_module_path + "/" + dir
+    assets = constants.Dirs.APP_ASSETS
+    external = constants.Dirs.EXTERNAL_APP_ASSETS
+    Path(Path(cwd) / assets / external / dir).mkdir(parents=True, exist_ok=True)
+    shutil.copy2(
+        Path(calling_file).parent / relative_filename,
+        Path(cwd) / assets / external / dir / relative_filename,
+    )
+    return "/" + external + "/" + dir + "/" + relative_filename

reflex/constants/base.py

@@ -26,6 +26,8 @@ class Dirs(SimpleNamespace):
     WEB = ".web"
     # The name of the assets directory.
     APP_ASSETS = "assets"
+    # The name of the assets directory for external ressource (a subfolder of APP_ASSETS).
+    EXTERNAL_APP_ASSETS = "external"
     # The name of the utils file.
     UTILS = "utils"
     # The name of the output static directory.

reflex/constants/base.pyi

@@ -15,10 +15,15 @@ from types import SimpleNamespace
 from platformdirs import PlatformDirs
 
 IS_WINDOWS = platform.system() == "Windows"
+IS_WINDOWS_BUN_SUPPORTED_MACHINE = IS_WINDOWS and platform.machine() in [
+    "AMD64",
+    "x86_64",
+]
 
 class Dirs(SimpleNamespace):
     WEB = ".web"
     APP_ASSETS = "assets"
+    EXTERNAL_APP_ASSETS = "external"
     UTILS = "utils"
     STATIC = "_static"
     STATE_PATH = "/".join([UTILS, "state"])