underscorepy 0.9.0__py3-none-any.whl

_/supports/nginx/__init__.py

@@ -0,0 +1,78 @@
+#
+# (c) 2015-2024 Matthew Shaw
+#
+# Authors
+# =======
+# Matthew Shaw <mshaw.cx@gmail.com>
+#
+
+import logging
+import os
+
+import _
+
+
+class Nginx(_.supports.Support):
+    async def init(self, component_name, **kwds):
+        self.params = dict(
+            root        = _.paths(),
+            ns          = _.ns,
+            name        = _.name,
+            web_root    = '/var/www/html',
+            address     = '127.0.0.1',
+            port        = 8080,
+            listen_ip4  = '0.0.0.0',
+            listen_ip6  = '[::]',
+            listen_http = 80,
+            listen_ssl  = 443,
+            conf_path   = '/etc/nginx/sites-available/{server_name}',
+            )
+
+        self.params.update(dict(_.config[_.name]))
+        try:
+            self.params.update(dict(_.config[component_name]))
+        except KeyError:
+            pass
+        self.params.update(kwds)
+
+        try:
+            _.argparser.add_argument(f'--nginx',
+                metavar='<server_name>', default=0, nargs='?',
+                help='install nginx config'
+                )
+        except:
+            raise _.error('Multiple nginx supports detected: %s', component_name) from None
+
+    async def args(self, component_name):
+        if _.args.nginx == 0:
+            return
+
+        name = _.args.nginx if _.args.nginx else _.name
+
+        if 'server_name' not in self.params:
+            self.params['server_name'] = name
+
+        conf = _.paths(f'{name}.conf')
+        if not os.path.exists(conf):
+            conf = os.path.join(self.root, 'nginx', 'nginx.conf')
+        logging.debug('Loading configuration: %s', conf)
+
+        try:
+            with open(conf, 'r') as fp:
+                conf = fp.read()
+            try:
+                conf = conf.format(**self.params)
+            except KeyError as e:
+                raise _.error('Missing nginx configuration file parameter: %s', e) from None
+
+            path = self.params['conf_path'].format(**self.params)
+            with open(path, 'w') as fp:
+                fp.write(conf)
+        except _.error:
+            raise
+        except Exception as e:
+            raise _.error('Could not write nginx configuration: %s', e) from None
+
+        logging.info('Installed nginx configuration: %s', name)
+
+        _.application.stop()

_/supports/nginx/nginx.conf

@@ -0,0 +1,59 @@
+
+upstream frontends {{
+    server {address}:{port};
+}}
+
+server {{
+    listen {listen_ip4}:{listen_http};
+    listen {listen_ip6}:{listen_http};
+    server_name {server_name};
+    return 301 https://$server_name$request_uri;
+}}
+
+server {{
+    server_name {server_name};
+    listen {listen_ip4}:{listen_ssl} ssl;
+    listen {listen_ip6}:{listen_ssl} ssl;
+    root {web_root};
+    index index.html;
+
+    ssl_certificate /etc/letsencrypt/live/{server_name}/fullchain.pem;
+    ssl_certificate_key /etc/letsencrypt/live/{server_name}/privkey.pem;
+    ssl_prefer_server_ciphers on;
+    ssl_ciphers ECDH+AESGCM:ECDH+AES256:ECDH+AES128:DH+3DES:!ADH:!AECDH:!MD5;
+
+    location ^~ /static/ {{
+        root /var/www;
+        if ($query_string) {{
+            expires max;
+        }}
+    }}
+
+    location = /favicon.ico {{
+        rewrite (.*) /static/favicon.ico;
+    }}
+
+    location = /robots.txt {{
+        rewrite (.*) /static/robots.txt;
+    }}
+
+    location /ws {{
+        proxy_http_version 1.1;
+        proxy_set_header Upgrade $http_upgrade;
+        proxy_set_header Connection "upgrade";
+        proxy_read_timeout 1h;
+        proxy_send_timeout 1h;
+        proxy_set_header X-Real-IP $remote_addr;
+        proxy_set_header X-Scheme $scheme;
+        proxy_pass http://frontends;
+    }}
+
+    location / {{
+        proxy_pass_header Server;
+        proxy_set_header Host $http_host;
+        proxy_redirect off;
+        proxy_set_header X-Real-IP $remote_addr;
+        proxy_set_header X-Scheme $scheme;
+        proxy_pass http://frontends;
+    }}
+}}

_/supports/systemd/__init__.py

@@ -0,0 +1,60 @@
+#
+# (c) 2015-2023 Matthew Shaw
+#
+# Authors
+# =======
+# Matthew Shaw <mshaw.cx@gmail.com>
+#
+
+import logging
+import os
+import sys
+
+import _
+
+
+class Systemd(_.supports.Support):
+    async def init(self, component_name, **kwds):
+        self.params = dict(
+            ns        = _.ns,
+            name      = _.name,
+            cmdline   = f'{os.path.abspath(sys.argv[0])}',
+            user      = os.environ.get('USER', 'nobody'),
+            conf_path = '/etc/systemd/system/{name}.service',
+            )
+
+        self.params.update(kwds)
+
+        _.argparser.add_argument(f'--systemd',
+            metavar='<user>', default=0, nargs='?',
+            help='install systemd service'
+            )
+
+    async def args(self, component_name):
+        if _.args.systemd == 0:
+            return
+
+        if _.args.systemd:
+            self.params['user'] = _.args.systemd
+
+        # set name to the value from params
+        name = self.params.get('name')
+
+        with open(os.path.join(self.root, 'systemd', 'systemd.service'), 'r') as fp:
+            conf = fp.read()
+
+        try:
+            conf = conf.format(**self.params)
+        except KeyError as e:
+            raise _.error('Missing systemd parameter: %s', e)
+
+        path = self.params['conf_path'].format(**self.params)
+        try:
+            with open(path, 'w') as fp:
+                fp.write(conf)
+        except Exception as e:
+            raise _.error('Could not write systemd service: %s: %s', name, e) from None
+
+        logging.info('Installed systemd service: %s', name)
+
+        _.application.stop()

_/supports/systemd/systemd.service

@@ -0,0 +1,12 @@
+[Unit]
+Description={name}
+After=network.target
+
+[Service]
+Type=simple
+ExecStart={cmdline}
+User={user}
+Restart=on-failure
+
+[Install]
+WantedBy=multi-user.target

_/test.py

@@ -0,0 +1,20 @@
+#
+# (c) 2024 Matthew Shaw
+#
+# Authors
+# =======
+# Matthew Shaw <mshaw.cx@gmail.com>
+#
+
+import logging
+
+import _
+
+
+class TestApplication(_.WebApplication):
+    async def __listen(self, patterns, **kwds):
+        '''call the Tornado Application init here to give children a chance
+           to initialize patterns and settings'''
+        logging.info('Would be listening on %s:%d', _.args.address, _.args.port)
+
+_.Application = TestApplication

_/utils.py

@@ -0,0 +1,85 @@
+#
+# (c) 2015-2024 Matthew Shaw
+#
+# Authors
+# =======
+# Matthew Shaw <mshaw.cx@gmail.com>
+#
+
+import asyncio
+import base64
+import datetime
+import json
+import inspect
+import logging
+import os
+import time
+import uuid
+
+import tornado.web
+
+import _
+
+
+# alias so handlers don't have to import tornado.web directly
+HTTPError = tornado.web.HTTPError
+
+# return the current time in milliseconds
+now = lambda: int(time.time() * 1000)
+
+# add a prefix to dictionary names
+prefix = lambda kwds,prepend='_': dict((f'{prepend}{k}',v) for k,v in kwds.items())
+
+# pass _.function as a filter to the all function
+function = type(lambda: None)
+
+
+async def wait(result):
+    '''wait on coroutines or return result of non-coroutines'''
+    try:
+        return result if not asyncio.iscoroutine(result) else await result
+    except Exception as e:
+        if _.args.debug:
+            trace = []
+            for f in inspect.stack()[:0:-1]:
+                if not f.code_context:
+                    continue
+                context = '\n'.join(c.strip() for c in f.code_context)
+                msg = f'  File "{f.filename}", line {f.lineno}, in {f.function}\n    {context}'
+                trace.append(msg)
+            logging.exception(f'Unhandled exception:\n%s', '\n'.join(trace))
+        raise
+
+
+class Paths:
+    def __init__(self, root, ns=None):
+        self.root = root
+        self.ns   = ns
+
+    def __call__(self, *args):
+        if self.ns is None:
+            return os.path.join(self.root, *args)
+        else:
+            return os.path.join(self.root, self.ns, *args)
+
+    # support / as a path joiner
+    def __truediv__(self, other):
+        return Paths(self(other))
+
+    def __str__(self):
+        return self()
+
+
+class JSONEncoder(json.JSONEncoder):
+    def default(self, obj):
+        if hasattr(obj, '_as_dict'):
+            return obj._as_dict()
+        if isinstance(obj, bytes):
+            return base64.b64encode(obj).decode('ascii')
+        if isinstance(obj, uuid.UUID):
+            return str(obj)
+        if isinstance(obj, datetime.datetime):
+            return str(obj)
+        return json.JSONEncoder.default(self, obj)
+
+json._default_encoder = JSONEncoder()

_/version.py

@@ -0,0 +1,5 @@
+__author__    = 'Matthew Shaw'
+__email__     = 'mshaw.cx@gmail.com'
+__copyright__ = '(c)2015-2024, Matthew Shaw'
+__license__   = 'MIT'
+__version__   = '0.9.0'

_/websockets.py

@@ -0,0 +1,57 @@
+#
+# (c) 2015-2023 Matthew Shaw
+#
+# Authors
+# =======
+# Matthew Shaw <mshaw.cx@gmail.com>
+#
+
+import tornado.websocket
+
+import _
+
+
+class WebSocket(tornado.websocket.WebSocketHandler):
+    '''Tweak the default WebSocket behavior for more responsive behavior'''
+    websockets = {}
+
+    def initialize(self, websockets=None):
+        if websockets is not None:
+            self.websockets = websockets
+
+    def check_origin(self, origin):
+        if _.args.debug:
+            return True
+        # TODO: let app specify origin policy
+        return True
+
+    def open(self):
+        self.set_nodelay(True)
+        self.websockets[id(self)] = self
+
+    def on_close(self):
+        self.websockets.pop(id(self), None)
+
+
+class Protected(WebSocket):
+    '''Require a valid user session to establish WebSocket connection'''
+
+    async def prepare(self):
+        self.session_id = self.get_signed_cookie('session_id')
+        if not self.session_id:
+            raise _.HTTPError(403)
+        self.session_id = self.session_id.decode('utf-8')
+
+        self.session = await _.wait(_.sessions.load_session(self.session_id))
+        if not self.session:
+            raise _.HTTPError(403)
+
+
+class EchoMixin:
+    '''Reflect incoming messages to all other connected WebSockets'''
+
+    def on_message(self, msg):
+        for ws in self.websockets.values():
+            if ws is self:
+                continue
+            ws.write_message(msg)

underscorepy-0.9.0.dist-info/METADATA

@@ -0,0 +1,85 @@
+Metadata-Version: 2.4
+Name: underscorepy
+Version: 0.9.0
+Summary: _.py library
+Author-email: Matthew Shaw <mshaw.cx@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://shaw.cx/_.py
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: tornado>=6.3
+Requires-Dist: sqlalchemy[asyncio]>=2
+Provides-Extra: postgres
+Requires-Dist: asyncpg; extra == "postgres"
+Provides-Extra: sqlite
+Requires-Dist: aiosqlite; extra == "sqlite"
+Provides-Extra: redis
+Requires-Dist: redis>=5.0.1; extra == "redis"
+Provides-Extra: protobuf
+Requires-Dist: protobuf>=5.26; extra == "protobuf"
+Provides-Extra: ldap
+Requires-Dist: python-ldap; extra == "ldap"
+Provides-Extra: migrations
+Requires-Dist: alembic; extra == "migrations"
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: aiosqlite; extra == "test"
+Requires-Dist: alembic; extra == "test"
+Provides-Extra: all
+Requires-Dist: underscorepy[ldap,migrations,postgres,protobuf,redis,sqlite]; extra == "all"
+Dynamic: license-file
+
+
+underscore.py
+-------------
+
+```INI
+[myapp]
+address = 0.0.0.0
+port    = 8080
+```
+
+```Python
+import _
+import _.websockets
+
+class Echo(_.websockets.WebSocket):
+    def on_message(self, msg):
+        print('Echo:', msg)
+        self.write_message(msg)
+
+class MyApp(_.Application):
+    def initialize(self):
+        self.patterns = [
+            ( r'/ws',       Echo                ),
+            ( r'/([a-z]*)', _.handlers.Template ),
+            ]
+
+MyApp.main()
+```
+
+Look at the skeleton directory for a more complete example application.
+
+Schema changes
+--------------
+
+Tables for records are created when the database is empty. After that, each
+start compares the models (for example your `.proto` messages) with the
+database and refuses to run if they differ:
+
+```
+ERROR    Database "store" differs from the schema:
+  ALTER TABLE "Reports_multiple" ADD COLUMN _position INTEGER
+Run with --store-migrate to apply them
+```
+
+`--<database>-migrate` applies changes that can't lose data. Drops and type
+changes are printed as SQL to run by hand. This needs `alembic`
+(`pip install underscorepy[migrations]`); set `check_schema = false` in the
+database's section to skip the check.

underscorepy-0.9.0.dist-info/RECORD

@@ -0,0 +1,39 @@
+_/__init__.py,sha256=O8CiMeB2BlfNq0-ZCRXIAkmJby91V15F9EvUr_QuGQ4,907
+_/application.py,sha256=9iDLHMtDk24CA4ItuNBkK1gsQjr8etkDBY6LRgu8v-o,9505
+_/auth.py,sha256=7PxD7Kwr5oqNn-c4Id_xJUGKmYgvfHl9vJCdxfaT7do,5501
+_/components.py,sha256=BX0rVbQvHBqjh3ge8ibc6R4S2ZM0oxFNrqwZgjrqyWk,2995
+_/handlers.py,sha256=wLTwPFXbeznyQ9SoRr_uOZRvfgEikSmnCFtVaSR0Q5g,1239
+_/settings.py,sha256=sw0aD2ZTzSqQoPPrgQ35PzagsN_p3Xl63cRjAF0tyvM,4594
+_/test.py,sha256=0I5aeeDbnH7t5o4lytMZLOTeN8K5n6_gmOlX35tsxHk,443
+_/utils.py,sha256=k8GQn6HxFFXAF4vTdmN_zYDnzLFvX4HXqNwSENWYBkc,2172
+_/version.py,sha256=VhvZmSQKhnrWLCBNjnZ9Y-0MdiaQjur-7eWuAd3QVzA,159
+_/websockets.py,sha256=Ayp_2IK4125V_oJnyRVeIzkqnMxJcUFizduoO9JSviU,1427
+_/caches/__init__.py,sha256=6XPB4pTSj_fzXaJfbr0FV5JcKmCIhJdyS_gxHS5nHwM,1152
+_/caches/dbcache.py,sha256=N_a8EOPLJ_vpaQ-oPEum_LvbrIkS0RC4Q37aUY5irRs,4953
+_/caches/memory.py,sha256=HAnJcM6nyfsYaH3zXC7TpZdDjRHjqNPWj9Uywg8yUaA,2340
+_/caches/redis.py,sha256=OAhzTvRq0CM3WkhNG0j5VIAD8LFIQorv6sH1x8Ktwt4,3315
+_/databases/__init__.py,sha256=HpZohhzko7-Tut1uS9HapdSX1igWru7oPUykRq6D5CI,10377
+_/databases/postgres.py,sha256=-7nulRmjmrp0BL-xPd2GtgiTTcAvhI6unTfJAcXOdQY,866
+_/databases/sqlite.py,sha256=M_YEGh3-WRqO439ZModZzlv0yy_uw4qe7aGBdqroVzo,2213
+_/logins/__init__.py,sha256=vWvFPo5e5IdKP_YTDZlWfX0C4QgvvvoziZul48qY-UE,2978
+_/logins/dblogin.py,sha256=a0XsPKX0z4UE6HXd9LHMXmJSQvBFoothAOZpgyTjxUY,7597
+_/logins/facebook.py,sha256=fMVLOMfwjt8-zYwi-uBnr0fRIEluLwGY7RgFRIv-Wk8,1136
+_/logins/gitlab.py,sha256=VTHklbKlTiapo5L1WOzKrGKG1zrzdo7TFKNY_hXAFTk,1614
+_/logins/google.py,sha256=1VM6Xexv3MFnbtzLAiihGUMv29B9MjKjysaSTpKKHN0,365
+_/logins/htpasswd.py,sha256=CLZEsMs86zs5cK7EIOA3Mq6xf0b9v7Z80pTloqgoSe4,1098
+_/logins/oauth2.py,sha256=z64-wDsGlDRqBZOpJhKLY58u0mEYt1KmU74P_T_RioQ,1683
+_/logins/slap.py,sha256=Mnoa0SD7fbCRXHOP3OHlQcVhXhFfFAKslFyM-vj9w88,1471
+_/records/Protobuf.proto,sha256=QOSY73vLWExLKhtn_bh8OYir8w5zfic6iZ-gnmQH9-s,489
+_/records/__init__.py,sha256=Ec-q9Z3XsIN2yhnrb7VWf4T4HnUtJ6MwR_UBghrP_uE,5477
+_/records/data.py,sha256=VsZAV1V5CsYWFqSgxD4DEz95Ywhp-U-YiLv4780wozE,8149
+_/records/protobuf.py,sha256=FYr86VDXJvJ1l27Tk1ED-oIDm6Spcs5a85QPTevWAc4,18998
+_/supports/__init__.py,sha256=x49qm_0Usm7EWaUeif4lctq2PwSiRmHlvtWVGPG9byg,532
+_/supports/nginx/__init__.py,sha256=40utmYxt8DiJ_siVaM0WabvvkL84PLc-es7homXLn-4,2282
+_/supports/nginx/nginx.conf,sha256=eZYQA8KllYyPfUE42BTmsJ3qQDzaCg53m1SZREOEZ3o,1546
+_/supports/systemd/__init__.py,sha256=YIzmN1FErqiZJFzlMQoWH7DcCW5WAgmzFzSPz4axNmg,1578
+_/supports/systemd/systemd.service,sha256=bmV0gogbZrmm72OiKQPFn9qQPdZM4M5yiYKtphALm74,159
+underscorepy-0.9.0.dist-info/licenses/LICENSE,sha256=9W6z5DdvUR1RWcwCfZOd3JJV-bj0WMAmQxd0RiqMAUY,1085
+underscorepy-0.9.0.dist-info/METADATA,sha256=eCQFKnb19hZJ33RafWVYLzC1lO9AIfGAQvIgNxVZQNY,2466
+underscorepy-0.9.0.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+underscorepy-0.9.0.dist-info/top_level.txt,sha256=RBW342H8b2uiSSre8fJ8-wDQEF5FiBd0cM7MQhSzUoQ,2
+underscorepy-0.9.0.dist-info/RECORD,,

underscorepy-0.9.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.2.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

underscorepy-0.9.0.dist-info/licenses/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015-2023 Matthew Shaw
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

underscorepy-0.9.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+_