PoorWSGI 2.6.1__tar.gz → 2.7.0__tar.gz

{PoorWSGI-2.6.1 → poorwsgi-2.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PoorWSGI
-Version: 2.6.1
+Version: 2.7.0
 Summary: Poor WSGI connector for Python
 Home-page: http://poorhttp.zeropage.cz/poorwsgi
 Author: Ondřej Tůma

{PoorWSGI-2.6.1 → poorwsgi-2.7.0}/PoorWSGI.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PoorWSGI
-Version: 2.6.1
+Version: 2.7.0
 Summary: Poor WSGI connector for Python
 Home-page: http://poorhttp.zeropage.cz/poorwsgi
 Author: Ondřej Tůma

{PoorWSGI-2.6.1 → poorwsgi-2.7.0}/PoorWSGI.egg-info/SOURCES.txt

@@ -2,8 +2,6 @@ CONTRIBUTION.rst
 MANIFEST.in
 README.rst
 setup.py
-test_hidden.py
-websockets_chat_async.py
 PoorWSGI.egg-info/PKG-INFO
 PoorWSGI.egg-info/SOURCES.txt
 PoorWSGI.egg-info/dependency_links.txt
@@ -26,8 +24,6 @@ doc/licence.txt
 doc/small-logo.png
 doc/style.css
 doc/web.css
-examples/async.py
-examples/encoding.py
 examples/http_digest.py
 examples/large_file.py
 examples/metrics.py
@@ -40,6 +36,7 @@ examples/test.digest
 examples/websocket.py
 poorwsgi/__init__.py
 poorwsgi/digest.py
+poorwsgi/fieldstorage.py
 poorwsgi/headers.py
 poorwsgi/openapi_wrapper.py
 poorwsgi/py.typed

{PoorWSGI-2.6.1 → poorwsgi-2.7.0}/doc/ChangeLog

@@ -1,3 +1,26 @@
+==== 2.7.0 ====
+    * Reserved Request.db attribute for usage
+    * Right HTTPException type annotation
+    * Fix ETag header
+    * FieldStorage and FieldStorageParser implementation based on legacy
+      cgi.FieldStorage (#22)
+        - that means Python 3.13 support (#36)
+    * Stop Python 3.8 support - some mypy annotation didn't work
+    * Field refactoring - ! possible break change ! - sorry for that
+        - FieldStorageInterface - getvalue, getfist, getlist methods
+        - new func converter name, and no default converter
+        - all default values are not convert now
+    * Some old classes, functions, attributes and parameters are notified
+      as deprecated, and will be deleted in next major version.
+    * Automatic JSONResponse from dict or list, just like from text.
+    * Debug info, documentation and Error improvements.
+    * Automatic NoContentResponse from None (#28)
+
+==== 2.6.3 ====
+    * HTTPException has status_code property
+    * Implicit value for not set cookie is None or empty dict for OpenAPI
+    * Fix Content-Length header when partial Response
+
 ==== 2.6.1 ====
     * Fix OpenAPI Core wrappers
 

{PoorWSGI-2.6.1 → poorwsgi-2.7.0}/doc/_footer.html

@@ -2,7 +2,7 @@
         <div class="line"></div>
         <div class="credit">
             Create by Ondřej Tůma (<a href="http://ipv6.mcbig.cz">McBig</a>).
-            &copy; 2020. Generate by
+            &copy; 2024. Generate by
             <a href="http://poorhttp.zeropage.cz/jinja24doc.html">Jinja24doc</a>.
         </div>
       </div>

{PoorWSGI-2.6.1 → poorwsgi-2.7.0}/doc/_poorwsgi_api.html

@@ -4,9 +4,11 @@
 {% set api = api + load_module('wsgi') %}
 {% set api = api + load_module('request') %}
 {% set api = api + load_module('response') %}
-{% set api = api + load_module('results') %}
+{% set api = api + load_module('headers') %}
+{% set api = api + load_module('fieldstorage') %}
 {% set api = api + load_module('session') %}
 {% set api = api + load_module('digest') %}
+{% set api = api + load_module('results') %}
 {% set api = api + load_module('state') %}
 {% set api = api + load_module('openapi_wrapper') %}
 

{PoorWSGI-2.6.1 → poorwsgi-2.7.0}/doc/documentation.rst

@@ -106,8 +106,15 @@ make_response function.
                       headers=None, status_code=HTTP_OK)
 
 
-data : str, bytes, generator
-    Returned value as response body.
+data : str, bytes, dict, list, None or generator
+    Returned value as response body. Each type of data returns different
+    response type:
+
+        - str, bytes - Response
+        - dict, list - JSONResponse
+        - None - NoContentReponse
+        - generator - GeneratorResponse
+
 content_type : str
     The ``Content-Type`` header which is set, if this header is not set
     in headers.
@@ -122,11 +129,28 @@ You can use headers instead of `content_type` argument.
 .. code:: python
 
     @app.http_state(NOT_FOUND)
-    def not_found(req):
+    def not_found(req, *_):
         return make_response(b'Page not Found',
                              headers={"Content-Type": "text/plain"},
                              status_code=NOT_FOUND)
 
+If you return just simple type, or tuple of arguments, PoorWSGI automatically
+call make_response function to create response for you.
+
+.. code:: python
+
+    @app.route("/json")
+    def not_found(req):
+        """Return JSONResponse"""
+        return {"msg": "Message", "type": "object"}
+
+
+    @app.route('/gone')
+    def gone(req):
+        """Return NoContentResponse"""
+        return None, "", None, HTTP_GONE
+
+
 Response
 ````````
 Response object is one of base element of WSGI application. Response is object
@@ -167,6 +191,27 @@ This response returned these data with status code 418:
         "numbers": [0, 1, 2, 3, 4]
     }
 
+Or you can simple return dictionary or list. It will be automatically convert
+to JSONResponse by make_response function. So it is similar to return text or
+bytes.
+
+Be careful that your dict or list **have to be convertible** to JSON by
+json.dumps function.
+
+.. code:: python
+
+    @app.route('/dict')
+    def get_dict(_):
+        """Return dictionary"""
+        return {"route": "/dict", "type": "dict"}
+
+    @app.route('/list')
+    def get_list(_):
+        """Return list"""
+        return [["key", "value"], ["route", "/list"], ["type", "list"]]
+
+
+
 JSONGeneratorResponse
 `````````````````````
 There is JSONGeneratorResponse class too, which could return JSON, but
@@ -249,7 +294,7 @@ parameters or as constructor argument.
                 return NotModifiedResponse(date=time_to_http())
 
         return FileResponse(req.document_root+"/filename",
-                            headers={'E-Tag': etag})
+                            headers={'ETag': etag})
 
 Partial Content
 ```````````````
@@ -501,18 +546,20 @@ or METHOD_HEAD.
 
 HTTP state handlers
 ~~~~~~~~~~~~~~~~~~~
-There are some predefined HTTP state handlers, which is use when other
+There are some predefined HTTP state handlers, which are use when other
 HTTP state are raised via HTTPException or any other exception which ends with
 HTTP_INTERNAL_SERVER_ERROR status code.
 
 You can redefined your own handlers for any combination of status code and
-method type like routes handlers. Responsing from these handlers are same as in
+method type like routes handlers. Response from these handlers are same as in
 route handlers.
 
+Be sure, that some http_state handlers can add other keyword arguments.
+
 .. code:: python
 
     @app.http_state(state.HTTP_NOT_FOUND)
-    def page_not_found(req):
+    def page_not_found(req, *_):
         return "Your request %s not found." % req.path, "text/plain"
 
 If your http state (error) handler was crashed with error, internal server
@@ -617,7 +664,7 @@ poor_AutoArgs is set to On, which is default.
     @app.route('/test/get')
     def test_get(req)
         name = req.args.getfirst('name')
-        colors = req.args.getlist('color', fce=int)
+        colors = req.args.getlist('color', func=int)
         return "Get arguments are %s" % str(req.args)
 
 If no arguments are parsed, or if poor_AutoArgs is set to Off, req.args is
@@ -625,16 +672,16 @@ EmptyForm instance, which is dict base class too with both of methods.
 
 Form arguments
 ~~~~~~~~~~~~~~
-Request form areguments are stored to FieldStorage class, define in
-poorwsgi.request module. This class is based on FieldStorage from standard
-cgi module. And variables are parsed every time, when poor_AutoForm is set to
-On, which is default, request method is POST, PUT or PATCH and request
+Request form arguments are stored in FieldStorage class, define in
+poorwsgi.fieldstorage module. This class is inspired by FieldStorage from
+legacy cgi module. Variables are parsed every time, when poor_AutoForm is set
+to On, which is default, request method is POST, PUT or PATCH and request
 mime type is one of `Application.form_mime_types`. You can call it
 on any other methods of course, but it must exist wsgi.input in request
 environment from wsgi server.
 
 req.form instance is create with poor_KeepBlankValues and poor_StrictParsing
-variables as Args class is create, but FieldStorage have file_callback
+variables as Args class is create, but FieldStorageParser have file_callback
 variable, which is configurable by Application.file_callback property.
 
 .. code:: python
@@ -645,7 +692,7 @@ variable, which is configurable by Application.file_callback property.
                                              # is convert to number with zero
                                              # as default
         name = req.form.getfirst('name')
-        colors = req.form.getlist('color', fce=int)
+        colors = req.form.getlist('color', func=int)
         return "Post arguments for id are %s" % (id, str(req.args))
 
 As like Args class, if poor_AutoForm is set to Off, or if method is no POST,
@@ -705,14 +752,13 @@ There are a few variants which req.json could be:
 
 File uploading
 ~~~~~~~~~~~~~~
-By default, python's FieldStorage, so poorwsgi.FieldStorage too, store files
-somewhere to ``/tmp`` directory. This is happened in FieldStorage, which calls
-``TemporaryFile``. Uploaded files are accessible like another form variables,
-but.
+By default, FieldStorage store files somewhere to ``/tmp`` directory. This is
+happened in FieldStorageParser, which calls ``TemporaryFile``. Uploaded files
+are accessible like another form variables, but.
 
 Any variables from FieldStorage is accessible with ``__getitem__`` method.
 So you can get variable by ``req.form[key]``, which gets FieldStorage
-instance. This instance has some another variables, which you can test,
+instance. This instance has some attributes, which you can test,
 what type of variable is it.
 
 .. code:: python
@@ -742,16 +788,16 @@ Application.file_callback property.
 As you can see, this example works, but it is so bad solution of your problem.
 Little bit better solution will be, if you store files only if exist and only
 to special separate dictionary, which could be configurable. That you need use
-factory to create file_callback. In next example is write own form parsering,
-which is not important, when `file_callback` could be set via Application
-property.
+to factory to create file_callback. In next example is written own form
+processing, which is not important, when `file_callback` could be set via
+Application property.
 
 .. code:: python
 
     from io import FileIO
     from os.path import exists
 
-    from poorwsgi import Application, state, request
+    from poorwsgi import Application, state, fieldstorage
 
     app = Application('test')
 
@@ -783,19 +829,21 @@ property.
         if req.method_number == state.METHOD_POST:
             factory = StorageFactory('./upload')
             try:
-                req.form = request.FieldStorage(
-                    req,
+                parser = FieldStorageParser(
+                    req.input, req.heades,
                     keep_blank_values=app.keep_blank_values,
                     strict_parsing=app.strict_parsing,
                     file_callback=factory.create)
+                req.form = parser.parser()
             except Exception as e:
                 req.log_error(e)
 
 CachedInput
 ~~~~~~~~~~~
 
-When HTTP Forms are base64 encoded, FieldStorage use readline on request input
-file. This is not so optimal. So there is CachedInput class, which is returned 
+When HTTP Forms are base64 encoded, FieldStorageParser use readline on request
+input file. This is not so optimal. So there is CachedInput class, which
+is returned as wrapper around ``wsgi.input`` file.
 
 Proccess variables
 ~~~~~~~~~~~~~~~~~~
@@ -818,14 +866,14 @@ If auto_form is set to ``True``, which is default, Request object parse input
 arguments from request body at initialisation when request type is POST, PUT
 or PATCH. There will be ``Request.form`` property which is instance of
 ``FieldStorage`` class. If you want to off this functionality, set this property
-to ``False``. If form parsing is disabled, or json is detected, ``Request.form``
+to ``False``. If form parsing is disabled, or JSON is detected, ``Request.form``
 will be instance of ``EmptyForm`` with same interface and no data.
 
 Application.form_mime_types
 ``````````````````````````````
-List of mime types, which is paresed as input form by ``FieldStorage`` class.
-If input request does not have set one of these mime types, that form was not
-parsed.
+List of mime types, which is parsed as input form by ``FieldStorageParser``
+class. If input request does not have set one of these mime types, that form
+will not be parsed.
 
 Application.file_callback
 `````````````````````````
@@ -848,15 +896,15 @@ If input request does not have set one of these mime types, that
 Application.keep_blank_values
 `````````````````````````````
 This property is set for input parameters to automatically calling Args and
-FieldStorage classes, when auto_args resp. auto_form is set. By default this
-property is set to ``0``. If it set to ``1``, blank values should be interpret
-as empty strings.
+FieldStorageParser classes, when auto_args resp. auto_form is set. By default
+this property is set to ``0``. If it set to ``1``, blank values should be
+interpret as empty strings.
 
 Application.strict_parsing
 ``````````````````````````
 This property is set for input parameter to automatically calling Args and
-FieldStorage classes. when auto_args resp. auto_form is set. By default this
-variable is set to ``0``. If is set to ``1``, ValueError exception
+FieldStorageParser classes. When auto_args resp. auto_form is set. By default
+this variable is set to ``0``. If is set to ``1``, ValueError exception
 could raise on parsing error. I'm sure, that you never want to set this
 variable to ``1``. If so, use it in your own parsing.
 
@@ -878,10 +926,11 @@ variable to ``1``. If so, use it in your own parsing.
 
         if req.method_number == state.METHOD_POST:
             try:
-                req.form = request.FieldStorage(
-                    req,
+                parser = fieldstorage.FieldStorageParser(
+                    req.input, req.headers,
                     keep_blank_values=app.keep_blank_values,
                     strict_parsing=app.strict_parsing)
+                req.form = parser.parse()
             except Exception as e:
                 logging.error("Bad request body: %s", e)
 
@@ -894,7 +943,7 @@ empty tupple will be set.
 
 Application / User options
 --------------------------
-Like in mod_python Request, Poor WSGI Request have get_options method too.
+Like in mod_python Request, Poor WSGI Application have get_options method too.
 This method return dictionary of application options or variables, which start
 with ``app_`` prefix. This prefix is cut from options names.
 
@@ -910,18 +959,11 @@ And you can get these variables with get_options method:
 
 .. code:: python
 
-    config = None
-
-    @app.before_response()
-    def load_options(req):
-        global config
-        if config is None:
-            config = req.get_options()
-        req.config = config
+    config = app.get_options()
 
     @app.route('/options')
     def list_options(req):
-        return ("%s = %s" % (key, val) in req.config.items())
+        return ("%s = %s" % (key, val) in config.items())
 
 Output of application url /options looks like:
 
@@ -931,13 +973,15 @@ Output of application url /options looks like:
     tmp_path = tmp
     templ = templ
 
-As you can see, you can store your variables to request object. There are few
-reserved variables for you, which poorwsgi never use, and which are None by
-default:
+You can store your variables to request object too. There are few reserved
+variables for you, which poorwsgi never use, and which are None by default:
 
-:req.config: for your config object
-:req.user:   for user object, who is login
-:req.app\_:  as prefix for any your application variable
+:req.user:   For user object, who is login, check_digest decorator set this
+             variable.
+:req.api:    For API checking. OpenAPIRequest use this variable.
+:req.db:     For single database conection per request. You can store structure
+             with more databases if you need to this vairable.
+:req.app\_:  As prefix for any your application variable.
 
 So if you want to add any other variable, be careful to named it.
 
@@ -1030,7 +1074,7 @@ Application.secret_key property.
     @app.route('/login', method=state.METHOD_GET_POST)
     def login(req):
         if req.method == 'POST':
-            passwd = req.form.getfirst('passwd', fce=str)
+            passwd = req.form.getfirst('passwd', func=str)
             if passwd != 'SecretPasswds':
                 log.info('Bad password')
                 redirect('/login', text='Bad password')

poorwsgi-2.7.0/examples/http_digest.py

@@ -0,0 +1,200 @@
+"""HTTP WWW-Authenticate Digest Example."""
+import logging
+from hashlib import sha256
+from os import path
+from sys import path as python_path
+from time import time
+from wsgiref.simple_server import make_server
+
+python_path.insert(
+    0, path.abspath(path.join(path.dirname(__file__), path.pardir)))
+
+# pylint: disable=wrong-import-position
+from poorwsgi import Application, state  # noqa
+from poorwsgi.digest import PasswordMap, check_digest, hexdigest  # noqa
+from poorwsgi.response import EmptyResponse, redirect  # noqa
+
+FILE = path.join(path.dirname(__file__), 'test.digest')
+
+logging.getLogger().setLevel("DEBUG")
+app = application = Application(__name__)  # pylint: disable=invalid-name
+# application = app
+app.debug = True
+app.secret_key = sha256(str(time()).encode()).hexdigest()
+# app.auth_algorithm = 'SHA-256-sess'
+app.auth_type = 'Digest'
+app.auth_timeout = 60
+
+ADMIN = 'Admin Zone'
+USER = 'User Zone'
+# user/looser, foo/bar, admin/admin, Ondřej/heslíčko
+app.auth_map = PasswordMap(FILE)
+app.auth_map.load()
+
+# pylint: disable=unused-argument
+
+
+def get_header(title):
+    """Return HTML header list of lines."""
+    return (
+        "<html>", "<head>",
+        '<meta http-equiv="content-type" content="text/html; charset=utf-8"/>',
+        f"<title>{__file__} - {title}</title>", "</head>", "<body>",
+        f"<h1>{__file__} - {title}</h1>")
+
+
+def get_footer():
+    """Return HTML footer list of lines."""
+    return ("<hr>", "<small>Copyright (c) 2020 Ondřej Tůma. See ",
+            '<a href="http://poorhttp.zeropage.cz">poorhttp.zeropage.cz</a>'
+            '</small>.', "</body>", "</html>")
+
+
+def get_link(href, text=None, title=None):
+    """Return HTML anchor."""
+    text = text or title or href
+    title = title or text
+    return f'<a href="{href}" title="{title}">{text}</a>'
+
+
+@app.route('/')
+def root(req):
+    """Return Root (Index) page."""
+    body = ('<ul>', "<li>" + get_link('/admin_zone') +
+            " - admin zone (admin/admin)</li>", "<li>" +
+            get_link('/user_zone') + " - user zone (user/looser;sha/sha)</li>",
+            "<li>" + get_link('/user') + " - user (user/looser)</li>", "<li>" +
+            get_link('/user/utf-8') + " - utf-8 (Ondřej/heslíčko)</li>",
+            "<li>" + get_link('/foo') + " - foo (foo/bar)</li>",
+            "<li>" + get_link('/unknown') + " - unknown</li>",
+            "<li>" + get_link('/spaces in url') + " - spaces in url</li>",
+            "<li>" + get_link('/čeština v url') + " - diacitics in url</li>",
+            "<li>" + get_link('/crazy in url 🤪') + " - unicode in url</li>",
+            '</ul>')
+
+    for line in get_header("Root") + body + get_footer():
+        yield line.encode() + b'\n'
+
+
+@app.route('/admin_zone')
+@check_digest(ADMIN)
+def admin_zone(req):
+    """Page only for ADMIN realm."""
+    body = (f'<h2>{ADMIN} test for {app.auth_algorithm} algorithm.</h2>',
+            '<ul>', '<li>' + get_link('/', 'Root') + '</li>',
+            '<li>' + get_link('/admin_zone?arg=42', 'one more time') + '</li>',
+            '</ul>')
+
+    for line in get_header("Root") + body + get_footer():
+        yield line.encode() + b'\n'
+
+
+@app.route('/user_zone')
+@check_digest(USER)
+def user_zone(req):
+    """Page for USER realm."""
+    body = (f'<h2>{USER} test for {app.auth_algorithm} algorithm.</h2>',
+            f'User: {req.user}', '<ul>',
+            '<li>' + get_link('/', 'Root') + '</li>', '<li>' +
+            get_link('/user_zone?param=text', 'one more time') + '</li>',
+            '</ul>')
+
+    for line in get_header("Root") + body + get_footer():
+        yield line.encode() + b'\n'
+
+
+@app.route('/user')
+@check_digest(USER, 'user')
+def user_only(req):
+    """Page for user only."""
+    body = (f'<h2>User test for {app.auth_algorithm} algorithm.</h2>',
+            f'User: {req.user}', '<ul>',
+            '<li>' + get_link('/', 'Root') + '</li>', '<li>' +
+            get_link('/user?param=1234', 'one more time') + '</li>', '</ul>')
+
+    for line in get_header("Root") + body + get_footer():
+        yield line.encode() + b'\n'
+
+
+@app.route('/foo')
+@check_digest(USER, 'foo')
+def foo_only(req):
+    """Page for foo user only."""
+    body = (f'<h2>Foo test for {app.auth_algorithm} algorithm.</h2>',
+            f'User: {req.user}', '<ul>', '<li>' + get_link('/', 'Root') +
+            '</li>', '</ul>', '<form method="post" action="/foo/passwd">',
+            '<label>Enter new password:',
+            '<input type="password" name="password"/>', '</label>',
+            '<button type="submit">Change Password</button>', '</form>')
+
+    for line in get_header("Root") + body + get_footer():
+        yield line.encode() + b'\n'
+
+
+@app.route('/user/utf-8')
+@check_digest(USER, 'Ondřej')
+def utf8_chars(req):
+    """Page for user only."""
+    body = (f'<h2>User test for {app.auth_algorithm} algorithm.</h2>',
+            f'User: {req.user}', '<ul>',
+            '<li>' + get_link('/', 'Root') + '</li>', '<li>' +
+            get_link('/user/utf-8?param=1234', 'one more time') + '</li>',
+            '</ul>')
+
+    for line in get_header("Root") + body + get_footer():
+        yield line.encode() + b'\n'
+
+
+@app.route('/foo/passwd', method=state.METHOD_POST)
+@check_digest(USER, 'foo')
+def foo_password(req):
+    """Change foo's password."""
+    digest = hexdigest(req.user, USER, req.form.get('password'), app.auth_hash)
+    app.auth_map.set(USER, req.user, digest)
+    redirect('/foo')
+
+
+@app.route('/unknown')
+@check_digest(USER, 'unknown')
+def unknown_endpoint(req):
+    """Page for digest test."""
+    return EmptyResponse()
+
+
+def generic_response(url, user):
+    """Return generic response"""
+    body = (f'<h2>{USER} test for {app.auth_algorithm} algorithm.</h2>',
+            f'User: {user}', '<ul>', '<li>' + get_link('/', 'Root') + '</li>',
+            '<li>' + get_link(url + '?param=text', 'one more time') + '</li>',
+            '</ul>')
+
+    for line in get_header("Root") + body + get_footer():
+        yield line.encode() + b'\n'
+
+
+@app.route('/spaces in url')
+@check_digest(USER)
+def spaces_in_url(req):
+    """URL with spaces in path."""
+    return generic_response(req.path, req.user)
+
+
+@app.route('/čeština v url')
+@check_digest(USER)
+def diacritics_in_url(req):
+    """URL with diacritics in path."""
+    return generic_response(req.path, req.user)
+
+
+@app.route('/crazy in url 🤪')
+@check_digest(USER)
+def crazy_in_url(req):
+    """URL with unicode in path."""
+    return generic_response(req.path, req.user)
+
+
+if __name__ == '__main__':
+    # pylint: disable=invalid-name
+    httpd = make_server('127.0.0.1', 8080, app)
+    logging.info("Starting to serve on http://127.0.0.1:8080")
+    httpd.serve_forever()