diff options
| author | Dennis Fink | 2026-11-12 22:56:07 +0100 |
|---|---|---|
| committer | Dennis Fink | 2026-11-12 22:56:07 +0100 |
| commit | a10b29ac98ba535a5c2f9697c54265edd2c84a78 (patch) | |
| tree | f116a58be6e241a11d283683070ebb18c96aa8e4 /webmentions_ssg | |
| parent | 1db6b47f88dde5538efa433328987c70eab74d70 (diff) | |
| download | webmentions-ssg-a10b29ac98ba535a5c2f9697c54265edd2c84a78.tar.gz webmentions-ssg-a10b29ac98ba535a5c2f9697c54265edd2c84a78.zip | |
refactor(core): use lowercase extension names
Rename shared Flask extension singletons to conventional lowercase names
and update imports throughout the application and tests to remove
redundant aliases.
Diffstat (limited to 'webmentions_ssg')
| -rw-r--r-- | webmentions_ssg/__init__.py | 18 | ||||
| -rw-r--r-- | webmentions_ssg/auth.py | 2 | ||||
| -rw-r--r-- | webmentions_ssg/cli.py | 24 | ||||
| -rw-r--r-- | webmentions_ssg/extensions.py | 14 | ||||
| -rw-r--r-- | webmentions_ssg/tasks/consumer.py | 16 | ||||
| -rw-r--r-- | webmentions_ssg/tasks/notifications.py | 4 | ||||
| -rw-r--r-- | webmentions_ssg/tasks/receiver.py | 3 | ||||
| -rw-r--r-- | webmentions_ssg/tasks/retention.py | 2 | ||||
| -rw-r--r-- | webmentions_ssg/tasks/scanner.py | 3 | ||||
| -rw-r--r-- | webmentions_ssg/tasks/sender.py | 3 | ||||
| -rw-r--r-- | webmentions_ssg/views/admin.py | 2 | ||||
| -rw-r--r-- | webmentions_ssg/views/endpoint.py | 9 | ||||
| -rw-r--r-- | webmentions_ssg/views/session.py | 7 |
13 files changed, 52 insertions, 55 deletions
diff --git a/webmentions_ssg/__init__.py b/webmentions_ssg/__init__.py index 46b78ea..9392e31 100644 --- a/webmentions_ssg/__init__.py +++ b/webmentions_ssg/__init__.py @@ -19,7 +19,7 @@ VERSION = "0.0.2" from .auth import AUTH from .cli import DB_CLI, MAIL_CLI, USERS_CLI from .config import DefaultConfig, DevelopmentConfig, ProductionConfig, validate_config -from .extensions import BOOTSTRAP, CSRF, DATABASE, HUEY, LIMITER, MAIL, MIGRATE +from .extensions import bootstrap, csrf, db, huey, limiter, mail, migrate from .net import is_http_url from .views import register_routes @@ -101,20 +101,20 @@ def create_app(config_class: type[DefaultConfig] | None = None) -> Flask: fmt=app.config["LOG_FORMAT"], ) - DATABASE.init_app(app) - MIGRATE.init_app( + db.init_app(app) + migrate.init_app( app, - db=DATABASE, + db=db, directory=str(Path(__file__).resolve().parent / "migrations"), command="migrate", ) - CSRF.init_app(app) - LIMITER.init_app(app) - MAIL.init_app(app) + csrf.init_app(app) + limiter.init_app(app) + mail.init_app(app) AUTH.init_app(app) - BOOTSTRAP.init_app(app) - HUEY.init_app(app) + bootstrap.init_app(app) + huey.init_app(app) @app.context_processor def inject_version(): diff --git a/webmentions_ssg/auth.py b/webmentions_ssg/auth.py index b943404..209bdd6 100644 --- a/webmentions_ssg/auth.py +++ b/webmentions_ssg/auth.py @@ -13,7 +13,7 @@ from flask import request from flask_limiter.util import get_remote_address from flask_login import LoginManager -from .extensions import DATABASE as db +from .extensions import db from .models import User AUTH = LoginManager() diff --git a/webmentions_ssg/cli.py b/webmentions_ssg/cli.py index 0fed7dd..b0459d4 100644 --- a/webmentions_ssg/cli.py +++ b/webmentions_ssg/cli.py @@ -14,7 +14,7 @@ from sqlalchemy import inspect from sqlalchemy.exc import IntegrityError from .auth import validate_password -from .extensions import DATABASE, MAIL +from .extensions import db, mail from .models import User USERS_CLI = AppGroup("users", help="Manage users.") @@ -22,7 +22,7 @@ USERS_CLI = AppGroup("users", help="Manage users.") def _require_user(username: str): """Return a user by username or report a CLI-friendly error.""" - user = DATABASE.session.scalar(sa.select(User).where(User.username == username)) + user = db.session.scalar(sa.select(User).where(User.username == username)) if user is None: raise click.ClickException(f"User {username!r} does not exist.") return user @@ -47,14 +47,14 @@ def create_user(username: str, password: str) -> None: except ValueError as exc: raise click.ClickException(str(exc)) from exc - if DATABASE.session.scalar(sa.select(User).where(User.username == username)): + if db.session.scalar(sa.select(User).where(User.username == username)): raise click.ClickException(f"User {username!r} already exists.") - DATABASE.session.add(User(username=username, password=password)) + db.session.add(User(username=username, password=password)) try: - DATABASE.session.commit() + db.session.commit() except IntegrityError as exc: - DATABASE.session.rollback() + db.session.rollback() raise click.ClickException(f"User {username!r} already exists.") from exc click.echo(f"Created user {username!r}.") @@ -63,7 +63,7 @@ def create_user(username: str, password: str) -> None: @USERS_CLI.command("list", help="List registered users.") def list_users() -> None: """List user IDs and usernames in alphabetical order.""" - users = DATABASE.session.scalars(sa.select(User).order_by(User.username)).all() + users = db.session.scalars(sa.select(User).order_by(User.username)).all() if not users: click.echo("No users found.") return @@ -90,7 +90,7 @@ def set_user_password(username: str, password: str) -> None: user = _require_user(username) user.password = password - DATABASE.session.commit() + db.session.commit() click.echo(f"Updated password for user {username!r}.") @@ -108,8 +108,8 @@ def delete_user(username: str, yes: bool) -> None: if not yes: click.confirm(f"Delete user {username!r}?", abort=True) - DATABASE.session.delete(user) - DATABASE.session.commit() + db.session.delete(user) + db.session.commit() click.echo(f"Deleted user {username!r}.") @@ -147,7 +147,7 @@ def send_test_mail(recipient: str | None) -> None: ) try: - MAIL.send(message) + mail.send(message) except Exception as exc: raise click.ClickException(f"Could not send test email: {exc}") from exc @@ -159,7 +159,7 @@ DB_CLI = AppGroup("db", help="Handle database") def _table_names() -> set[str]: """Return existing table names without modifying the database schema.""" - with DATABASE.engine.connect() as connection: + with db.engine.connect() as connection: return set(inspect(connection).get_table_names()) diff --git a/webmentions_ssg/extensions.py b/webmentions_ssg/extensions.py index 0afec9c..c1cf396 100644 --- a/webmentions_ssg/extensions.py +++ b/webmentions_ssg/extensions.py @@ -20,10 +20,10 @@ class Base(DeclarativeBase): pass -CSRF = CSRFProtect() -BOOTSTRAP = Bootstrap5() -DATABASE = SQLAlchemy(model_class=Base) -MIGRATE = Migrate() -HUEY = Huey() -MAIL = Mail() -LIMITER = Limiter(key_func=get_remote_address) +csrf = CSRFProtect() +bootstrap = Bootstrap5() +db = SQLAlchemy(model_class=Base) +migrate = Migrate() +huey = Huey() +mail = Mail() +limiter = Limiter(key_func=get_remote_address) diff --git a/webmentions_ssg/tasks/consumer.py b/webmentions_ssg/tasks/consumer.py index 9010ef7..047c010 100644 --- a/webmentions_ssg/tasks/consumer.py +++ b/webmentions_ssg/tasks/consumer.py @@ -6,7 +6,7 @@ from huey import Huey, crontab -from .. import HUEY, create_app +from .. import create_app, extensions def create_consumer() -> Huey: @@ -23,24 +23,28 @@ def create_consumer() -> Huey: from . import notifications, receiver, retention, scanner schedule = crontab(*app.config["SCANNER_SCHEDULE"].split(), strict=True) - HUEY.periodic_task(schedule)(scanner.scan_sources) + extensions.huey.periodic_task(schedule)(scanner.scan_sources) recovery_schedule = crontab( *app.config["VERIFICATION_REAPER_SCHEDULE"].split(), strict=True ) - HUEY.periodic_task(recovery_schedule)(receiver.recover_stale_webmentions) + extensions.huey.periodic_task(recovery_schedule)(receiver.recover_stale_webmentions) notification_schedule = crontab( *app.config["NOTIFICATION_SCHEDULE"].split(), strict=True ) - HUEY.periodic_task(notification_schedule)(notifications.send_webmention_digest) + extensions.huey.periodic_task(notification_schedule)( + notifications.send_webmention_digest + ) retention_schedule = crontab( *app.config["RECEIVED_RETENTION_SCHEDULE"].split(), strict=True ) - HUEY.periodic_task(retention_schedule)(retention.purge_old_received_webmentions) + extensions.huey.periodic_task(retention_schedule)( + retention.purge_old_received_webmentions + ) - return HUEY.huey + return extensions.huey.huey huey = create_consumer() diff --git a/webmentions_ssg/tasks/notifications.py b/webmentions_ssg/tasks/notifications.py index a6a9b2b..fe12e93 100644 --- a/webmentions_ssg/tasks/notifications.py +++ b/webmentions_ssg/tasks/notifications.py @@ -10,9 +10,7 @@ import sqlalchemy as sa from flask import current_app from flask_mail import Message -from ..extensions import DATABASE as db -from ..extensions import HUEY as huey -from ..extensions import MAIL as mail +from ..extensions import db, huey, mail from ..models import ReceivedStatus, ReceivedWebmention diff --git a/webmentions_ssg/tasks/receiver.py b/webmentions_ssg/tasks/receiver.py index ada89f8..4c4134c 100644 --- a/webmentions_ssg/tasks/receiver.py +++ b/webmentions_ssg/tasks/receiver.py @@ -13,8 +13,7 @@ import sqlalchemy as sa from flask import current_app from .. import APP_NAME, VERSION -from ..extensions import DATABASE as db -from ..extensions import HUEY as huey +from ..extensions import db, huey from ..models import ReceivedStatus, ReceivedWebmention from ..net import ( AddressResolutionError, diff --git a/webmentions_ssg/tasks/retention.py b/webmentions_ssg/tasks/retention.py index 935f54b..754c891 100644 --- a/webmentions_ssg/tasks/retention.py +++ b/webmentions_ssg/tasks/retention.py @@ -11,7 +11,7 @@ import sqlalchemy as sa from flask import current_app from sqlalchemy.engine import CursorResult -from ..extensions import DATABASE as db +from ..extensions import db from ..models import ReceivedStatus, ReceivedWebmention diff --git a/webmentions_ssg/tasks/scanner.py b/webmentions_ssg/tasks/scanner.py index 6365ff9..353d538 100644 --- a/webmentions_ssg/tasks/scanner.py +++ b/webmentions_ssg/tasks/scanner.py @@ -12,8 +12,7 @@ from flask import current_app from huey.exceptions import RetryTask, TaskLockedException from sqlalchemy.orm import selectinload -from ..extensions import DATABASE as db -from ..extensions import HUEY as huey +from ..extensions import db, huey from ..models import SentWebmention, Source from ..net import is_http_url from .sender import send_webmention diff --git a/webmentions_ssg/tasks/sender.py b/webmentions_ssg/tasks/sender.py index 3803463..463208d 100644 --- a/webmentions_ssg/tasks/sender.py +++ b/webmentions_ssg/tasks/sender.py @@ -14,8 +14,7 @@ from flask import current_app from huey.exceptions import TaskLockedException from .. import APP_NAME, VERSION -from ..extensions import DATABASE as db -from ..extensions import HUEY as huey +from ..extensions import db, huey from ..models import SentWebmention, SentWebmentionStatus from ..net import ( AddressResolutionError, diff --git a/webmentions_ssg/views/admin.py b/webmentions_ssg/views/admin.py index 2f3f3ab..dadf8dd 100644 --- a/webmentions_ssg/views/admin.py +++ b/webmentions_ssg/views/admin.py @@ -13,7 +13,7 @@ from flask_login import login_required from sqlalchemy.orm import selectinload from .. import forms -from ..extensions import DATABASE as db +from ..extensions import db from ..models import ReceivedWebmention, SentWebmention, Source from ..tasks.receiver import verify_webmention from ..tasks.scanner import manual_scan_sources diff --git a/webmentions_ssg/views/endpoint.py b/webmentions_ssg/views/endpoint.py index baab397..91bb881 100644 --- a/webmentions_ssg/views/endpoint.py +++ b/webmentions_ssg/views/endpoint.py @@ -15,8 +15,7 @@ from flask.typing import ResponseReturnValue from sqlalchemy.engine import CursorResult from .. import forms -from ..extensions import CSRF, LIMITER -from ..extensions import DATABASE as db +from ..extensions import csrf, db, limiter from ..models import ReceivedWebmention, received_url_digest from ..tasks.receiver import verify_webmention from . import root_page @@ -92,12 +91,12 @@ def submit_received(source: str, target: str) -> tuple[uuid.UUID, bool] | None: @root_page.post("/endpoint") -@LIMITER.limit( +@limiter.limit( lambda: current_app.config["ENDPOINT_GLOBAL_RATE_LIMIT"], key_func=lambda: "all-clients", ) -@LIMITER.limit(lambda: current_app.config["ENDPOINT_RATE_LIMIT"]) -@CSRF.exempt +@limiter.limit(lambda: current_app.config["ENDPOINT_RATE_LIMIT"]) +@csrf.exempt def endpoint() -> ResponseReturnValue: """Receive and queue a Webmention for verification. diff --git a/webmentions_ssg/views/session.py b/webmentions_ssg/views/session.py index 3f8a0f2..e4c462f 100644 --- a/webmentions_ssg/views/session.py +++ b/webmentions_ssg/views/session.py @@ -11,8 +11,7 @@ from flask_login import current_user, login_required, login_user, logout_user from .. import forms from ..auth import DUMMY_USER, is_safe_next_url, login_username_limit_key -from ..extensions import DATABASE as db -from ..extensions import LIMITER +from ..extensions import db, limiter from ..models import User from . import root_page @@ -27,13 +26,13 @@ def index() -> ResponseReturnValue: @root_page.route("/login", methods=["GET", "POST"]) -@LIMITER.limit( +@limiter.limit( lambda: current_app.config["LOGIN_USERNAME_RATE_LIMIT"], key_func=login_username_limit_key, methods=["POST"], error_message="Too many login attempts. Please try again later.", ) -@LIMITER.limit( +@limiter.limit( lambda: current_app.config["LOGIN_RATE_LIMIT"], methods=["POST"], error_message="Too many login attempts. Please try again later.", |
