Modernize code and drop unused shortlink models (#121)

Author: jace

.deepsource.toml

@@ -0,0 +1,16 @@
+version = 1
+test_patterns = [
+  "tests/**"
+]
+exclude_patterns = [
+  "**/node_modules/",
+  "migrations/**/*"
+]
+
+[[analyzers]]
+name = "python"
+enabled = true
+runtime_version = "3.x.x"
+
+[analyzers.meta]
+max_line_length = 88

.gitignore

@@ -11,6 +11,7 @@ test.db
 docs/_build
 build/
 dist/
+hasmail/static/gen/
 .webassets-cache
 nosetests.xml
 .sass-cache

.pre-commit-config.yaml

@@ -1,6 +1,18 @@
 # See https://pre-commit.com for more information
 # See https://pre-commit.com/hooks.html for more hooks
+ci:
+  skip: ['yesqa', 'no-commit-to-branch']
 repos:
+  - repo: https://github.com/pre-commit-ci/pre-commit-ci-config
+    rev: v1.5.1
+    hooks:
+      - id: check-pre-commit-ci-config
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: v0.0.276
+    hooks:
+      - id: ruff
+        args: ['--fix', '--exit-non-zero-on-fix']
+        # Extra args, only after removing flake8 and yesqa: '--extend-select', 'RUF100'
   - repo: https://github.com/lucasmbrown/mirrors-autoflake
     rev: v1.3
     hooks:
@@ -13,66 +25,123 @@ repos:
             '--remove-unused-variables',
             '--remove-duplicate-keys',
           ]
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v3.8.0
+    hooks:
+      - id: pyupgrade
+        args:
+          ['--keep-runtime-typing', '--py3-plus', '--py36-plus', '--py37-plus']
+  - repo: https://github.com/asottile/yesqa
+    rev: v1.5.0
+    hooks:
+      - id: yesqa
+        additional_dependencies: &flake8deps
+          - bandit
+          - flake8-assertive
+          - flake8-blind-except
+          - flake8-builtins
+          - flake8-comprehensions
+          - flake8-isort
+          - flake8-logging-format
+          - flake8-mutable
+          - flake8-print
+          - pep8-naming
+          - toml
+          - tomli
   - repo: https://github.com/PyCQA/isort
     rev: 5.12.0
     hooks:
       - id: isort
         additional_dependencies:
-          - toml
+          - tomli
   - repo: https://github.com/psf/black
     rev: 23.3.0
     hooks:
       - id: black
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.4.1
+    hooks:
+      - id: mypy
+        # warn-unused-ignores is unsafe with pre-commit, see
+        # https://github.com/python/mypy/issues/2960
+        args: ['--no-warn-unused-ignores', '--ignore-missing-imports']
+        additional_dependencies:
+          - alembic
+          - flask
+          - lxml-stubs
+          - sqlalchemy
+          - toml
+          - tomli
+          - types-geoip2
+          - types-python-dateutil
+          - types-pytz
+          - types-requests
+          - typing-extensions
+  - repo: https://github.com/PyCQA/flake8
+    rev: 6.0.0
+    hooks:
+      - id: flake8
+        additional_dependencies: *flake8deps
+  - repo: https://github.com/PyCQA/pylint
+    rev: v3.0.0a6
+    hooks:
+      - id: pylint
+        args: [
+            '--disable=import-error',
+            '-rn', # Disable full report
+            '-sn', # Disable evaluation score
+            '--ignore-paths=migrations',
+          ]
+        additional_dependencies:
+          - tomli
+  - repo: https://github.com/PyCQA/bandit
+    rev: 1.7.5
+    hooks:
+      - id: bandit
+        language_version: python3
+        args: ['-c', 'pyproject.toml']
+        additional_dependencies:
+          - 'bandit[toml]'
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.4.0
     hooks:
       - id: check-added-large-files
       - id: check-ast
-      - id: check-byte-order-marker
       - id: check-case-conflict
       - id: check-docstring-first
       - id: check-executables-have-shebangs
       - id: check-json
       - id: check-merge-conflict
+      - id: check-shebang-scripts-are-executable
       - id: check-symlinks
       - id: check-toml
+      - id: check-vcs-permalinks
       - id: check-xml
       - id: check-yaml
       - id: debug-statements
+      - id: destroyed-symlinks
       - id: detect-aws-credentials
         args: ['--allow-missing-credentials']
       - id: detect-private-key
       - id: end-of-file-fixer
+      - id: fix-byte-order-marker
       - id: fix-encoding-pragma
         args: ['--remove']
       - id: forbid-new-submodules
       - id: mixed-line-ending
+      - id: name-tests-test
+        args: ['--pytest']
       - id: no-commit-to-branch
       - id: requirements-txt-fixer
       - id: trailing-whitespace
-  - repo: https://github.com/PyCQA/flake8
-    rev: 6.0.0
-    hooks:
-      - id: flake8
-        additional_dependencies:
-          - toml
-          - flake8-assertive
-          - flake8-blind-except
-          - flake8-builtins
-          - flake8-comprehensions
-          - flake8-isort
-          - flake8-logging-format
-          - flake8-mutable
-          - flake8-print
-          - pep8-naming
-  - repo: https://github.com/PyCQA/bandit
-    rev: 1.7.5
-    hooks:
-      - id: bandit
-        language_version: python3
-        exclude: (^tests|funnel/loginproviders/flask_oauth.py)
+        args: ['--markdown-linebreak-ext=md']
   - repo: https://github.com/pre-commit/mirrors-prettier
     rev: v3.0.0-alpha.9-for-vscode
     hooks:
       - id: prettier
         args: ['--single-quote', '--trailing-comma', 'es5']
+  - repo: https://github.com/ducminh-phan/reformat-gherkin
+    rev: v3.0.1
+    hooks:
+      - id: reformat-gherkin
+        files: \.feature$

hasmail/__init__.py

@@ -1,15 +1,16 @@
-# The imports in this file are order-sensitive
+"""Hasgeek Mailer."""
 
+# The imports in this file are order-sensitive
 
 from flask import Flask
 from flask_mail import Mail
 from flask_migrate import Migrate
 from flask_rq2 import RQ
 
+import coaster.app
 from baseframe import Version, _, __, assets, baseframe  # NOQA
 from flask_lastuser import Lastuser
 from flask_lastuser.sqlalchemy import UserManager
-import coaster.app
 
 from ._version import __version__
 
@@ -24,7 +25,7 @@
 
 # Second, import the models and views
 
-from . import models, views  # NOQA: F401 # isort:skip
+from . import models, views  # noqa: F401 # isort:skip
 from .models import db  # isort:skip
 
 # Third, setup baseframe and assets
@@ -34,9 +35,8 @@
 
 
 # Configure the app
-coaster.app.init_app(app)
+coaster.app.init_app(app, config=['py', 'env'], env_prefix=['FLASK', 'APP_HASMAIL'])
 db.init_app(app)
-db.app = app
 migrate = Migrate(app, db)
 rq.init_app(app)  # Pick up RQ configuration from the app
 baseframe.init_app(

hasmail/_version.py

@@ -1,3 +1,5 @@
+"""Version number."""
+
 __all__ = ['__version__', '__version_info__']
 
 __version__ = '0.1.0-dev'

hasmail/forms/__init__.py

@@ -1,3 +1,5 @@
+"""Forms."""
+
 # flake8: noqa
 
-from .email import *
+from .mailer import *

hasmail/forms/email.py hasmail/forms/mailer.py

@@ -1,13 +1,16 @@
-import baseframe.forms as forms
+"""Mailer forms."""
 
-from .. import __
+from baseframe import __, forms
 
-__all__ = ['CampaignSettingsForm', 'CampaignSendForm', 'TemplateForm']
+__all__ = ['MailerSettingsForm', 'MailerSendForm', 'MailerTemplateForm']
 
 
-class CampaignSettingsForm(forms.Form):
+class MailerSettingsForm(forms.Form):
+    """Mailer settings form."""
+
     title = forms.StringField(
         __("What’s this email about?"),
+        description=__("A private description for your own reference"),
         validators=[forms.validators.DataRequired(__("This is required"))],
     )
 
@@ -42,19 +45,19 @@ class CampaignSettingsForm(forms.Form):
         ),
     )
 
-    # trackclicks = forms.BooleanField(__(u"Track clicks"), default=False,
-    #     description=__(u"All links in your email will be wrapped and clicks will be tracked "
-    #         u"so you know which recipient opened which links"))
 
+class MailerSendForm(forms.Form):
+    """Mailer send form."""
 
-class CampaignSendForm(forms.Form):
     email = forms.RadioField(
         __("Send from"),
         description=__("What email address would you like to send this from?"),
     )
 
 
-class TemplateForm(forms.Form):
+class MailerTemplateForm(forms.Form):
+    """Mailer template edit form."""
+
     revision_id = forms.HiddenField(__("Revision id"))
     subject = forms.StringField(__("Subject"))
     # Don't use MarkdownField since the only thing it does is adding the

hasmail/models/__init__.py

@@ -1,14 +1,37 @@
+"""Hasmail models."""
 # flake8: noqa
 
-from coaster.db import db
+from __future__ import annotations
+
+import sqlalchemy as sa
+from flask_sqlalchemy import SQLAlchemy
+from sqlalchemy.orm import DeclarativeBase, Mapped
+
 from coaster.sqlalchemy import (
+    AppenderQuery,
     BaseMixin,
     BaseNameMixin,
     BaseScopedIdMixin,
+    DynamicMapped,
     JsonDict,
     MarkdownColumn,
+    ModelBase,
+    Query,
     TimestampMixin,
+    relationship,
 )
 
-from .email import *
-from .user import *
+
+class Model(ModelBase, DeclarativeBase):
+    """Base for models."""
+
+    __with_timezone__ = True
+
+
+TimestampMixin.__with_timezone__ = True
+
+db = SQLAlchemy(query_class=Query, metadata=Model.metadata)  # type: ignore[arg-type]
+Model.init_flask_sqlalchemy(db)
+
+
+from .mailer import *