xblock-free-text-response | Drop py3.8 support | replace pkg_resource with importlib.resources

.github/workflows/ci.yml

@@ -15,8 +15,8 @@ jobs:
       matrix:
         os: [ubuntu-20.04]
         python-version:
-        - '3.8'
         - '3.11'
+        - '3.12'
         toxenv: [django42, quality, csslint, eslint, translations_validate]
 
     steps:

.github/workflows/pypi-publish.yml

@@ -15,7 +15,7 @@ jobs:
       - name: setup python
         uses: actions/setup-python@v3
         with:
-          python-version: 3.8
+          python-version: 3.12
 
       - name: Install pip
         run: pip install -r requirements/pip.txt

CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## Version 5.0.0
+* Added python 3.12 support. Dropped python 3.8 support.
+
 ## Version 4.1.0
 * Added python 3.11 support. Dropped django32 support.
 

freetextresponse/__init__.py

@@ -4,4 +4,4 @@
 present in order for the student to receive credit.
 """
 
-__version__ = "4.1.0"
+__version__ = "5.0.0"

freetextresponse/mixins/fragment.py

@@ -4,11 +4,18 @@
 Note: We should resume test coverage for all lines in this file once
 split into its own library.
 """
-import pkg_resources
-
 from xblock.core import XBlock
 from web_fragments.fragment import Fragment
 
+try:
+    from xblock.utils.resources import ResourceLoader
+except ModuleNotFoundError:
+    # For backward compatibility with releases older than Quince.
+    from xblockutils.resources import ResourceLoader
+
+
+loader = ResourceLoader(__name__)
+
 
 class XBlockFragmentBuilderMixin(object):
     """
@@ -81,8 +88,7 @@ def build_fragment(
                 fragment.add_css_url(url)
             else:
                 item = '../public/' + item
-                data = pkg_resources.resource_string(__name__, item)
-                data = data.decode('utf8')
+                data = loader.load_unicode(item)
                 fragment.add_css(data)
         for item in js:
             item = 'public/' + item

freetextresponse/mixins/scenario.py

@@ -1,56 +1,13 @@
 """
 Mixin workbench behavior into XBlocks
 """
-from glob import glob
-import pkg_resources
+try:
+    from xblock.utils.resources import ResourceLoader
+except ModuleNotFoundError:
+    from xblockutils.resources import ResourceLoader
 
 
-def _read_file(file_path):
-    """
-    Read in a file's contents
-    """
-    with open(file_path) as file_input:
-        file_contents = file_input.read()
-    return file_contents
-
-
-def _parse_title(file_path):
-    """
-    Parse a title from a file name
-    """
-    title = file_path
-    title = title.split('/')[-1]
-    title = '.'.join(title.split('.')[:-1])
-    title = ' '.join(title.split('-'))
-    title = ' '.join([
-        word.capitalize()
-        for word in title.split(' ')
-    ])
-    return title
-
-
-def _read_files(files):
-    """
-    Read the contents of a list of files
-    """
-    file_contents = [
-        (
-            _parse_title(file_path),
-            _read_file(file_path),
-        )
-        for file_path in files
-    ]
-    return file_contents
-
-
-def _find_files(directory):
-    """
-    Find XML files in the directory
-    """
-    pattern = f"{directory}/*.xml"
-
-    files = glob(pattern)
-    return files
+loader = ResourceLoader(__name__)
 
 
 class XBlockWorkbenchMixin(object):
@@ -63,9 +20,4 @@ def workbench_scenarios(cls):
         """
         Gather scenarios to be displayed in the workbench
         """
-        module = cls.__module__
-        module = module.split('.', maxsplit=1)[0]
-        directory = pkg_resources.resource_filename(module, 'scenarios')
-        files = _find_files(directory)
-        scenarios = _read_files(files)
-        return scenarios
+        return loader.load_scenarios_from_path("../scenarios")

requirements/base.txt

@@ -1,5 +1,5 @@
 #
-# This file is autogenerated by pip-compile with Python 3.8
+# This file is autogenerated by pip-compile with Python 3.11
 # by the following command:
 #
 #    make upgrade
@@ -8,11 +8,7 @@ appdirs==1.4.4
     # via fs
 asgiref==3.8.1
     # via django
-backports-zoneinfo==0.2.1 ; python_version < "3.9"
-    # via
-    #   -c requirements/constraints.txt
-    #   django
-django==4.2.11
+django==4.2.16
     # via
     #   -c requirements/common_constraints.txt
     #   -r requirements/base.in
@@ -22,34 +18,32 @@ lxml==4.9.4
     # via
     #   -c requirements/constraints.txt
     #   xblock
-mako==1.3.2
+mako==1.3.5
     # via xblock
 markupsafe==2.1.5
     # via
     #   mako
     #   xblock
 python-dateutil==2.9.0.post0
     # via xblock
-pytz==2024.1
+pytz==2024.2
     # via xblock
-pyyaml==6.0.1
+pyyaml==6.0.2
     # via xblock
-simplejson==3.19.2
+simplejson==3.19.3
     # via xblock
 six==1.16.0
     # via
     #   -r requirements/base.in
     #   fs
     #   python-dateutil
-sqlparse==0.4.4
+sqlparse==0.5.1
     # via django
-typing-extensions==4.10.0
-    # via asgiref
 web-fragments==2.2.0
     # via xblock
-webob==1.8.7
+webob==1.8.8
     # via xblock
-xblock==3.1.0
+xblock==5.1.0
     # via -r requirements/base.in
 
 # The following packages are considered to be unsafe in a requirements file:

requirements/ci.txt

@@ -1,14 +1,14 @@
 #
-# This file is autogenerated by pip-compile with Python 3.8
+# This file is autogenerated by pip-compile with Python 3.11
 # by the following command:
 #
 #    make upgrade
 #
-cachetools==5.3.3
+cachetools==5.5.0
     # via
     #   -r requirements/tox.txt
     #   tox
-certifi==2024.2.2
+certifi==2024.8.30
     # via requests
 chardet==5.2.0
     # via
@@ -20,53 +20,48 @@ colorama==0.4.6
     # via
     #   -r requirements/tox.txt
     #   tox
-coverage==6.5.0
+coverage[toml]==7.6.1
     # via coveralls
-coveralls==3.3.1
+coveralls==4.0.1
     # via -r requirements/ci.in
 distlib==0.3.8
     # via
     #   -r requirements/tox.txt
     #   virtualenv
 docopt==0.6.2
     # via coveralls
-filelock==3.13.3
+filelock==3.16.0
     # via
     #   -r requirements/tox.txt
     #   tox
     #   virtualenv
-idna==3.6
+idna==3.8
     # via requests
-packaging==24.0
+packaging==24.1
     # via
     #   -r requirements/tox.txt
     #   pyproject-api
     #   tox
-platformdirs==4.2.0
+platformdirs==4.3.2
     # via
     #   -r requirements/tox.txt
     #   tox
     #   virtualenv
-pluggy==1.4.0
+pluggy==1.5.0
     # via
     #   -r requirements/tox.txt
     #   tox
-pyproject-api==1.6.1
+pyproject-api==1.7.1
     # via
     #   -r requirements/tox.txt
     #   tox
-requests==2.31.0
+requests==2.32.3
     # via coveralls
-tomli==2.0.1
-    # via
-    #   -r requirements/tox.txt
-    #   pyproject-api
-    #   tox
-tox==4.14.2
+tox==4.18.1
     # via -r requirements/tox.txt
-urllib3==2.2.1
+urllib3==2.2.2
     # via requests
-virtualenv==20.25.1
+virtualenv==20.26.4
     # via
     #   -r requirements/tox.txt
     #   tox

requirements/pip.txt

@@ -1,14 +1,14 @@
 #
-# This file is autogenerated by pip-compile with Python 3.8
+# This file is autogenerated by pip-compile with Python 3.11
 # by the following command:
 #
 #    make upgrade
 #
-wheel==0.43.0
+wheel==0.44.0
     # via -r requirements/pip.in
 
 # The following packages are considered to be unsafe in a requirements file:
-pip==24.0
+pip==24.2
     # via -r requirements/pip.in
-setuptools==69.2.0
+setuptools==74.1.2
     # via -r requirements/pip.in

requirements/pip_tools.txt

@@ -1,34 +1,23 @@
 #
-# This file is autogenerated by pip-compile with Python 3.8
+# This file is autogenerated by pip-compile with Python 3.11
 # by the following command:
 #
 #    make upgrade
 #
-build==1.2.1
+build==1.2.2
     # via pip-tools
 click==8.1.7
     # via pip-tools
-importlib-metadata==6.11.0
-    # via
-    #   -c requirements/common_constraints.txt
-    #   build
-packaging==24.0
+packaging==24.1
     # via build
 pip-tools==7.4.1
     # via -r requirements/pip_tools.in
-pyproject-hooks==1.0.0
-    # via
-    #   build
-    #   pip-tools
-tomli==2.0.1
+pyproject-hooks==1.1.0
     # via
     #   build
     #   pip-tools
-    #   pyproject-hooks
-wheel==0.43.0
+wheel==0.44.0
     # via pip-tools
-zipp==3.18.1
-    # via importlib-metadata
 
 # The following packages are considered to be unsafe in a requirements file:
 # pip