tutor/tutor/commands/context.py

from ..types import Config


def unimplemented_docker_compose(root: str, config: Config, *command: str) -> int:
    raise NotImplementedError


# pylint: disable=too-few-public-methods
class Context:
    def __init__(self, root: str) -> None:
        self.root = root
        self.docker_compose_func = unimplemented_docker_compose

    def docker_compose(self, root: str, config: Config, *command: str) -> int:
        return self.docker_compose_func(root, config, *command)
refactor: better config type checking I stumbled upon a bug that should have been detected by the type checking. Turns out, considering that config is of type Dict[str, Any] means that we can use just any method on all config values -- which is terrible. I discovered this after I set `config["PLUGINS"] = None`: this triggered a crash when I enabled a plugin. We resolve this by making the Config type more explicit. We also take the opportunity to remove a few cast statements. 2021-04-06 10:09:00 +00:00			`from ..types import Config`
refactor: add type annotations Annotations were generated with pyannotate: https://github.com/dropbox/pyannotate We are running in strict mode, which is awesome! This affects a large part of the code base, which might be an issue for people running a fork of Tutor. Nonetheless, the behavior should not be affected. If anything, this process has helped find and resolve a few type-related bugs. Thus, this is not considered as a breaking change. 2021-02-25 08:09:14 +00:00

refactor: better config type checking I stumbled upon a bug that should have been detected by the type checking. Turns out, considering that config is of type Dict[str, Any] means that we can use just any method on all config values -- which is terrible. I discovered this after I set `config["PLUGINS"] = None`: this triggered a crash when I enabled a plugin. We resolve this by making the Config type more explicit. We also take the opportunity to remove a few cast statements. 2021-04-06 10:09:00 +00:00			`def unimplemented_docker_compose(root: str, config: Config, *command: str) -> int:`
refactor: add type annotations Annotations were generated with pyannotate: https://github.com/dropbox/pyannotate We are running in strict mode, which is awesome! This affects a large part of the code base, which might be an issue for people running a fork of Tutor. Nonetheless, the behavior should not be affected. If anything, this process has helped find and resolve a few type-related bugs. Thus, this is not considered as a breaking change. 2021-02-25 08:09:14 +00:00			`raise NotImplementedError`


More feature-complete dev/local docker-compose commands By de-duplicating the code between dev.py and local.py, we are able to support more docker-compose run/up/stop options passed from tutor. To do so, we had to disable some features, such as automatically mounting the edx-platform repo when the TUTOR_EDX_PLATFORM_PATH environment variable was defined. 2020-01-08 18:38:13 +00:00			`# pylint: disable=too-few-public-methods`
			`class Context:`
refactor: add type annotations Annotations were generated with pyannotate: https://github.com/dropbox/pyannotate We are running in strict mode, which is awesome! This affects a large part of the code base, which might be an issue for people running a fork of Tutor. Nonetheless, the behavior should not be affected. If anything, this process has helped find and resolve a few type-related bugs. Thus, this is not considered as a breaking change. 2021-02-25 08:09:14 +00:00			`def __init__(self, root: str) -> None:`
More feature-complete dev/local docker-compose commands By de-duplicating the code between dev.py and local.py, we are able to support more docker-compose run/up/stop options passed from tutor. To do so, we had to disable some features, such as automatically mounting the edx-platform repo when the TUTOR_EDX_PLATFORM_PATH environment variable was defined. 2020-01-08 18:38:13 +00:00			`self.root = root`
refactor: add type annotations Annotations were generated with pyannotate: https://github.com/dropbox/pyannotate We are running in strict mode, which is awesome! This affects a large part of the code base, which might be an issue for people running a fork of Tutor. Nonetheless, the behavior should not be affected. If anything, this process has helped find and resolve a few type-related bugs. Thus, this is not considered as a breaking change. 2021-02-25 08:09:14 +00:00			`self.docker_compose_func = unimplemented_docker_compose`
refactor: job running methods for clarity and extensibility It made little sense to create dedicated context classes for local/dev. Instead, we create local/dev compose methods which can be easily reused. Also, we renamed the "scripts" module to better reflect its function. 2021-03-13 18:46:44 +00:00
refactor: better config type checking I stumbled upon a bug that should have been detected by the type checking. Turns out, considering that config is of type Dict[str, Any] means that we can use just any method on all config values -- which is terrible. I discovered this after I set `config["PLUGINS"] = None`: this triggered a crash when I enabled a plugin. We resolve this by making the Config type more explicit. We also take the opportunity to remove a few cast statements. 2021-04-06 10:09:00 +00:00			`def docker_compose(self, root: str, config: Config, *command: str) -> int:`
refactor: add type annotations Annotations were generated with pyannotate: https://github.com/dropbox/pyannotate We are running in strict mode, which is awesome! This affects a large part of the code base, which might be an issue for people running a fork of Tutor. Nonetheless, the behavior should not be affected. If anything, this process has helped find and resolve a few type-related bugs. Thus, this is not considered as a breaking change. 2021-02-25 08:09:14 +00:00			`return self.docker_compose_func(root, config, *command)`