Merge pull request ckan#7967 from ckan/flaskv3

2023-12 dependency update(Flask v3)

ckan/cli/shell.py

@@ -30,7 +30,7 @@ def ipython(namespace: Mapping[str, Any], banner: str) -> None:
     c = Config()
     setattr(c.TerminalInteractiveShell, "banner2", banner)
 
-    IPython.start_ipython([], user_ns=namespace, config=c)  # type: ignore
+    IPython.start_ipython([], user_ns=namespace, config=c)
 
 
 def python(namespace: Mapping[str, Any], banner: str) -> None:

ckan/lib/helpers.py

@@ -29,10 +29,9 @@
 from markdown import markdown
 from bleach import clean as bleach_clean, ALLOWED_TAGS, ALLOWED_ATTRIBUTES
 from ckan.common import asbool, config, current_user
-from flask import flash
+from flask import flash, has_request_context
 from flask import get_flashed_messages as _flask_get_flashed_messages
 from flask import redirect as _flask_redirect
-from flask import _request_ctx_stack
 from flask import url_for as _flask_default_url_for
 from werkzeug.routing import BuildError as FlaskRouteBuildError
 from ckan.lib import i18n
@@ -311,7 +310,7 @@ def _get_auto_flask_context():
     from ckan.config.middleware import _internal_test_request_context
 
     # This is a normal web request, there is a request context present
-    if _request_ctx_stack.top:
+    if has_request_context():
         return None
 
     # We are outside a web request. A test web application was created

ckan/lib/pagination.py

@@ -37,7 +37,7 @@
 
 import re
 from string import Template
-from typing import Any, Callable, Match, Optional, Sequence, List
+from typing import Any, Callable, Match, Optional, Sequence, List, cast
 
 import dominate.tags as tags
 from markupsafe import Markup
@@ -583,7 +583,7 @@ def _range(self, regexp_match: Match[str]):
 
         return self.separator.join(nav_items)
 
-    def _pagerlink(self, page: int, text: str):
+    def _pagerlink(self, page: int, text: str) -> Any:
         """
         Create a URL that links to another page using url_for().
 
@@ -633,7 +633,7 @@ def _pagerlink(self, page: int, text: str):
 
 class Page(BasePage):
     def pager(self, *args: Any, **kwargs: Any) -> Markup:
-        with tags.div(cls=u"pagination-wrapper") as wrapper:
+        with cast(Any, tags.div(cls=u"pagination-wrapper")) as wrapper:
             tags.ul(
                 "$link_previous ~2~ $link_next",
                 cls="pagination justify-content-center"

ckan/model/group.py

@@ -136,7 +136,7 @@ def related_packages(self) -> list[_package.Package]:
         # TODO do we want to return all related packages or certain ones?
         return meta.Session.query(_package.Package).filter_by(
             id=self.table_id).all()
-    
+
 
     def __str__(self):
         # refer to objects by name, not ID, to help debugging
@@ -226,7 +226,7 @@ def set_approval_status(self, status: str) -> None:
         assert status in ["approved", "denied"]
         self.approval_status = status
 
-    def get_children_groups(self, type: str='group') -> list[Self]:
+    def get_children_groups(self, type: str='group') -> list[Group]:
         '''Returns the groups one level underneath this group in the hierarchy.
         '''
         # The original intention of this method was to provide the full depth
@@ -263,7 +263,7 @@ def get_children_group_hierarchy(
             id=self.id, type=type).all()
         return results
 
-    def get_parent_groups(self, type: str='group') -> list[Self]:
+    def get_parent_groups(self, type: str='group') -> list[Group]:
         '''Returns this group's parent groups.
         Returns a list. Will have max 1 value for organizations.
 
@@ -279,7 +279,7 @@ def get_parent_groups(self, type: str='group') -> list[Self]:
             all()
         return result
 
-    def get_parent_group_hierarchy(self, type: str='group') -> list[Self]:
+    def get_parent_group_hierarchy(self, type: str='group') -> list[Group]:
         '''Returns this group's parent, parent's parent, parent's parent's
         parent etc.. Sorted with the top level parent first.'''
         result: list[Group] =  meta.Session.query(Group).\
@@ -288,7 +288,7 @@ def get_parent_group_hierarchy(self, type: str='group') -> list[Self]:
         return result
 
     @classmethod
-    def get_top_level_groups(cls, type: str='group') -> list[Self]:
+    def get_top_level_groups(cls, type: str='group') -> list[Group]:
         '''Returns a list of the groups (of the specified type) which have
         no parent groups. Groups are sorted by title.
         '''

ckan/model/system.py

@@ -1,7 +1,6 @@
 # encoding: utf-8
 
 from typing import Optional
-from typing_extensions import Self
 import ckan.model.domain_object as domain_object
 
 
@@ -19,5 +18,5 @@ def purge(self) -> None:
     def by_name(cls,
                 name: Optional[str],
                 autoflush: bool = True,
-                for_update: bool = False) -> Optional[Self]:
+                for_update: bool = False) -> Optional["System"]:
         return System()

ckan/model/tag.py

@@ -115,7 +115,7 @@ def by_name(
 
     @classmethod
     def get(cls, tag_id_or_name: str,
-            vocab_id_or_name: Optional[str]=None) -> Optional[Self]:
+            vocab_id_or_name: Optional[str]=None) -> Optional[Tag]:
         '''Return the tag with the given id or name, or None.
 
         By default only free tags (tags which do not belong to any vocabulary)
@@ -184,7 +184,7 @@ def search_by_name(
             query = meta.Session.query(Tag)
         search_term = search_term.strip().lower()
         query = query.filter(Tag.name.contains(search_term))
-        query: 'Query[Tag]' = query.distinct().join(Tag.package_tags)
+        query: 'Query[Self]' = query.distinct().join(Tag.package_tags)
         return query
 
     @classmethod

ckan/model/vocabulary.py

@@ -4,7 +4,6 @@
 from typing import Optional, TYPE_CHECKING
 from sqlalchemy import types, Column, Table
 from sqlalchemy.orm import Mapped
-from typing_extensions import Self
 
 import ckan.model.meta as meta
 import ckan.model.types as _types
@@ -36,7 +35,7 @@ def __init__(self, name: str) -> None:
         self.name = name
 
     @classmethod
-    def get(cls, id_or_name: str) -> Optional[Self]:
+    def get(cls, id_or_name: str) -> Optional[Vocabulary]:
         '''Return a Vocabulary object referenced by its id or name, or
         None if there is no vocabulary with the given id or name. '''
         query = meta.Session.query(Vocabulary)

ckanext/resourceproxy/blueprint.py

@@ -67,7 +67,6 @@ def proxy_resource(context: Context, data_dict: DataDict):
             r = requests.get(url, timeout=timeout, stream=True)
 
         response.headers[u'content-type'] = r.headers[u'content-type']
-        response.charset = r.encoding or "utf-8"
 
         length = 0
         chunk_size = config.get(u'ckan.resource_proxy.chunk_size')

ckanext/tracking/middleware.py

@@ -31,8 +31,9 @@ def track_request(response: Response) -> Response:
             request.environ.get('HTTP_ACCEPT_ENCODING', ''),
         ])
         # raises a type error on python<3.9
-        h = hashlib.new('md5', usedforsecurity=False)  # type: ignore
-        key = h.update(key.encode()).hexdigest()
+        h = hashlib.new('md5', usedforsecurity=False)
+        h.update(key.encode())
+        key = h.hexdigest()
         # store key/data here
         sql = '''INSERT INTO tracking_raw
                     (user_key, url, tracking_type)

dev-requirements.txt

@@ -1,25 +1,24 @@
 # These are packages that are required by ckan developers - for running ckan in debug mode, running ckan tests, building the docs and to pip-compile the requirements.in file.
 
 beautifulsoup4==4.12.2
-cookiecutter==2.1.1
+cookiecutter==2.5.0
 coveralls   #Let Unpinned - Requires latest coveralls
-docutils==0.18.1 # Needed until sphinx-rtd-theme 2.0 is out
-Faker==19.6.2
+Faker==20.1.0
 factory-boy==3.3.0
-flask-debugtoolbar==0.13.1
-freezegun==1.2.2
+flask-debugtoolbar==0.14.0
+freezegun==1.3.1
 ipdb==0.13.13
 pip-tools==7.3.0
-Pillow==10.0.1
-responses==0.23.3
-sphinx-rtd-theme==1.3.0
-sphinx==7.1.2
+Pillow==10.1.0
+responses==0.24.1
+sphinx-rtd-theme==2.0.0
+sphinx==7.2.6
 toml==0.10.2
-towncrier==22.12.0
+towncrier==23.11.0
 
-pytest==7.4.2
+pytest==7.4.3
 pytest-cov==4.1.0
-pytest-factoryboy==2.5.1
+pytest-factoryboy==2.6.0
 pytest-freezegun==0.4.2
-pytest-rerunfailures==12.0
+pytest-rerunfailures==13.0
 pytest-split==0.8.1

pyproject.toml

@@ -47,10 +47,10 @@ markers = [
 ]
 
 testpaths = ["ckan", "ckanext"]
-addopts = "--strict-markers --pdbcls=IPython.terminal.debugger:TerminalPdb -p no:ckan"
+addopts = "--strict-markers --pdbcls=IPython.terminal.debugger:TerminalPdb -p no:ckan --ckan-ini=test-core.ini"
 
 [tool.pyright]
-pythonVersion = "3.8"
+pythonVersion = "3.9"
 include = ["ckan", "ckanext"]
 exclude = [
     "**/test*",

requirements.in

@@ -1,21 +1,21 @@
 # The file contains the direct ckan requirements (python3).
 # Use pip-compile to create a requirements.txt file from this
-alembic==1.12.0
-Babel==2.12.1
+alembic==1.13.0
+Babel==2.13.1
 Beaker==1.12.1
-bleach==6.0.0
-blinker==1.6.2
+bleach==6.1.0
+blinker==1.7.0
 certifi>=2023.7.22
 click==8.1.7
-dominate==2.8.0
+dominate==2.9.0
 feedgen==0.9.0
-Flask==2.3.3
-Flask-Babel==3.1.0
-Flask-Login==0.6.2
-Flask-WTF==1.1.1
+Flask==3.0.0
+Flask-Babel==4.0.0
+Flask-Login==0.6.3
+Flask-WTF==1.2.1
 greenlet>=2.0.2
 Jinja2==3.1.2
-Markdown==3.4.4
+Markdown==3.5.1
 passlib==1.7.4
 polib==1.2.0
 psycopg2==2.9.7
@@ -28,11 +28,11 @@ PyUtilib==6.0.0
 pyyaml==6.0.1
 requests==2.31.0
 rq==1.15.1
-simplejson==3.19.1
+simplejson==3.19.2
 SQLAlchemy[mypy]==1.4.49
 sqlparse==0.4.4
 typing_extensions==4.8.0
 tzlocal==5.0.1
 webassets==2.0
-Werkzeug[watchdog]==2.3.7
+Werkzeug[watchdog]==3.0.1
 zope.interface==6.0

requirements.txt

@@ -4,17 +4,17 @@
 #
 #    pip-compile requirements.in
 #
-alembic==1.12.0
+alembic==1.13.0
     # via -r requirements.in
-babel==2.12.1
+babel==2.13.1
     # via
     #   -r requirements.in
     #   flask-babel
 beaker==1.12.1
     # via -r requirements.in
-bleach==6.0.0
+bleach==6.1.0
     # via -r requirements.in
-blinker==1.6.2
+blinker==1.7.0
     # via
     #   -r requirements.in
     #   flask
@@ -31,21 +31,21 @@ click==8.1.7
     #   rq
 deprecated==1.2.13
     # via redis
-dominate==2.8.0
+dominate==2.9.0
     # via -r requirements.in
 feedgen==0.9.0
     # via -r requirements.in
-flask==2.3.3
+flask==3.0.0
     # via
     #   -r requirements.in
     #   flask-babel
     #   flask-login
     #   flask-wtf
-flask-babel==3.1.0
+flask-babel==4.0.0
     # via -r requirements.in
-flask-login==0.6.2
+flask-login==0.6.3
     # via -r requirements.in
-flask-wtf==1.1.1
+flask-wtf==1.2.1
     # via -r requirements.in
 greenlet==2.0.2
     # via
@@ -70,7 +70,7 @@ lxml==4.9.1
     # via feedgen
 mako==1.2.2
     # via alembic
-markdown==3.4.4
+markdown==3.5.1
     # via -r requirements.in
 markupsafe==2.1.1
     # via
@@ -120,7 +120,7 @@ requests==2.31.0
     #   pysolr
 rq==1.15.1
     # via -r requirements.in
-simplejson==3.19.1
+simplejson==3.19.2
     # via -r requirements.in
 six==1.16.0
     # via
@@ -154,7 +154,7 @@ webassets==2.0
     # via -r requirements.in
 webencodings==0.5.1
     # via bleach
-werkzeug[watchdog]==2.3.7
+werkzeug[watchdog]==3.0.1
     # via
     #   -r requirements.in
     #   flask

setup.cfg

@@ -18,9 +18,9 @@ classifiers =
             Development Status :: 5 - Production/Stable
             License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
             Programming Language :: Python
-            Programming Language :: Python :: 3.8
             Programming Language :: Python :: 3.9
             Programming Language :: Python :: 3.10
+            Programming Language :: Python :: 3.11
 
 [options]
 python_requires = >= 3.9

test-infrastructure/docker-compose.yml

@@ -24,7 +24,7 @@ services:
     image: "ckan/ckan-solr:master"
 
   ckan:
-    image: python:3.8-bullseye
+    image: python:3.9-bullseye
     networks:
       - default
     environment: