yhttp-dbmanager 2.6.2__py3-none-any.whl

yhttp/ext/dbmanager/__init__.py

@@ -0,0 +1,8 @@
+# flake8: noqa
+from .cli import DatabaseCLI
+from .install import install
+from .dbmanager import PostgresqlManager
+from .uri import DatabaseURI
+
+
+__version__ = '2.6.2'

yhttp/ext/dbmanager/cli.py

@@ -0,0 +1,86 @@
+import os
+import functools
+import getpass
+
+from easycli import SubCommand, Argument
+
+from . import dbmanager
+from .uri import DatabaseURI
+
+
+getdbpass = functools.partial(getpass.getpass, 'Enter db password: ')
+
+
+DEFAULT_DBUSER = os.environ['USER']
+
+
+class DatabaseAdministrativeCommand(SubCommand):
+    __arguments__ = [
+        Argument(
+            '-H',
+            '--host',
+            default=os.environ.get('YHTTP_DB_DEFAULT_HOST', ''),
+            help='DB hostname, default: empty.'
+        ),
+        Argument('-d', '--database', default='postgres', help='DB name'),
+        Argument(
+            '-u',
+            '--user',
+            default=os.environ.get(
+                'YHTTP_DB_DEFAULT_ADMINUSER',
+                DEFAULT_DBUSER
+            ),
+            help=f'DB administrator username, default: ${DEFAULT_DBUSER}'
+        ),
+        Argument(
+            '-p', '--password',
+            nargs='?',
+            default=os.environ.get(
+                'YHTTP_DB_DEFAULT_ADMINPASS',
+                'postgres'
+            ),
+            help='DB administrator password'
+        ),
+    ]
+
+    def getdbmanager(self, args):
+        password = args.password or getdbpass()
+
+        return dbmanager.PostgresqlManager(
+            user=args.user,
+            password=password,
+            host=args.host,
+            dbname=args.database
+        )
+
+    def getappdbinfo(self, args):
+        dbsettings = args.application.settings.db
+        url = DatabaseURI.loads(dbsettings.url)
+        return url
+
+
+class CreateDatabase(DatabaseAdministrativeCommand):
+    __command__ = 'create'
+    __aliases__ = ['c']
+
+    def __call__(self, args):
+        uri = self.getappdbinfo(args)
+        self.getdbmanager(args).create(uri.dbname, owner=uri.user)
+
+
+class DropDatabase(DatabaseAdministrativeCommand):
+    __command__ = 'drop'
+    __aliases__ = ['d']
+
+    def __call__(self, args):
+        uri = self.getappdbinfo(args)
+        self.getdbmanager(args).drop(uri.dbname)
+
+
+class DatabaseCLI(SubCommand):
+    __command__ = 'database'
+    __aliases__ = ['db']
+    __arguments__ = [
+        CreateDatabase,
+        DropDatabase
+    ]

yhttp/ext/dbmanager/dbmanager.py

@@ -0,0 +1,75 @@
+import abc
+
+import psycopg2
+from psycopg2.extensions import ISOLATION_LEVEL_AUTOCOMMIT
+
+
+class DatabaseManager(metaclass=abc.ABCMeta):
+
+    @abc.abstractmethod
+    def execute(self, query):  # pragma: no cover
+        pass
+
+    @abc.abstractmethod
+    def create(self, name, owner=None, dropifexists=False):  # pragma: no cover
+        pass
+
+    @abc.abstractmethod
+    def drop(self, name):  # pragma: no cover
+        pass
+
+    @abc.abstractmethod
+    def exists(self, name):  # pragma: no cover
+        pass
+
+    @abc.abstractmethod
+    def dropifexists(self, name):  # pragma: no cover
+        pass
+
+
+class PostgresqlManager(DatabaseManager):
+
+    def __init__(self, host=None, dbname='postgres', user=None, password=None):
+        self.connection = psycopg2.connect(
+            host=host,
+            dbname=dbname,
+            user=user,
+            password=password
+        )
+        self.connection.set_isolation_level(ISOLATION_LEVEL_AUTOCOMMIT)
+
+    def execute(self, query):
+        cursor = self.connection.cursor()
+        try:
+            cursor.execute(query)
+        finally:
+            cursor.close()
+
+    def exists(self, name):
+        query = f'SELECT 1 FROM pg_database WHERE datname=\'{name}\''
+
+        cursor = self.connection.cursor()
+        try:
+            cursor.execute(query)
+            r = cursor.fetchone()
+            if r:
+                return r[0] == 1
+            else:
+                return False
+        finally:
+            cursor.close()
+
+    def create(self, name, owner=None, dropifexists=False):
+        if dropifexists:
+            self.dropifexists(name)
+
+        query = f'CREATE DATABASE "{name}"' + \
+            (f' WITH OWNER {owner}' if owner else '')
+
+        self.execute(query)
+
+    def drop(self, name):
+        self.execute(f'DROP DATABASE "{name}"')
+
+    def dropifexists(self, name):
+        self.execute(f'DROP DATABASE IF EXISTS "{name}"')

yhttp/ext/dbmanager/install.py

@@ -0,0 +1,17 @@
+from .cli import DatabaseCLI
+
+
+def install(app, cliarguments=None):
+    app.cliarguments.append(DatabaseCLI)
+    if cliarguments:
+        DatabaseCLI.__arguments__.extend(cliarguments)
+
+    @app.when
+    def ready(app):
+        if 'db' not in app.settings:
+            raise ValueError(
+                'Please provide db.url configuration entry, for example: '
+                'postgres://:@/dbname'
+            )
+
+    return app

yhttp/ext/dbmanager/uri.py

@@ -0,0 +1,41 @@
+import re
+
+
+URIPATTERN = re.compile(
+    r'(?P<provider>.*)://(?P<user>.*):(?P<password>.*)@(?P<host>.*)/'
+    r'(?P<dbname>.*)'
+)
+
+
+class DatabaseURI:
+    def __init__(self, provider, dbname, host='', user='', password=''):
+        assert provider
+        assert dbname
+
+        self.provider = provider
+        self.host = host
+        self.dbname = dbname
+        self.user = user
+        self.password = password
+
+    def dumps(self):
+        return f'{self.provider}://{self.user}:{self.password}@{self.host}' \
+            f'/{self.dbname}'
+
+    @classmethod
+    def loads(cls, uri):
+        match = URIPATTERN.match(uri)
+        if not match:
+            raise ValueError(f'Invalid URI: {uri}')
+
+        u = match.groupdict()
+
+        assert u.get('provider')
+        assert u.get('dbname')
+        return cls(
+            u.get('provider'),
+            u.get('dbname'),
+            u.get('host'),
+            u.get('user'),
+            u.get('password'),
+        )

yhttp_dbmanager-2.6.2.dist-info/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 yhttp
+
+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.

yhttp_dbmanager-2.6.2.dist-info/METADATA

@@ -0,0 +1,69 @@
+Metadata-Version: 2.1
+Name: yhttp-dbmanager
+Version: 2.6.2
+Summary: Database manager command line interface and API for yhttp.
+Home-page: http://github.com/yhttp/yhttp-dbmanager
+Author: Vahid Mardani
+Author-email: vahid.mardani@gmail.com
+License: MIT
+Classifier: Environment :: Console
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: License :: Other/Proprietary License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Topic :: Software Development
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Classifier: Topic :: Internet :: WWW/HTTP :: WSGI :: Application
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: yhttp <5,>=3.5.2
+Requires-Dist: dbmanager
+Requires-Dist: psycopg2
+
+# Dependencies
+install `postgreslq` brefore use of this project.
+
+
+## Contribution
+
+### Prepare
+
+Create and grant `postgres` role with `createdb` permission:
+```bash
+echo "CREATE USER ${USER} WITH CREATEDB" | sudo -u postgres psql
+# Or
+echo "ALTER USER ${USER} CREATEDB" | sudo -u postgres psql
+```
+
+Create virtual environment:
+```bash
+make venv
+```
+
+Install this project as editable mode and all other development dependencies:
+```bash
+make env
+```
+
+### Tests
+Execute all tests:
+```bash
+make test
+```
+
+Execute all tests and report coverage result:
+```bash
+make cover
+make cover-html
+```
+
+### Virtualenv
+```bash
+source ./activate.sh
+```

yhttp_dbmanager-2.6.2.dist-info/RECORD

@@ -0,0 +1,10 @@
+yhttp/ext/dbmanager/__init__.py,sha256=cOlAL6XZpC4MEmc63_fWk4iLdLH-IY8O9fanJvZUhIE,167
+yhttp/ext/dbmanager/cli.py,sha256=MfmToDtHBuQH0HpQnIcGVplw1B8K628mh83VW7MLH54,2139
+yhttp/ext/dbmanager/dbmanager.py,sha256=ZXy5LhmFMqK1CkSMMlPVQp3-ecbt6MPHbQmiAJ4RAu8,1908
+yhttp/ext/dbmanager/install.py,sha256=fSNUqFknpP3ZficNjzlRlejEpxtf70OrOFh-yL-TMXY,431
+yhttp/ext/dbmanager/uri.py,sha256=CQdw_1yJwUwV67L3hQICA4ziKCDYb4E2Gqd4Y2Cc8-w,973
+yhttp_dbmanager-2.6.2.dist-info/LICENSE,sha256=1lZ7neh4Es6earhYMwYaqsuS1Alohsrf9GZRVdl7l5o,1062
+yhttp_dbmanager-2.6.2.dist-info/METADATA,sha256=cyCVZKIDoC0j4DBZSbOnY4o3Ve76M4Ut27CEdqRh8mo,1734
+yhttp_dbmanager-2.6.2.dist-info/WHEEL,sha256=R0nc6qTxuoLk7ShA2_Y-UWkN8ZdfDBG2B6Eqpz2WXbs,91
+yhttp_dbmanager-2.6.2.dist-info/top_level.txt,sha256=efaJ4DfUOs7MO3pjIEyRhnQASGVyD6vH-SL3ogQxkeU,6
+yhttp_dbmanager-2.6.2.dist-info/RECORD,,

yhttp_dbmanager-2.6.2.dist-info/WHEEL

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

yhttp_dbmanager-2.6.2.dist-info/top_level.txt

@@ -0,0 +1 @@
+yhttp