Starter code for chapter 10, using sqlalchemy.

Author: mikeckennedy

.gitignore

@@ -123,3 +123,11 @@ app/ch09_sqlalchmey/final/.idea/dataSources.local.xml
 app/ch09_sqlalchmey/final/.idea/dataSources/583a04da-ae18-4c33-bbf0-6a3e12d3db43.xml
 app/ch09_sqlalchmey/final/.idea/dataSources/8589e457-43bb-4280-ba68-787968d5cb61.xml
 app/ch09_sqlalchmey/final/pypi_org/db/pypi.sqlite
+app/ch09_sqlalchemy/final/.idea/dataSources.local.xml
+app/ch09_sqlalchemy/final/.idea/misc.xml
+app/ch09_sqlalchemy/final/.idea/modules.xml
+app/ch09_sqlalchemy/final/.idea/dataSources/583a04da-ae18-4c33-bbf0-6a3e12d3db43.xml
+app/ch09_sqlalchemy/final/.idea/dataSources/8589e457-43bb-4280-ba68-787968d5cb61.xml
+app/ch09_sqlalchemy/starter/.idea/misc.xml
+app/ch09_sqlalchemy/starter/.idea/modules.xml
+pypi.sqlite

app/ch10_using_sqlachemy/final/pypi_org/app.py

@@ -0,0 +1,35 @@
+import os
+
+import flask
+import pypi_org.data.db_session as db_session
+
+app = flask.Flask(__name__)
+
+
+def main():
+    register_blueprints()
+    setup_db()
+    app.run(debug=True)
+
+
+def setup_db():
+    db_file = os.path.join(
+        os.path.dirname(__file__),
+        'db',
+        'pypi.sqlite')
+
+    db_session.global_init(db_file)
+
+
+def register_blueprints():
+    from pypi_org.views import home_views
+    from pypi_org.views import package_views
+    from pypi_org.views import cms_views
+
+    app.register_blueprint(package_views.blueprint)
+    app.register_blueprint(home_views.blueprint)
+    app.register_blueprint(cms_views.blueprint)
+
+
+if __name__ == '__main__':
+    main()

app/ch10_using_sqlachemy/final/pypi_org/data/__all_models.py

@@ -0,0 +1,19 @@
+# Add all your SQLAlchemy models here.
+# This allows us to import just this file when
+# we need to preload the models and ensure they
+# are all loaded.
+
+# noinspection PyUnresolvedReferences
+import pypi_org.data.downloads
+# noinspection PyUnresolvedReferences
+import pypi_org.data.languages
+# noinspection PyUnresolvedReferences
+import pypi_org.data.licenses
+# noinspection PyUnresolvedReferences
+import pypi_org.data.maintainers
+# noinspection PyUnresolvedReferences
+import pypi_org.data.package
+# noinspection PyUnresolvedReferences
+import pypi_org.data.releases
+# noinspection PyUnresolvedReferences
+import pypi_org.data.users

app/ch10_using_sqlachemy/final/pypi_org/data/db_session.py

@@ -0,0 +1,27 @@
+import sqlalchemy as sa
+import sqlalchemy.orm as orm
+
+from pypi_org.data.modelbase import SqlAlchemyBase
+
+factory = None
+
+
+def global_init(db_file: str):
+    global factory
+
+    if factory:
+        return
+
+    if not db_file or not db_file.strip():
+        raise Exception("You must specify a db file.")
+
+    conn_str = 'sqlite:///' + db_file.strip()
+    print("Connecting to DB with {}".format(conn_str))
+
+    engine = sa.create_engine(conn_str, echo=False)
+    factory = orm.sessionmaker(bind=engine)
+
+    # noinspection PyUnresolvedReferences
+    import pypi_org.data.__all_models
+
+    SqlAlchemyBase.metadata.create_all(engine)

app/ch10_using_sqlachemy/final/pypi_org/data/downloads.py

@@ -0,0 +1,16 @@
+import datetime
+import sqlalchemy
+from pypi_org.data.modelbase import SqlAlchemyBase
+
+
+class Download(SqlAlchemyBase):
+    __tablename__ = 'downloads'
+
+    id = sqlalchemy.Column(sqlalchemy.BigInteger, primary_key=True, autoincrement=True)
+    created_date = sqlalchemy.Column(sqlalchemy.DateTime, default=datetime.datetime.now, index=True)
+
+    package_id = sqlalchemy.Column(sqlalchemy.String, index=True)
+    release_id = sqlalchemy.Column(sqlalchemy.BigInteger, index=True)
+
+    ip_address = sqlalchemy.Column(sqlalchemy.String)
+    user_agent = sqlalchemy.Column(sqlalchemy.String)

app/ch10_using_sqlachemy/final/pypi_org/data/languages.py

@@ -0,0 +1,11 @@
+import datetime
+import sqlalchemy
+from pypi_org.data.modelbase import SqlAlchemyBase
+
+
+class ProgrammingLanguage(SqlAlchemyBase):
+    __tablename__ = 'languages'
+
+    id = sqlalchemy.Column(sqlalchemy.String, primary_key=True)
+    created_date = sqlalchemy.Column(sqlalchemy.DateTime, default=datetime.datetime.now, index=True)
+    description = sqlalchemy.Column(sqlalchemy.String)

app/ch10_using_sqlachemy/final/pypi_org/data/licenses.py

@@ -0,0 +1,11 @@
+import datetime
+import sqlalchemy
+from pypi_org.data.modelbase import SqlAlchemyBase
+
+
+class License(SqlAlchemyBase):
+    __tablename__ = 'licenses'
+
+    id = sqlalchemy.Column(sqlalchemy.String, primary_key=True)
+    created_date = sqlalchemy.Column(sqlalchemy.DateTime, default=datetime.datetime.now, index=True)
+    description = sqlalchemy.Column(sqlalchemy.String)

app/ch10_using_sqlachemy/final/pypi_org/data/maintainers.py

@@ -0,0 +1,9 @@
+import sqlalchemy
+from pypi_org.data.modelbase import SqlAlchemyBase
+
+
+class Maintainer(SqlAlchemyBase):
+    __tablename__ = 'maintainers'
+
+    user_id = sqlalchemy.Column(sqlalchemy.Integer, primary_key=True)
+    package_id = sqlalchemy.Column(sqlalchemy.String, primary_key=True)

app/ch10_using_sqlachemy/final/pypi_org/data/modelbase.py

@@ -0,0 +1,3 @@
+import sqlalchemy.ext.declarative as dec
+
+SqlAlchemyBase = dec.declarative_base()

app/ch10_using_sqlachemy/final/pypi_org/data/package.py

@@ -0,0 +1,43 @@
+import datetime
+from typing import List
+
+import sqlalchemy as sa
+import sqlalchemy.orm as orm
+from pypi_org.data.modelbase import SqlAlchemyBase
+from pypi_org.data.releases import Release
+
+
+class Package(SqlAlchemyBase):
+    __tablename__ = 'packages'
+
+    id = sa.Column(sa.String, primary_key=True)
+    created_date = sa.Column(sa.DateTime, default=datetime.datetime.now, index=True)
+    summary = sa.Column(sa.String, nullable=False)
+    description = sa.Column(sa.String, nullable=True)
+
+    home_page = sa.Column(sa.String)
+    docs_url = sa.Column(sa.String)
+    package_url = sa.Column(sa.String)
+
+    author_name = sa.Column(sa.String)
+    author_email = sa.Column(sa.String, index=True)
+
+    license = sa.Column(sa.String, index=True)
+
+    # releases relationship
+    releases: List[Release] = orm.relation("Release", order_by=[
+        Release.major_ver.desc(),
+        Release.minor_ver.desc(),
+        Release.build_ver.desc(),
+    ], back_populates='package')
+
+    def __repr__(self):
+        return '<Package {}>'.format(self.id)
+
+
+# p = Package()  # one query
+#
+# print(p.id)
+# print("All releases")
+# for r in p.releases:
+#     print("{}.{}.{}".format(r.major_ver, r.minor_ver, r.build_ver))

app/ch10_using_sqlachemy/final/pypi_org/data/releases.py

@@ -0,0 +1,29 @@
+import datetime
+import sqlalchemy
+import sqlalchemy.orm as orm
+from pypi_org.data.modelbase import SqlAlchemyBase
+
+
+class Release(SqlAlchemyBase):
+    __tablename__ = 'releases'
+
+    id = sqlalchemy.Column(sqlalchemy.Integer, primary_key=True, autoincrement=True)
+
+    major_ver = sqlalchemy.Column(sqlalchemy.BigInteger, index=True)
+    minor_ver = sqlalchemy.Column(sqlalchemy.BigInteger, index=True)
+    build_ver = sqlalchemy.Column(sqlalchemy.BigInteger, index=True)
+
+    created_date = sqlalchemy.Column(sqlalchemy.DateTime, default=datetime.datetime.now, index=True)
+    comment = sqlalchemy.Column(sqlalchemy.String)
+    url = sqlalchemy.Column(sqlalchemy.String)
+    size = sqlalchemy.Column(sqlalchemy.BigInteger)
+
+    # Package relationship
+    package_id = sqlalchemy.Column(sqlalchemy.String, sqlalchemy.ForeignKey("packages.id"))
+    package = orm.relation('Package')
+
+    @property
+    def version_text(self):
+        return '{}.{}.{}'.format(self.major_ver, self.minor_ver, self.build_ver)
+
+

app/ch10_using_sqlachemy/final/pypi_org/data/users.py

@@ -0,0 +1,15 @@
+import datetime
+import sqlalchemy
+from pypi_org.data.modelbase import SqlAlchemyBase
+
+
+class User(SqlAlchemyBase):
+    __tablename__ = 'users'
+
+    id = sqlalchemy.Column(sqlalchemy.Integer, primary_key=True, autoincrement=True)
+    name = sqlalchemy.Column(sqlalchemy.String, nullable=True)
+    email = sqlalchemy.Column(sqlalchemy.String, index=True, unique=True, nullable=True)
+    hashed_password = sqlalchemy.Column(sqlalchemy.String, nullable=True, index=True)
+    created_date = sqlalchemy.Column(sqlalchemy.DateTime, default=datetime.datetime.now, index=True)
+    profile_image_url = sqlalchemy.Column(sqlalchemy.String)
+    last_login = sqlalchemy.Column(sqlalchemy.DateTime, default=datetime.datetime.now, index=True)

app/ch10_using_sqlachemy/final/pypi_org/db/placeholder.txt

@@ -0,0 +1 @@
+Just here so git will create this folder.

app/ch10_using_sqlachemy/final/pypi_org/infrastructure/view_modifiers.py

@@ -0,0 +1,53 @@
+from functools import wraps
+
+import flask
+
+
+def response(*, mimetype: str = None, template_file: str = None):
+    def response_inner(f):
+        # print("Wrapping in response {}".format(f.__name__), flush=True)
+
+        @wraps(f)
+        def view_method(*args, **kwargs):
+            response_val = f(*args, **kwargs)
+            if isinstance(response_val, flask.Response):
+                return response_val
+
+            if isinstance(response_val, dict):
+                model = dict(response_val)
+            else:
+                model = dict()
+
+            if template_file and not isinstance(response_val, dict):
+                raise Exception(
+                    "Invalid return type {}, we expected a dict as the return value.".format(type(response_val)))
+
+            if template_file:
+                response_val = flask.render_template(template_file, **response_val)
+
+            resp = flask.make_response(response_val)
+            resp.model = model
+            if mimetype:
+                resp.mimetype = mimetype
+
+            return resp
+
+        return view_method
+
+    return response_inner
+
+#
+# def template(template_file: str = None):
+#     def template_inner(f):
+#         @wraps(f)
+#         def view_method(*args, **kwargs):
+#             data_dict = f(*args, **kwargs)
+#             if not isinstance(data_dict, dict):
+#                 raise Exception(
+#                     "Invalid return type {}, we expected a dict as the return value.".format(type(data_dict)))
+#
+#             return flask.render_template(template_file, **data_dict)
+#
+#         return view_method
+#
+#     return template_inner

app/ch10_using_sqlachemy/final/pypi_org/services/cms_service.py

@@ -0,0 +1,21 @@
+fake_db = {
+    '/company/history': {
+        'page_title': 'Company history',
+        'page_details': 'Details about company history...',
+    },
+    '/company/employees': {
+        'page_title': 'Our team',
+        'page_details': 'Details about company employees ...',
+    },
+}
+
+
+def get_page(url: str) -> dict:
+    if not url:
+        return {}
+
+    url = url.strip().lower()
+    url = '/' + url.lstrip('/')
+
+    page = fake_db.get(url, {})
+    return page

app/ch10_using_sqlachemy/final/pypi_org/services/package_service.py

@@ -0,0 +1,6 @@
+def get_latest_packages():
+    return [
+        {'name': 'flask', 'version': '1.2.3'},
+        {'name': 'sqlalchemy', 'version': '2.2.0'},
+        {'name': 'passlib', 'version': '3.0.0'},
+    ]