tutor 23.0.0.dev3193__tar.gz → 23.0.0.dev3196__tar.gz

tutor-23.0.0.dev3196/.hatch_build.py

@@ -0,0 +1,79 @@
+# https://hatch.pypa.io/latest/how-to/config/dynamic-metadata/
+import os
+import re
+import typing as t
+
+from hatchling.metadata.plugin.interface import MetadataHookInterface
+
+HERE = os.path.dirname(__file__)
+
+# Official plugins listed in requirements/plugins.txt are all hosted under this
+# GitHub organization, in a repository that has the same name as the package.
+PLUGINS_GITHUB_ORG = "https://github.com/overhangio"
+
+# Plugin requirements must be of the form "<name><version specifier>", such as
+# "tutor-mfe>=22.0.0,<23.0.0". Extras, environment markers and URLs are rejected
+# rather than silently dropped when the requirement is rewritten for Tutor Main.
+PLUGIN_REQUIREMENT_REGEX = re.compile(
+    r"^(?P<name>[A-Za-z0-9](?:[A-Za-z0-9._-]*[A-Za-z0-9])?)\s*(?P<specifier>([<>=!~]=?[^;\[\]@]*)?)$"
+)
+
+
+class MetaDataHook(MetadataHookInterface):
+    def update(self, metadata: dict[str, t.Any]) -> None:
+        metadata["dependencies"] = load_requirements("base.in")
+        metadata["optional-dependencies"] = {
+            "dev": load_requirements("dev.txt"),
+            "full": load_plugin_requirements(),
+        }
+
+
+def load_requirements(filename: str) -> list[str]:
+    requirements = []
+    with open(
+        os.path.join(HERE, "requirements", filename), "rt", encoding="utf-8"
+    ) as f:
+        for line in f:
+            line = line.strip()
+            if line != "" and not line.startswith("#"):
+                requirements.append(line)
+    return requirements
+
+
+def load_plugin_requirements() -> list[str]:
+    """
+    Load the official plugin requirements from requirements/plugins.txt.
+
+    That file always pins plugins to PyPI version ranges, on every branch. In
+    Tutor Main (i.e: when the version suffix is "main"), plugins are installed
+    from the main branch of their GitHub repository instead. This is the same
+    mechanism that sets OPENEDX_COMMON_VERSION to "master" in Tutor Main, and it
+    means that plugins.txt does not differ between the main and release
+    branches, so it never conflicts when one is merged into the other.
+    """
+    requirements = load_requirements("plugins.txt")
+    if load_version_suffix() != "main":
+        return requirements
+    main_requirements = []
+    for requirement in requirements:
+        match = PLUGIN_REQUIREMENT_REGEX.match(requirement)
+        if not match:
+            raise ValueError(
+                f"Unsupported plugin requirement: '{requirement}'. Expected "
+                "'<name><version specifier>' with no extras, markers or URL."
+            )
+        name = match.group("name")
+        main_requirements.append(f"{name}@git+{PLUGINS_GITHUB_ORG}/{name}@main")
+    return main_requirements
+
+
+def load_version_suffix() -> str:
+    """
+    Read __version_suffix__ from tutor/__about__.py without importing tutor,
+    which is not installed yet at build time.
+    """
+    with open(os.path.join(HERE, "tutor", "__about__.py"), encoding="utf-8") as f:
+        match = re.search(r'^__version_suffix__ = "([^"]*)"', f.read(), re.MULTILINE)
+    if not match:
+        raise ValueError("Could not find __version_suffix__ in tutor/__about__.py")
+    return match.group(1)

{tutor-23.0.0.dev3193 → tutor-23.0.0.dev3196}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: tutor
-Version: 23.0.0.dev3193
+Version: 23.0.0.dev3196
 Summary: The Docker-based Open edX distribution designed for peace of mind
 Project-URL: Homepage, https://docs.tutor.edly.io/
 Project-URL: Documentation, https://docs.tutor.edly.io/
@@ -24,7 +24,7 @@ Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
 Requires-Python: >=3.10
 Requires-Dist: appdirs
-Requires-Dist: click<8.3.0,>=8.0
+Requires-Dist: click>=8.4
 Requires-Dist: importlib-metadata>=7.0.1
 Requires-Dist: importlib-resources>=6.1.1
 Requires-Dist: jinja2>=2.10
@@ -44,7 +44,7 @@ Requires-Dist: cachetools==5.5.2; extra == 'dev'
 Requires-Dist: certifi==2025.8.3; extra == 'dev'
 Requires-Dist: charset-normalizer==3.4.7; extra == 'dev'
 Requires-Dist: click-log==0.4.0; extra == 'dev'
-Requires-Dist: click==8.1.8; extra == 'dev'
+Requires-Dist: click==8.5.0; extra == 'dev'
 Requires-Dist: coverage==7.10.7; extra == 'dev'
 Requires-Dist: docutils==0.22.4; extra == 'dev'
 Requires-Dist: durationpy==0.10; extra == 'dev'

{tutor-23.0.0.dev3193 → tutor-23.0.0.dev3196}/requirements/base.in

@@ -1,6 +1,5 @@
 appdirs
-# TODO: remove 8.3.0 when https://github.com/overhangio/tutor/issues/1276 is resolved completely
-click>=8.0,<8.3.0
+click>=8.4
 jinja2>=2.10
 kubernetes
 mypy

{tutor-23.0.0.dev3193 → tutor-23.0.0.dev3196}/requirements/dev.txt

@@ -29,7 +29,7 @@ charset-normalizer==3.4.7
     # via
     #   -r requirements/base.txt
     #   requests
-click==8.1.8
+click==8.5.0
     # via
     #   -r requirements/base.txt
     #   click-log

{tutor-23.0.0.dev3193 → tutor-23.0.0.dev3196}/tutor/commands/config.py

@@ -12,7 +12,7 @@ from tutor import config as tutor_config
 from tutor import env, exceptions, fmt, hooks, serialize, utils
 from tutor import interactive as interactive_config
 from tutor.commands.context import Context
-from tutor.commands.params import ConfigLoaderParam
+from tutor.commands.params import ConfigLoaderParam, ParamValue
 from tutor.types import Config, ConfigValue
 
 
@@ -25,7 +25,7 @@ def config_command() -> None:
     pass
 
 
-class ConfigKeyParamType(ConfigLoaderParam):
+class ConfigKeyParamType(ConfigLoaderParam[ParamValue]):
     name = "configkey"
 
     def shell_complete(
@@ -49,7 +49,7 @@ class ConfigKeyParamType(ConfigLoaderParam):
         yield from self.config.items()
 
 
-class ConfigKeyValParamType(ConfigKeyParamType):
+class ConfigKeyValParamType(ConfigKeyParamType[tuple[str, t.Any]]):
     """
     Parser for <KEY>=<YAML VALUE> command line arguments.
     """
@@ -131,7 +131,7 @@ class ConfigListKeyValParamType(ConfigKeyValParamType):
     "--unset",
     "unset_vars",
     multiple=True,
-    type=ConfigKeyParamType(),
+    type=ConfigKeyParamType[str](),
     help="Remove a configuration value (can be used multiple times)",
 )
 @click.option(
@@ -221,7 +221,7 @@ def printroot(context: Context) -> None:
 
 
 @click.command(help="Print a configuration value")
-@click.argument("key", type=ConfigKeyParamType())
+@click.argument("key", type=ConfigKeyParamType[str]())
 @click.pass_obj
 def printvalue(context: Context, key: str) -> None:
     config = tutor_config.load(context.root)

{tutor-23.0.0.dev3193 → tutor-23.0.0.dev3196}/tutor/commands/images.py

@@ -88,7 +88,7 @@ def _add_core_images_to_push(
     return remote_images
 
 
-class ImageNameParam(ConfigLoaderParam):
+class ImageNameParam(ConfigLoaderParam[str]):
     """
     Convenient auto-completion of image names.
     """

{tutor-23.0.0.dev3193 → tutor-23.0.0.dev3196}/tutor/commands/mounts.py

@@ -12,7 +12,7 @@ from tutor.commands.context import Context
 from tutor.commands.params import ConfigLoaderParam
 
 
-class MountParamType(ConfigLoaderParam):
+class MountParamType(ConfigLoaderParam[str]):
     name = "mount"
 
     def shell_complete(

{tutor-23.0.0.dev3193 → tutor-23.0.0.dev3196}/tutor/commands/params.py

@@ -6,8 +6,12 @@ from tutor import config as tutor_config
 from tutor import hooks
 from tutor.types import Config
 
+# Type of the value produced by the param type `convert` method. Since click 8.4,
+# `click.ParamType` is generic and must be parameterized with that type.
+ParamValue = t.TypeVar("ParamValue")
 
-class ConfigLoaderParam(click.ParamType):
+
+class ConfigLoaderParam(click.ParamType[ParamValue]):
     """
     Convenient param child class that automatically loads the user configuration on auto-complete.
     """

{tutor-23.0.0.dev3193 → tutor-23.0.0.dev3196}/tutor/commands/plugins.py

@@ -19,7 +19,7 @@ from tutor.types import Config
 from .context import Context
 
 
-class PluginName(click.ParamType):
+class PluginName(click.ParamType[str]):
     """
     Convenient param type that supports autocompletion of installed plugin names.
     """
@@ -44,7 +44,7 @@ class PluginName(click.ParamType):
         return [name for name in candidates if name.startswith(incomplete)]
 
 
-class IndexPluginName(click.ParamType):
+class IndexPluginName(click.ParamType[str]):
     """
     Param type for auto-completion of plugin names found in index cache.
     """

tutor-23.0.0.dev3193/.hatch_build.py

@@ -1,28 +0,0 @@
-# https://hatch.pypa.io/latest/how-to/config/dynamic-metadata/
-import os
-import typing as t
-
-from hatchling.metadata.plugin.interface import MetadataHookInterface
-
-HERE = os.path.dirname(__file__)
-
-
-class MetaDataHook(MetadataHookInterface):
-    def update(self, metadata: dict[str, t.Any]) -> None:
-        metadata["dependencies"] = load_requirements("base.in")
-        metadata["optional-dependencies"] = {
-            "dev": load_requirements("dev.txt"),
-            "full": load_requirements("plugins.txt"),
-        }
-
-
-def load_requirements(filename: str) -> list[str]:
-    requirements = []
-    with open(
-        os.path.join(HERE, "requirements", filename), "rt", encoding="utf-8"
-    ) as f:
-        for line in f:
-            line = line.strip()
-            if line != "" and not line.startswith("#"):
-                requirements.append(line)
-    return requirements