add Flask 3 support

Author: alexferl

.pre-commit-config.yaml

@@ -1,15 +1,14 @@
 repos:
 - repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v4.1.0
+  rev: v4.4.0
   hooks:
   - id: trailing-whitespace
   - id: end-of-file-fixer
   - id: mixed-line-ending
     args: ['--fix=lf']
     description: Forces to replace line ending by the UNIX 'lf' character.
 - repo: https://github.com/psf/black
-  rev: 22.1.0
+  rev: 23.9.1
   hooks:
   - id: black
     language_version: python3
-    args: [-t, py310]

.travis.yml

@@ -1,12 +1,17 @@
 language: python
 sudo: required
-dist: bionic
+dist: jammy
 python:
-  - "3.7"
   - "3.8"
   - "3.9"
+  - "3.10"
+  - "3.11"
 env:
-  - FLASK=2.0.2
+  - FLASK=3.0.0
+  - FLASK=2.3.3
+  - FLASK=2.2.5
+  - FLASK=2.1.3
+  - FLASK=2.0.3
   - FLASK=1.1.4
   - FLASK=1.0.4
 install:

Makefile

@@ -7,17 +7,17 @@ PYTHON=${VENV_NAME}/bin/python3
 .DEFAULT: help
 help:
 	@echo "make dev"
-	@echo "       prepare development environment, use only once"
+	@echo "	prepare development environment, use only once"
 	@echo "make clean"
-	@echo "       delete development environment"
+	@echo "	delete development environment"
 	@echo "make update"
-	@echo "       update dependencies"
+	@echo "	update dependencies"
 	@echo "make test"
-	@echo "       run tests"
+	@echo "	run tests"
 	@echo "make lint"
-	@echo "       run black"
+	@echo "	run black"
 	@echo "make pre-commit"
-	@echo "       run pre-commit hooks"
+	@echo "	run pre-commit hooks"
 
 dev:
 	make venv
@@ -41,7 +41,7 @@ test: venv
 	${PYTHON} -m pytest
 
 lint: venv
-	$(VENV_NAME)/bin/black -t py310 --exclude $(VENV_NAME) .
+	$(VENV_NAME)/bin/black --exclude $(VENV_NAME) .
 
 pre-commit: venv
 	$(VENV_NAME)/bin/pre-commit

README.md

@@ -15,9 +15,8 @@ pip install flask-mysqldb
 ```
 
 Flask-MySQLdb depends, and will install for you, recent versions of Flask
-(0.12.4 or later) and [mysqlclient](https://github.com/PyMySQL/mysqlclient-python).
-Flask-MySQLdb is compatible with and tested with Python 3.7+. It _should_ work on any
-version from Python 2.7 and up, but is not supported.
+(1.0.4 or later) and [mysqlclient](https://github.com/PyMySQL/mysqlclient).
+Flask-MySQLdb is compatible with and tested with Python 3.8+.
 
 Next, add a ``MySQL`` instance to your code:
 

dev_requirements.txt

@@ -1,5 +1,5 @@
-black==22.1.0
-pre-commit==2.17.0
-mysqlclient==1.4.3
+black==23.9.1
+pre-commit==3.4.0
+mysqlclient==2.2.0
 
 -r requirements.txt

docs/conf.py

@@ -58,16 +58,16 @@ def __getattr__(cls, name):
 
 # General information about the project.
 project = "Flask-MySQLdb"
-copyright = "2022, Alexandre Ferland"
+copyright = "2023, Alexandre Ferland"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = "1.0.1"
+version = "2.0.0"
 # The full version, including alpha/beta/rc tags.
-release = "1.0.1"
+release = "2.0.0"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

docs/index.rst

@@ -96,6 +96,10 @@ History
 
 Changes:
 
+- 2.0.0: October 4, 2023
+
+  - Add support for Flask 3.0.0+.
+
 - 1.0.1: February 13, 2022
 
   - Fix documentation.

flask_mysqldb/__init__.py

@@ -1,9 +1,18 @@
+from importlib.metadata import version
+flask_major_version = int(version("flask")[0])
+
 import MySQLdb
 from MySQLdb import cursors
-from flask import _app_ctx_stack, current_app
+from flask import current_app
+if flask_major_version >= 3:
+    from flask import g
+    ctx = g
+else:
+    from flask import _app_ctx_stack
+    ctx = _app_ctx_stack.top
 
 
-class MySQL(object):
+class MySQL:
     def __init__(self, app=None):
         self.app = app
         if app is not None:
@@ -95,13 +104,11 @@ def connection(self):
             unsuccessful.
         """
 
-        ctx = _app_ctx_stack.top
         if ctx is not None:
             if not hasattr(ctx, "mysql_db"):
                 ctx.mysql_db = self.connect
             return ctx.mysql_db
 
     def teardown(self, exception):
-        ctx = _app_ctx_stack.top
         if hasattr(ctx, "mysql_db"):
             ctx.mysql_db.close()

requirements.txt

@@ -1,3 +1,3 @@
-Flask==2.3.2
-mock==4.0.3
-mysqlclient==1.4.3
+Flask==3.0.0
+mock==5.1.0
+mysqlclient==2.2.0

setup.py

@@ -14,7 +14,7 @@
 
 setup(
     name="Flask-MySQLdb",
-    version="1.0.1",
+    version="2.0.0",
     url="https://github.com/alexferl/flask-mysqldb",
     license="MIT",
     author="Alexandre Ferland",
@@ -26,15 +26,16 @@
     zip_safe=False,
     include_package_data=True,
     platforms="any",
-    install_requires=["Flask>=0.12.4", "mysqlclient>=1.3.7"],
+    install_requires=["Flask>=1.0.4", "mysqlclient>=2.2.0"],
     classifiers=[
         "Environment :: Web Environment",
         "Intended Audience :: Developers",
         "License :: OSI Approved :: MIT License",
         "Operating System :: OS Independent",
-        "Programming Language :: Python :: 3.7",
         "Programming Language :: Python :: 3.8",
         "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
         "Topic :: Software Development :: Libraries :: Python Modules",
     ],
 )