document functionality to have multiple pathes / directories for stat…

…ic files and fix typings (#446)

- Expose functionality to have multiple pathes/directories
- Update staticfiles docs
- Provide multiple examples

docs/en/docs/configurations/staticfiles.md

@@ -41,3 +41,15 @@ but also via settings.
 ```
 
 This will make sure you keep the settings clean, separated and without a bloated **Esmerald** instance.
+
+## Multiple directories and multiple pathes
+
+Imagine, for example, you have multiple directories you would like to access including a `node_modules/` one.
+This is possible do do it by passing multiple `StaticFilesConfig` configurations and shown below:
+
+```python
+{!> ../../../docs_src/configurations/staticfiles/example_multiple.py!}
+```
+
+!!! Note
+    The first path match is used and there is currently no fallthrough in case no file is found, so the order is very important.

docs/en/docs/release-notes.md

@@ -10,6 +10,7 @@ hide:
 ### Fixed
 
 - Fix cli detection of wrapped esmerald instances or different ASGI servers.
+- Allow passing multiple `StaticFilesConfig` configurations in a tuple.
 
 ## 3.5.1
 

docs_src/configurations/staticfiles/example_multiple.py

@@ -0,0 +1,13 @@
+from pathlib import Path
+
+from esmerald import Esmerald, StaticFilesConfig
+
+static_files_config = StaticFilesConfig(
+    path="/static", packages=["mypackage"], directory=Path("static")
+)
+
+static_files_node_modules_config = StaticFilesConfig(
+    path="/static/node_modules", directory=Path("node_modules")
+)
+
+app = Esmerald(static_files_config=[static_files_node_modules_config, static_files_config])

esmerald/applications.py

@@ -720,13 +720,18 @@ def is_valid(number: int) -> bool:
             ),
         ] = None,
         static_files_config: Annotated[
-            Optional["StaticFilesConfig"],
+            Union[
+                "StaticFilesConfig",
+                list["StaticFilesConfig"],
+                tuple["StaticFilesConfig", ...],
+                None,
+            ],
             Doc(
                 """
                 An instance of [StaticFilesConfig](https://esmerald.dev/configurations/staticfiles/).
 
                 This configuration is used to enable and serve static files via
-                Esmerald application.
+                Esmerald application. You can pass also multiple objects via a list or tuple.
 
                 **Example**
 
@@ -1683,7 +1688,7 @@ def _configure(self) -> None:
         if self.static_files_config:
             for config in (
                 self.static_files_config
-                if isinstance(self.static_files_config, list)
+                if isinstance(self.static_files_config, (list, tuple))
                 else [self.static_files_config]
             ):
                 static_route = Include(path=config.path, app=config.to_app())

esmerald/conf/global_settings.py

@@ -875,7 +875,9 @@ def template_config(self) -> TemplateConfig:
         return None
 
     @property
-    def static_files_config(self) -> Optional[StaticFilesConfig]:
+    def static_files_config(
+        self,
+    ) -> Union[StaticFilesConfig, list[StaticFilesConfig], tuple[StaticFilesConfig, ...], None]:
         """
         An instance of [StaticFilesConfig](https://esmerald.dev/configurations/staticfiles/).
 

esmerald/config/static_files.py

@@ -26,6 +26,9 @@ class StaticFilesConfig(BaseModel):
     )
 
     app = Esmerald(static_files_config=static_files_config)
+    # or multiple in descending priority
+    app = Esmerald(static_files_config=[static_files_config1, static_files_config2, ...])
+
     ```
     """
 

esmerald/testclient.py

@@ -129,7 +129,9 @@ def create_client(
     openapi_version: Optional[str] = "3.1.0",
     raise_server_exceptions: bool = True,
     root_path: str = "",
-    static_files_config: Optional["StaticFilesConfig"] = None,
+    static_files_config: Union[
+        "StaticFilesConfig", list["StaticFilesConfig"], tuple["StaticFilesConfig", ...], None
+    ] = None,
     template_config: Optional["TemplateConfig"] = None,
     lifespan: Optional[Callable[["Esmerald"], "AsyncContextManager"]] = None,
     cookies: Optional[CookieTypes] = None,