PyWSGIRef 1.0.2__tar.gz → 1.1.0__tar.gz

{pywsgiref-1.0.2/src/PyWSGIRef.egg-info → pywsgiref-1.1.0}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: PyWSGIRef
-Version: 1.0.2
-Summary: some tools for working with GitHub
+Version: 1.1.0
+Summary: easy server-setup
 Author-email: Leander Kafemann <leander@kafemann.berlin>
 Project-URL: Homepage, https://github.com/LeanderKafemann/PyWSGIRef
 Classifier: Programming Language :: Python :: 3
@@ -12,6 +12,7 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: requests
 Requires-Dist: typing
+Requires-Dist: legacy-cgi
 Dynamic: license-file
 
 # PyWSGIRef
@@ -59,6 +60,29 @@ server.serve_forever()
 The <code>makeWSGIApp</code> function requires a callable that takes a single argument (the path) and returns a string response.<br/>
 The <code>makeWSGIServer</code> function creates a WSGI server that listens on the specified port (default is 8000)<br/>
 and calls the application object with the environ.<br/>
+You may also specify advanced options in <code>makeWSGIApp</code>:<br/>
+- you can set the <code>advanced</code> parameter to <code>True</code>, so that your application method also gets an FieldStorage type object<br/>
+- you can set the <code>setAdvancedHeaders</code> parameter to <code>True</code>, so that the application method is also able to set status codes and types in the response headers,<br/>
+  which is only possible if the <code>advanced</code> parameter is set to <code>True</code><br/>
+Example:
+```python
+from PyWSGIRef import *
+
+# Create a WSGI application object with advanced options
+def advanced_app(path: str, form: FieldStorage) -> str, str, str:
+	# You can access form data here
+	name = str(form.getvalue('name'))
+	
+	if path == "/hello":
+		return f"Hello, {name}, you visited {path}!", "text/html", "200 OK"
+	else:
+		return "Page not found", "text/html", "404 Not Found"
+application = makeWSGIApp(advanced_app, advanced=True, setAdvancedHeaders=True)
+
+# Create a WSGI server
+server = makeWSGIServer(application, port=8000)
+server.serve_forever()
+```
 You can also use your own application object instead of the one created by <code>makeWSGIApp</code>.
 ### Loading PyHTML
 PyWSGIRef also provides a simple way to load PyHTML files:
@@ -102,7 +126,7 @@ addSchablone("error", ERROR)
 ### __main__ script
 You may produce a simple WSGI server by using either:<br/>
 ```python
-from PyWSGIRef import *
+from PyWSGIRef import main
 
 main()
 ```
@@ -110,9 +134,13 @@ or (from a commandline)
 ```bash
 py -m PyWSGIRef
 ```
+### Decoding PyHTML
+coming soon...
 ### Others
 Use the following to get information about your release and the author of the module:
 ```python
-pycols.about()
+from PyWSGIRef import about
+
+about()
 ```
 ### More coming soon

{pywsgiref-1.0.2 → pywsgiref-1.1.0}/README.md

@@ -43,6 +43,29 @@ server.serve_forever()
 The <code>makeWSGIApp</code> function requires a callable that takes a single argument (the path) and returns a string response.<br/>
 The <code>makeWSGIServer</code> function creates a WSGI server that listens on the specified port (default is 8000)<br/>
 and calls the application object with the environ.<br/>
+You may also specify advanced options in <code>makeWSGIApp</code>:<br/>
+- you can set the <code>advanced</code> parameter to <code>True</code>, so that your application method also gets an FieldStorage type object<br/>
+- you can set the <code>setAdvancedHeaders</code> parameter to <code>True</code>, so that the application method is also able to set status codes and types in the response headers,<br/>
+  which is only possible if the <code>advanced</code> parameter is set to <code>True</code><br/>
+Example:
+```python
+from PyWSGIRef import *
+
+# Create a WSGI application object with advanced options
+def advanced_app(path: str, form: FieldStorage) -> str, str, str:
+	# You can access form data here
+	name = str(form.getvalue('name'))
+	
+	if path == "/hello":
+		return f"Hello, {name}, you visited {path}!", "text/html", "200 OK"
+	else:
+		return "Page not found", "text/html", "404 Not Found"
+application = makeWSGIApp(advanced_app, advanced=True, setAdvancedHeaders=True)
+
+# Create a WSGI server
+server = makeWSGIServer(application, port=8000)
+server.serve_forever()
+```
 You can also use your own application object instead of the one created by <code>makeWSGIApp</code>.
 ### Loading PyHTML
 PyWSGIRef also provides a simple way to load PyHTML files:
@@ -86,7 +109,7 @@ addSchablone("error", ERROR)
 ### __main__ script
 You may produce a simple WSGI server by using either:<br/>
 ```python
-from PyWSGIRef import *
+from PyWSGIRef import main
 
 main()
 ```
@@ -94,9 +117,13 @@ or (from a commandline)
 ```bash
 py -m PyWSGIRef
 ```
+### Decoding PyHTML
+coming soon...
 ### Others
 Use the following to get information about your release and the author of the module:
 ```python
-pycols.about()
+from PyWSGIRef import about
+
+about()
 ```
 ### More coming soon

{pywsgiref-1.0.2 → pywsgiref-1.1.0}/pyproject.toml

@@ -1,10 +1,10 @@
 [project]
 name = "PyWSGIRef"
-version = "1.0.2"
+version = "1.1.0"
 authors = [
   {name="Leander Kafemann", email="leander@kafemann.berlin" },
 ]
-description = "some tools for working with GitHub"
+description = "easy server-setup"
 readme = "README.md"
 requires-python = ">=3.11"
 classifiers = [
@@ -15,6 +15,7 @@ classifiers = [
 dependencies = [
     "requests",
     "typing",
+    "legacy-cgi",
 ]
 
 [project.urls]

pywsgiref-1.1.0/src/PyWSGIRef/__init__.py

@@ -0,0 +1,128 @@
+"""
+PYWSGIREF
+"""
+from typing import Callable
+import requests
+from wsgiref.simple_server import make_server, WSGIServer
+from cgi import FieldStorage
+
+from .exceptions import *
+from .pyhtml import PyHTML
+from .defaults import *
+from .templateDict import TemplateDict, OneWayBoolean
+
+def about():
+    """
+    Returns information about your release and other projects by LK
+    """
+    return {"Version":(1, 1, 0), "Author":"Leander Kafemann", "date":"08.06.2025",\
+            "recommend":("Büro by LK",  "pyimager by LK"), "feedbackTo": "leander@kafemann.berlin"}
+
+SCHABLONEN = TemplateDict()
+finished = OneWayBoolean()
+
+def loadFromWeb(url: str, data: dict = {}) -> str:
+    """
+    Loads content from the given URL with the given data.
+    """
+    if finished.value:
+        raise ServerAlreadyGeneratedError()
+    if not url.endswith(".pyhtml"):
+        raise InvalidFiletypeError()
+    rq = requests.post(url, data).content
+    return rq.decode()
+
+def loadFromFile(filename: str) -> str:
+    """
+    Loads a file from the given filename.
+    """
+    if finished.value:
+        raise ServerAlreadyGeneratedError()
+    if not filename.endswith(".pyhtml"):
+        raise InvalidFiletypeError()
+    with open(filename, "r", encoding="utf-8") as f:
+        content = f.read()
+    return content
+
+def addSchablone(name: str, content: str):
+    """
+    Adds a template to the SCHABLONEN dictionary.
+    """
+    global SCHABLONEN
+    if finished.value:
+        raise ServerAlreadyGeneratedError()
+    SCHABLONEN[name] = PyHTML(content)
+
+def makeApplicationObject(contentGeneratingFunction: Callable, advanced: bool = False, setAdvancedHeaders: bool = False) -> Callable:
+    """
+    Returns a WSGI application object based on your contentGeneratingFunction.
+    The contentGeneratingFunction should take a single argument (the path) and return the content as a string.
+    If advanced is True, the contentGeneratingFunction will receive a FieldStorage object as the second argument.
+    If setAdvancedHeaders is True, it will allow you to set advanced headers for the response.
+    """
+    if not callable(contentGeneratingFunction):
+        raise InvalidCallableError()
+    def simpleApplication(environ, start_response) -> list:
+        """
+        A simple WSGI application object that serves as a template.
+        """
+        type_ = "text/html" 
+        status = "200 OK"
+        if advanced:
+            storage = FieldStorage(fp=environ.get("wsgi.input"), environ=environ, keep_blank_values=True)
+            if setAdvancedHeaders:
+                content, type_, status = contentGeneratingFunction(environ["PATH_INFO"], storage)
+            else:
+                content = contentGeneratingFunction(environ["PATH_INFO"], storage)
+        else:
+            if setAdvancedHeaders:
+                raise AdvancedHeadersWithoutAdvancedModeError()
+            content = contentGeneratingFunction(environ["PATH_INFO"])
+        headers = [("Content-Type", type_),
+                   ("Content-Length", str(len(content))),
+                   ('Access-Control-Allow-Origin', '*')]
+        start_response(status, headers)
+        return [content.encode("utf-8")]
+    return simpleApplication
+
+def setUpServer(application: Callable, port: int = 8000) -> WSGIServer:
+    """
+    Creates a WSGI server.
+    No additional Schablonen can be loaded from the web.
+    """
+    finished.set_true()
+    server = make_server('', 8000, application)
+    return server
+
+def main():
+    """
+    Main function to set up and run the PyWSGIRef server.
+    """
+    # add Schablone 'Hallo Welt' as main
+    addSchablone("main", MAIN_HTML)
+
+    # set up application object
+    def contentGenerator(path: str) -> str:
+        """
+        Serves as the main WSGI application.
+        """
+        match path:
+            case "/":
+                content = SCHABLONEN["main"].decoded().format(about()["Version"])
+            case "/hello":
+                content = HELLO_WORLD
+            case _:
+                content = ERROR
+        return content
+
+    # make the application object
+    application = makeApplicationObject(contentGenerator)
+
+    # set up server
+    server = setUpServer(application)
+
+    # Note: This code is intended to be run as a script, not as a module.
+    print("Successfully started WSGI server on port 8000.")
+
+    # start serving
+    server.serve_forever()

pywsgiref-1.1.0/src/PyWSGIRef/__main__.py

@@ -0,0 +1,7 @@
+"""
+Set up and run the PyWSGIRef server with a simple HTML response.
+"""
+from PyWSGIRef import main
+
+if __name__ == "__main__":
+    main()

pywsgiref-1.1.0/src/PyWSGIRef/defaults.py

@@ -0,0 +1,28 @@
+HELLO_WORLD = """<!DOCTYPE html>
+<html lang"de">
+    <body>
+        <h1>Hallo Welt!</h1>
+    </body>
+<html>"""
+
+ERROR = """<!DOCTYPE html>
+<html lang"de">
+    <body>
+        <h1>Fehler!</h1>
+        <p>Es ist ein Fehler aufgetreten.</p>
+    </body>
+</html>"""
+
+MAIN_HTML = """<!DOCTYPE html>
+    <html lang="de">
+        <head>
+            <meta charset="UTF-8">
+            <meta name="viewport" content="width=device-width, initial-scale=1.0">
+            <title>PyWSGIRef Server</title>
+        </head>
+        <body>
+            <h1>Willkommen zum PyWSGIRef Server!</h1>
+            <p>Dies ist die Hauptseite des Servers.</p>
+            <p>Sie nutzen Version {} von PyWSGIRef.</p>
+        </body>
+    </html>"""

{pywsgiref-1.0.2 → pywsgiref-1.1.0}/src/PyWSGIRef/exceptions.py

@@ -20,5 +20,13 @@ class InvalidCallableError(Exception):
     Raised when a callable is expected but not provided.
     """
     def __init__(self, message="Expected a callable object."):
+        self.message = message
+        super().__init__(self.message)
+
+class AdvancedHeadersWithoutAdvancedModeError(Exception):
+    """
+    Raised when advanced headers are set without advanced mode being enabled.
+    """
+    def __init__(self, message="Advanced headers cannot be set without enabling advanced mode."):
         self.message = message
         super().__init__(self.message)

pywsgiref-1.1.0/src/PyWSGIRef/templateDict.py

@@ -0,0 +1,51 @@
+from .exceptions import ServerAlreadyGeneratedError
+from .pyhtml import PyHTML
+
+class TemplateDict:
+	def __init__(self):
+		self.dictionary = {}
+		self.locked = OneWayBoolean()
+
+	def __getitem__(self, key: str) -> PyHTML:
+		return self.dictionary[key]
+
+	def __setitem__(self, key: str, value: PyHTML):
+		if not isinstance(value, PyHTML):
+			raise TypeError("Value must be an instance of PyHTML.")
+		if not isinstance(key, str):
+			raise TypeError("Key must be a string.")
+		if self.locked.value:
+			raise ServerAlreadyGeneratedError("Cannot modify TemplateDict after it has been locked.")
+		self.dictionary[key] = value
+
+	def __contains__(self, key: str):
+		return key in self.dictionary
+
+	def __repr__(self):
+		return f"TemplateDict({self.dictionary})"
+
+	def keys(self) -> list:
+		return list(self.dictionary.keys())
+
+	def values(self) -> list:
+		return list(self.dictionary.values())
+
+	def items(self) -> list:
+		return list(self.dictionary.items())
+
+class OneWayBoolean:
+	def __init__(self):
+		self.value = False
+
+	@property
+	def value(self) -> bool:
+		return self.value
+
+	def set_true(self):
+		"""
+		Setzt den Wert auf True, wenn er False ist.
+		"""
+		if not self.value:
+			self.value = True
+		else:
+			raise ValueError("Value is already True, cannot set again.")

{pywsgiref-1.0.2 → pywsgiref-1.1.0/src/PyWSGIRef.egg-info}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: PyWSGIRef
-Version: 1.0.2
-Summary: some tools for working with GitHub
+Version: 1.1.0
+Summary: easy server-setup
 Author-email: Leander Kafemann <leander@kafemann.berlin>
 Project-URL: Homepage, https://github.com/LeanderKafemann/PyWSGIRef
 Classifier: Programming Language :: Python :: 3
@@ -12,6 +12,7 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: requests
 Requires-Dist: typing
+Requires-Dist: legacy-cgi
 Dynamic: license-file
 
 # PyWSGIRef
@@ -59,6 +60,29 @@ server.serve_forever()
 The <code>makeWSGIApp</code> function requires a callable that takes a single argument (the path) and returns a string response.<br/>
 The <code>makeWSGIServer</code> function creates a WSGI server that listens on the specified port (default is 8000)<br/>
 and calls the application object with the environ.<br/>
+You may also specify advanced options in <code>makeWSGIApp</code>:<br/>
+- you can set the <code>advanced</code> parameter to <code>True</code>, so that your application method also gets an FieldStorage type object<br/>
+- you can set the <code>setAdvancedHeaders</code> parameter to <code>True</code>, so that the application method is also able to set status codes and types in the response headers,<br/>
+  which is only possible if the <code>advanced</code> parameter is set to <code>True</code><br/>
+Example:
+```python
+from PyWSGIRef import *
+
+# Create a WSGI application object with advanced options
+def advanced_app(path: str, form: FieldStorage) -> str, str, str:
+	# You can access form data here
+	name = str(form.getvalue('name'))
+	
+	if path == "/hello":
+		return f"Hello, {name}, you visited {path}!", "text/html", "200 OK"
+	else:
+		return "Page not found", "text/html", "404 Not Found"
+application = makeWSGIApp(advanced_app, advanced=True, setAdvancedHeaders=True)
+
+# Create a WSGI server
+server = makeWSGIServer(application, port=8000)
+server.serve_forever()
+```
 You can also use your own application object instead of the one created by <code>makeWSGIApp</code>.
 ### Loading PyHTML
 PyWSGIRef also provides a simple way to load PyHTML files:
@@ -102,7 +126,7 @@ addSchablone("error", ERROR)
 ### __main__ script
 You may produce a simple WSGI server by using either:<br/>
 ```python
-from PyWSGIRef import *
+from PyWSGIRef import main
 
 main()
 ```
@@ -110,9 +134,13 @@ or (from a commandline)
 ```bash
 py -m PyWSGIRef
 ```
+### Decoding PyHTML
+coming soon...
 ### Others
 Use the following to get information about your release and the author of the module:
 ```python
-pycols.about()
+from PyWSGIRef import about
+
+about()
 ```
 ### More coming soon

{pywsgiref-1.0.2 → pywsgiref-1.1.0}/src/PyWSGIRef.egg-info/SOURCES.txt

@@ -6,6 +6,7 @@ src/PyWSGIRef/__main__.py
 src/PyWSGIRef/defaults.py
 src/PyWSGIRef/exceptions.py
 src/PyWSGIRef/pyhtml.py
+src/PyWSGIRef/templateDict.py
 src/PyWSGIRef.egg-info/PKG-INFO
 src/PyWSGIRef.egg-info/SOURCES.txt
 src/PyWSGIRef.egg-info/dependency_links.txt

{pywsgiref-1.0.2 → pywsgiref-1.1.0}/src/PyWSGIRef.egg-info/requires.txt

@@ -1,2 +1,3 @@
 requests
 typing
+legacy-cgi

pywsgiref-1.0.2/src/PyWSGIRef/__init__.py

@@ -1,82 +0,0 @@
-"""
-PYWSGIREF
-"""
-from typing import Callable
-import requests
-from wsgiref.simple_server import make_server, WSGIServer
-
-from .exceptions import *
-from .pyhtml import PyHTML
-from .defaults import *
-from .__main__ import main
-
-def about():
-    """
-    Returns information about your release and other projects by LK
-    """
-    return {"Version":(1, 0, 2), "Author":"Leander Kafemann", "date":"07.06.2025",\
-            "recommend":("Büro by LK",  "pyimager by LK"), "feedbackTo": "leander@kafemann.berlin"}
-
-SCHABLONEN = {}
-finished = False
-
-def loadFromWeb(url: str, data: dict = {}) -> str:
-    """
-    Loads content from the given URL with the given data.
-    """
-    if finished:
-        raise ServerAlreadyGeneratedError()
-    if not url.endswith(".pyhtml"):
-        raise InvalidFiletypeError()
-    rq = requests.post(url, data).content
-    return rq.decode()
-
-def loadFromFile(filename: str) -> str:
-    """
-    Loads a file from the given filename.
-    """
-    if finished:
-        raise ServerAlreadyGeneratedError()
-    if not filename.endswith(".pyhtml"):
-        raise InvalidFiletypeError()
-    with open(filename, "r", encoding="utf-8") as f:
-        content = f.read()
-    return content
-
-def addSchablone(name: str, content: str):
-    """
-    Adds a template to the SCHABLONEN dictionary.
-    """
-    global SCHABLONEN
-    SCHABLONEN[name] =  PyHTML(content)
-
-def makeApplicationObject(contentGeneratingFunction: Callable) -> Callable:
-    """
-    Returns a WSGI application object based on your contentGeneratingFunction.
-    The contentGeneratingFunction should take a single argument (the path) and return the content as a string.
-    """
-    if not callable(contentGeneratingFunction):
-        raise InvalidCallableError()
-    def simpleApplication(environ, start_response) -> list:
-        """
-        A simple WSGI application object that serves as a template.
-        """
-        type_ = "text/html" 
-        status = "200 OK"
-        content = contentGeneratingFunction(environ["PATH_INFO"])
-        headers = [("Content-Type", type_),
-                   ("Content-Length", str(len(content))),
-                   ('Access-Control-Allow-Origin', '*')]
-        start_response(status, headers)
-        return [content.encode("utf-8")]
-    return simpleApplication
-
-def setUpServer(application: Callable) -> WSGIServer:
-    """
-    Creates a WSGI server.
-    No additional Schablonen can be loaded from the web.
-    """
-    global finished
-    finished = True
-    server = make_server('', 8000, application)
-    return server

pywsgiref-1.0.2/src/PyWSGIRef/__main__.py

@@ -1,55 +0,0 @@
-"""
-Set up and run the PyWSGIRef server with a simple HTML response.
-"""
-from PyWSGIRef import *
-
-def main():
-    """
-    Main function to set up and run the PyWSGIRef server.
-    """
-    # define main html response
-    MAIN_HTML = """<!DOCTYPE html>
-    <html lang="de">
-        <head>
-            <meta charset="UTF-8">
-            <meta name="viewport" content="width=device-width, initial-scale=1.0">
-            <title>PyWSGIRef Server</title>
-        </head>
-        <body>
-            <h1>Willkommen zum PyWSGIRef Server!</h1>
-            <p>Dies ist die Hauptseite des Servers.</p>
-            <p>Sie nutzen Version {} von PyWSGIRef.</p>
-        </body>
-    </html>"""
-
-    # add Schablone 'Hallo Welt' as main
-    addSchablone("main", MAIN_HTML)
-
-    # set up application object
-    def contentGenerator(path: str) -> str:
-        """
-        Serves as the main WSGI application.
-        """
-        match path:
-            case "/":
-                content = SCHABLONEN["main"].decoded().format(about()["Version"])
-            case "/hello":
-                content = HELLO_WORLD
-            case _:
-                content = ERROR
-        return content
-
-    # make the application object
-    application = makeApplicationObject(contentGenerator)
-
-    # set up server
-    server = setUpServer(application)
-
-    # Note: This code is intended to be run as a script, not as a module.
-    print("Successfully started WSGI server on port 8000.")
-
-    # start serving
-    server.serve_forever()
-
-if __name__ == "__main__":
-    main()

pywsgiref-1.0.2/src/PyWSGIRef/defaults.py

@@ -1,14 +0,0 @@
-HELLO_WORLD = """<!DOCTYPE html>
-<html lang"de">
-    <body>
-        <h1>Hallo Welt!</h1>
-    </body>
-<html>"""
-
-ERROR = """<!DOCTYPE html>
-<html lang"de">
-    <body>
-        <h1>Fehler!</h1>
-        <p>Es ist ein Fehler aufgetreten.</p>
-    </body>
-</html>"""