feat: XBlock.usage_key, XBlock.context_key convenience props

Adds opaque-keys as a dependency for some new unit tests.
Normally I wouldn't add a dependency just for a couple tests,
but we anticipate to make the repo depend on opaque-keys soon
anyway:

* #707
* #708

Bumps version from 1.9.1 to 1.10.0

CHANGELOG.rst

@@ -7,6 +7,14 @@ These are notable changes in XBlock.
 Unreleased
 ----------
 
+1.10.0 - 2024-01-12
+-------------------
+
+* Add two new properties to ``XBlock`` objects: ``.usage_key`` and ``.context_key``.
+  These simply expose the values of ``.scope_ids.usage_id`` and ``.scope_ids.usage_id.context_key``,
+  providing a convenient replacement to the deprecated, edx-platform-specific block properties ``.location``
+  and ``.course_id``, respectively.
+
 1.9.1 - 2023-12-22
 ------------------
 

requirements/base.in

@@ -1,6 +1,7 @@
 # Core requirements for using this package
 -c constraints.txt
 
+edx-opaque-keys
 fs
 lxml
 mako

requirements/base.txt

@@ -6,16 +6,22 @@
 #
 appdirs==1.4.4
     # via fs
+edx-opaque-keys==2.5.1
+    # via -r requirements/base.in
 fs==2.4.16
     # via -r requirements/base.in
-lxml==5.0.0
+lxml==5.1.0
     # via -r requirements/base.in
 mako==1.3.0
     # via -r requirements/base.in
 markupsafe==2.1.3
     # via
     #   -r requirements/base.in
     #   mako
+pbr==6.0.0
+    # via stevedore
+pymongo==3.13.0
+    # via edx-opaque-keys
 python-dateutil==2.8.2
     # via -r requirements/base.in
 pytz==2023.3.post1
@@ -28,6 +34,10 @@ six==1.16.0
     # via
     #   fs
     #   python-dateutil
+stevedore==5.1.0
+    # via edx-opaque-keys
+typing-extensions==4.9.0
+    # via edx-opaque-keys
 web-fragments==2.1.0
     # via -r requirements/base.in
 webob==1.8.7

requirements/ci.txt

@@ -34,7 +34,7 @@ tomli==2.0.1
     # via
     #   pyproject-api
     #   tox
-tox==4.11.4
+tox==4.12.0
     # via -r requirements/ci.in
 virtualenv==20.25.0
     # via tox

requirements/dev.txt

@@ -17,15 +17,15 @@ astroid==3.0.2
     #   -r requirements/test.txt
     #   pylint
     #   pylint-celery
-attrs==23.1.0
+attrs==23.2.0
     # via
     #   -r requirements/test.txt
     #   hypothesis
-boto3==1.34.11
+boto3==1.34.17
     # via
     #   -r requirements/test.txt
     #   fs-s3fs
-botocore==1.34.11
+botocore==1.34.17
     # via
     #   -r requirements/test.txt
     #   boto3
@@ -71,7 +71,7 @@ coverage[toml]==7.4.0
     #   -r requirements/test.txt
     #   coverage
     #   pytest-cov
-ddt==1.7.0
+ddt==1.7.1
     # via -r requirements/test.txt
 diff-cover==4.0.0
     # via
@@ -93,6 +93,8 @@ django==2.2.28
     #   openedx-django-pyfs
 edx-lint==5.3.6
     # via -r requirements/test.txt
+edx-opaque-keys==2.5.1
+    # via -r requirements/test.txt
 exceptiongroup==1.2.0
     # via
     #   -r requirements/test.txt
@@ -113,7 +115,7 @@ fs-s3fs==1.1.1
     # via
     #   -r requirements/test.txt
     #   openedx-django-pyfs
-hypothesis==6.92.2
+hypothesis==6.92.9
     # via -r requirements/test.txt
 importlib-metadata==7.0.1
     # via
@@ -131,7 +133,7 @@ isort==5.13.2
     # via
     #   -r requirements/test.txt
     #   pylint
-jinja2==3.1.2
+jinja2==3.1.3
     # via
     #   -r requirements/test.txt
     #   code-annotations
@@ -148,7 +150,7 @@ jmespath==1.0.1
     #   botocore
 lazy==1.6
     # via -r requirements/test.txt
-lxml==5.0.0
+lxml==5.1.0
     # via -r requirements/test.txt
 mako==1.3.0
     # via -r requirements/test.txt
@@ -230,6 +232,10 @@ pylint-plugin-utils==0.8.2
     #   -r requirements/test.txt
     #   pylint-celery
     #   pylint-django
+pymongo==3.13.0
+    # via
+    #   -r requirements/test.txt
+    #   edx-opaque-keys
 pyproject-api==1.6.1
     # via
     #   -r requirements/ci.txt
@@ -239,7 +245,7 @@ pyproject-hooks==1.0.0
     # via
     #   -r requirements/pip-tools.txt
     #   build
-pytest==7.4.3
+pytest==7.4.4
     # via
     #   -r requirements/test.txt
     #   pytest-cov
@@ -289,6 +295,7 @@ stevedore==5.1.0
     # via
     #   -r requirements/test.txt
     #   code-annotations
+    #   edx-opaque-keys
 text-unidecode==1.3
     # via
     #   -r requirements/test.txt
@@ -310,7 +317,7 @@ tomlkit==0.12.3
     # via
     #   -r requirements/test.txt
     #   pylint
-tox==4.11.4
+tox==4.12.0
     # via
     #   -r requirements/ci.txt
     #   -r requirements/test.txt
@@ -319,6 +326,7 @@ typing-extensions==4.9.0
     #   -r requirements/test.txt
     #   annotated-types
     #   astroid
+    #   edx-opaque-keys
     #   inflect
     #   pydantic
     #   pydantic-core

requirements/django.txt

@@ -8,9 +8,9 @@ appdirs==1.4.4
     # via
     #   -r requirements/base.txt
     #   fs
-boto3==1.34.11
+boto3==1.34.17
     # via fs-s3fs
-botocore==1.34.11
+botocore==1.34.17
     # via
     #   boto3
     #   s3transfer
@@ -19,6 +19,8 @@ django==2.2.28
     #   -c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt
     #   -r requirements/django.in
     #   openedx-django-pyfs
+edx-opaque-keys==2.5.1
+    # via -r requirements/base.txt
 fs==2.4.16
     # via
     #   -r requirements/base.txt
@@ -32,7 +34,7 @@ jmespath==1.0.1
     #   botocore
 lazy==1.6
     # via -r requirements/django.in
-lxml==5.0.0
+lxml==5.1.0
     # via -r requirements/base.txt
 mako==1.3.0
     # via -r requirements/base.txt
@@ -42,6 +44,14 @@ markupsafe==2.1.3
     #   mako
 openedx-django-pyfs==3.4.1
     # via -r requirements/django.in
+pbr==6.0.0
+    # via
+    #   -r requirements/base.txt
+    #   stevedore
+pymongo==3.13.0
+    # via
+    #   -r requirements/base.txt
+    #   edx-opaque-keys
 python-dateutil==2.8.2
     # via
     #   -r requirements/base.txt
@@ -64,6 +74,14 @@ six==1.16.0
     #   python-dateutil
 sqlparse==0.4.4
     # via django
+stevedore==5.1.0
+    # via
+    #   -r requirements/base.txt
+    #   edx-opaque-keys
+typing-extensions==4.9.0
+    # via
+    #   -r requirements/base.txt
+    #   edx-opaque-keys
 urllib3==1.26.18
     # via botocore
 web-fragments==2.1.0

requirements/doc.txt

@@ -18,11 +18,11 @@ babel==2.14.0
     #   sphinx
 beautifulsoup4==4.12.2
     # via pydata-sphinx-theme
-boto3==1.34.11
+boto3==1.34.17
     # via
     #   -r requirements/django.txt
     #   fs-s3fs
-botocore==1.34.11
+botocore==1.34.17
     # via
     #   -r requirements/django.txt
     #   boto3
@@ -40,6 +40,8 @@ docutils==0.19
     # via
     #   pydata-sphinx-theme
     #   sphinx
+edx-opaque-keys==2.5.1
+    # via -r requirements/django.txt
 fs==2.4.16
     # via
     #   -r requirements/django.txt
@@ -55,7 +57,7 @@ imagesize==1.4.1
     # via sphinx
 importlib-metadata==7.0.1
     # via sphinx
-jinja2==3.1.2
+jinja2==3.1.3
     # via sphinx
 jmespath==1.0.1
     # via
@@ -64,7 +66,7 @@ jmespath==1.0.1
     #   botocore
 lazy==1.6
     # via -r requirements/django.txt
-lxml==5.0.0
+lxml==5.1.0
     # via -r requirements/django.txt
 mako==1.3.0
     # via -r requirements/django.txt
@@ -81,13 +83,21 @@ packaging==23.2
     # via
     #   pydata-sphinx-theme
     #   sphinx
+pbr==6.0.0
+    # via
+    #   -r requirements/django.txt
+    #   stevedore
 pydata-sphinx-theme==0.14.4
     # via sphinx-book-theme
 pygments==2.17.2
     # via
     #   accessible-pygments
     #   pydata-sphinx-theme
     #   sphinx
+pymongo==3.13.0
+    # via
+    #   -r requirements/django.txt
+    #   edx-opaque-keys
 python-dateutil==2.8.2
     # via
     #   -r requirements/django.txt
@@ -140,8 +150,15 @@ sqlparse==0.4.4
     # via
     #   -r requirements/django.txt
     #   django
+stevedore==5.1.0
+    # via
+    #   -r requirements/django.txt
+    #   edx-opaque-keys
 typing-extensions==4.9.0
-    # via pydata-sphinx-theme
+    # via
+    #   -r requirements/django.txt
+    #   edx-opaque-keys
+    #   pydata-sphinx-theme
 urllib3==1.26.18
     # via
     #   -r requirements/django.txt