servestatic 4.3.3__tar.gz → 4.3.4__tar.gz

{servestatic-4.3.3 → servestatic-4.3.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: servestatic
-Version: 4.3.3
+Version: 4.3.4
 Summary: Production-grade static file server for Python WSGI & ASGI.
 Project-URL: Changelog, https://archmonger.github.io/ServeStatic/latest/changelog/
 Project-URL: Documentation, https://archmonger.github.io/ServeStatic/
@@ -63,7 +63,28 @@ When using `ServeStatic`, best practices are automatically handled such as:
 - Proper handling of `Accept-Encoding` and `Vary` headers
 - Setting far-future cache headers for immutable static files.
 
-Visit the [documentation](https://archmonger.github.io/ServeStatic/) to get started or learn more about `ServeStatic` .
+
+## Quick Start
+
+Here is a short example of ASGI standalone mode:
+
+```python
+# filename: my_project.py
+from servestatic import ServeStaticASGI
+
+asgi_app = ServeStaticASGI(
+    application=None,  # `application=None` will run ServeStatic in standalone mode.
+    root="/path/to/static/files",
+)
+```
+
+Now, use any webserver CLI to serve static files. Since this example uses ASGI, here is a sample command for `uvicorn` (a popular ASGI webserver):
+
+```
+uvicorn my_project:asgi_app
+```
+
+Visit the [documentation](https://archmonger.github.io/ServeStatic/) to get started, or learn more about `ServeStatic` .
 
 ## Frequently Asked Questions
 

{servestatic-4.3.3 → servestatic-4.3.4}/README.md

@@ -29,7 +29,28 @@ When using `ServeStatic`, best practices are automatically handled such as:
 - Proper handling of `Accept-Encoding` and `Vary` headers
 - Setting far-future cache headers for immutable static files.
 
-Visit the [documentation](https://archmonger.github.io/ServeStatic/) to get started or learn more about `ServeStatic` .
+
+## Quick Start
+
+Here is a short example of ASGI standalone mode:
+
+```python
+# filename: my_project.py
+from servestatic import ServeStaticASGI
+
+asgi_app = ServeStaticASGI(
+    application=None,  # `application=None` will run ServeStatic in standalone mode.
+    root="/path/to/static/files",
+)
+```
+
+Now, use any webserver CLI to serve static files. Since this example uses ASGI, here is a sample command for `uvicorn` (a popular ASGI webserver):
+
+```
+uvicorn my_project:asgi_app
+```
+
+Visit the [documentation](https://archmonger.github.io/ServeStatic/) to get started, or learn more about `ServeStatic` .
 
 ## Frequently Asked Questions
 

{servestatic-4.3.3 → servestatic-4.3.4}/src/servestatic/__init__.py

@@ -3,6 +3,6 @@ from __future__ import annotations
 from servestatic.asgi import ServeStaticASGI
 from servestatic.wsgi import ServeStatic
 
-__version__ = "4.3.3"
+__version__ = "4.3.4"
 
 __all__ = ["ServeStatic", "ServeStaticASGI"]

{servestatic-4.3.3 → servestatic-4.3.4}/src/servestatic/base.py

@@ -162,8 +162,15 @@ class ServeStaticBase:
         if getattr(self, "allow_unsafe_symlinks", False):
             return True
 
-        resolved_root = os.path.realpath(normalized_root)
-        resolved_path = os.path.realpath(normalized_path)
+        try:
+            resolved_root = os.path.realpath(normalized_root)
+            resolved_path = os.path.realpath(normalized_path)
+        except ValueError:
+            # A raw NUL byte (e.g. from a request path containing %00) survives
+            # normpath() but makes realpath() raise. Treat such a path as being
+            # outside the root (i.e. not found/forbidden) rather than letting an
+            # unhandled ValueError propagate and crash the request.
+            return False
         return self._path_is_within(resolved_root, resolved_path)
 
     @staticmethod