Skip to content

Commit ae8d5b6

Browse files
jeertmansjeertmans
committed
chore(lib): re-organizing the module
This PR refactors a lot of the code in order to have a better organized codebase. If will that I needed to create a second level of submodules, to better distinguish the different parts of this project.
1 parent c3e1aa0 commit ae8d5b6

32 files changed

+394
-220
lines changed

‎docs/source/faq.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ This will also show the default value for each option.
9494
If you want to create your own template, the best is to start from the default one.
9595

9696
You can either download it from the
97-
[template folder](https://github.com/jeertmans/manim-slides/tree/main/manim_slides/templates)
97+
[template folder](https://github.com/jeertmans/manim-slides/tree/main/manim_slides/cli/convert/templates)
9898
or use the `manim-slides convert --to=FORMAT --show-template` command,
9999
where `FORMAT` is one of the supported formats.
100100

‎docs/source/reference/cli.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This page contains an exhaustive list of all the commands available with `manim-
44

55

66
```{eval-rst}
7-
.. click:: manim_slides.__main__:cli
7+
.. click:: manim_slides.cli.commands:main
88
:prog: manim-slides
99
:nested: full
1010
```

‎docs/source/reference/customize_html.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ One of the benefits of the `convert` command is the use of template files.
44

55
Currently, only the HTML export uses one. If not specified, the template
66
will be the one shipped with Manim Slides, see
7-
[`manim_slides/templates/revealjs.html`](https://github.com/jeertmans/manim-slides/blob/main/manim_slides/templates/revealjs.html).
7+
[`manim_slides/cli/convert/templates/revealjs.html`](https://github.com/jeertmans/manim-slides/blob/main/manim_slides/cli/convert/templates/revealjs.html).
88

99
Because you can actually use your own template with the `--use-template`
1010
option, possibilities are infinite!

‎docs/source/reference/html.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ manim-slides convert --show-config
3030
## Using a Custom Template
3131

3232
The default template used for HTML conversion can be found on
33-
[GitHub](https://github.com/jeertmans/manim-slides/blob/main/manim_slides/templates/revealjs.html)
33+
[GitHub](https://github.com/jeertmans/manim-slides/blob/main/manim_slides/cli/convert/templates/revealjs.html)
3434
or printed with the `--show-template` option.
3535
If you wish to use another template, you can do so with the
3636
`--use-template FILE` option.

‎manim_slides/__init__.py‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
"""
2+
Manim Slides module.
3+
4+
Submodules are lazily imported, in order to provide a faster import experience
5+
in some cases.
6+
"""
7+
18
import sys
29
from types import ModuleType
310
from typing import Any
@@ -8,9 +15,7 @@
815
class Module(ModuleType):
916
def __getattr__(self, name: str) -> Any:
1017
if name == "Slide" or name == "ThreeDSlide":
11-
module = __import__(
12-
"manim_slides.slide", None, None, ["Slide", "ThreeDSlide"]
13-
)
18+
module = __import__("manim_slides.slide", None, None, [name])
1419
return getattr(module, name)
1520
elif name == "ManimSlidesMagic":
1621
module = __import__(

‎manim_slides/__main__.py‎

Lines changed: 3 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -1,73 +1,6 @@
1-
import json
1+
"""Manim Slides' main entrypoint."""
22

3-
import click
4-
import requests
5-
from click_default_group import DefaultGroup
6-
7-
from .__version__ import __version__
8-
from .convert import convert
9-
from .logger import logger
10-
from .present import list_scenes, present
11-
from .render import render
12-
from .wizard import init, wizard
13-
14-
15-
@click.group(cls=DefaultGroup, default="present", default_if_no_args=True)
16-
@click.option(
17-
"--notify-outdated-version/--silent",
18-
" /-S",
19-
is_flag=True,
20-
default=True,
21-
help="Check if a new version of Manim Slides is available.",
22-
)
23-
@click.version_option(__version__, "-v", "--version")
24-
@click.help_option("-h", "--help")
25-
def cli(notify_outdated_version: bool) -> None:
26-
"""
27-
Manim Slides command-line utilities.
28-
29-
If no command is specified, defaults to `present`.
30-
"""
31-
# Code below is mostly a copy from:
32-
# https://github.com/ManimCommunity/manim/blob/main/manim/cli/render/commands.py
33-
if notify_outdated_version:
34-
manim_info_url = "https://pypi.org/pypi/manim-slides/json"
35-
warn_prompt = "Cannot check if latest release of Manim Slides is installed"
36-
try:
37-
req_info: requests.models.Response = requests.get(manim_info_url, timeout=2)
38-
req_info.raise_for_status()
39-
stable = req_info.json()["info"]["version"]
40-
if stable != __version__:
41-
click.echo(
42-
"You are using Manim Slides version "
43-
+ click.style(f"v{__version__}", fg="red")
44-
+ ", but version "
45-
+ click.style(f"v{stable}", fg="green")
46-
+ " is available."
47-
)
48-
click.echo(
49-
"You should consider upgrading via "
50-
+ click.style("pip install -U manim-slides", fg="yellow")
51-
)
52-
except requests.exceptions.HTTPError:
53-
logger.debug(f"HTTP Error: {warn_prompt}")
54-
except requests.exceptions.ConnectionError:
55-
logger.debug(f"Connection Error: {warn_prompt}")
56-
except requests.exceptions.Timeout:
57-
logger.debug(f"Timed Out: {warn_prompt}")
58-
except json.JSONDecodeError:
59-
logger.debug(warn_prompt)
60-
logger.debug(f"Error decoding JSON from {manim_info_url}")
61-
except Exception:
62-
logger.debug(f"Something went wrong: {warn_prompt}")
63-
64-
65-
cli.add_command(convert)
66-
cli.add_command(init)
67-
cli.add_command(list_scenes)
68-
cli.add_command(present)
69-
cli.add_command(render)
70-
cli.add_command(wizard)
3+
from .cli.commands import main
714

725
if __name__ == "__main__":
73-
cli()
6+
main()

‎manim_slides/__version__.py‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
1+
"""Manim Slides' version."""
2+
13
__version__ = "5.1.7"

‎manim_slides/cli/commands.py‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
"""Manim Slides' CLI."""
2+
3+
import json
4+
5+
import click
6+
import requests
7+
from click_default_group import DefaultGroup
8+
9+
from ..__version__ import __version__
10+
from ..core.logger import logger
11+
from .convert.commands import convert
12+
from .present.commands import list_scenes, present
13+
from .render.commands import render
14+
from .wizard.commands import init, wizard
15+
16+
17+
@click.group(cls=DefaultGroup, default="present", default_if_no_args=True)
18+
@click.option(
19+
"--notify-outdated-version/--silent",
20+
" /-S",
21+
is_flag=True,
22+
default=True,
23+
help="Check if a new version of Manim Slides is available.",
24+
)
25+
@click.version_option(__version__, "-v", "--version")
26+
@click.help_option("-h", "--help")
27+
def main(notify_outdated_version: bool) -> None:
28+
"""
29+
Manim Slides command-line utilities.
30+
31+
If no command is specified, defaults to `present`.
32+
"""
33+
# Code below is mostly a copy from:
34+
# https://github.com/ManimCommunity/manim/blob/main/manim/cli/render/commands.py
35+
if notify_outdated_version:
36+
manim_info_url = "https://pypi.org/pypi/manim-slides/json"
37+
warn_prompt = "Cannot check if latest release of Manim Slides is installed"
38+
try:
39+
req_info: requests.models.Response = requests.get(manim_info_url, timeout=2)
40+
req_info.raise_for_status()
41+
stable = req_info.json()["info"]["version"]
42+
if stable != __version__:
43+
click.echo(
44+
"You are using Manim Slides version "
45+
+ click.style(f"v{__version__}", fg="red")
46+
+ ", but version "
47+
+ click.style(f"v{stable}", fg="green")
48+
+ " is available."
49+
)
50+
click.echo(
51+
"You should consider upgrading via "
52+
+ click.style("pip install -U manim-slides", fg="yellow")
53+
)
54+
except requests.exceptions.HTTPError:
55+
logger.debug(f"HTTP Error: {warn_prompt}")
56+
except requests.exceptions.ConnectionError:
57+
logger.debug(f"Connection Error: {warn_prompt}")
58+
except requests.exceptions.Timeout:
59+
logger.debug(f"Timed Out: {warn_prompt}")
60+
except json.JSONDecodeError:
61+
logger.debug(warn_prompt)
62+
logger.debug(f"Error decoding JSON from {manim_info_url}")
63+
except Exception:
64+
logger.debug(f"Something went wrong: {warn_prompt}")
65+
66+
67+
main.add_command(convert)
68+
main.add_command(init)
69+
main.add_command(list_scenes)
70+
main.add_command(present)
71+
main.add_command(render)
72+
main.add_command(wizard)

‎manim_slides/commons.py‎ renamed to ‎manim_slides/cli/commons.py‎

Lines changed: 65 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,9 @@
44
import click
55
from click import Context, Parameter
66

7-
from .defaults import CONFIG_PATH, FOLDER_PATH
8-
from .logger import logger
7+
from ..core.config import list_presentation_configs
8+
from ..core.defaults import CONFIG_PATH, FOLDER_PATH
9+
from ..core.logger import logger
910

1011
F = Callable[..., Any]
1112
Wrapper = Callable[[F], F]
@@ -88,6 +89,68 @@ def callback(ctx: Context, param: Parameter, value: Path) -> Path:
8889
callback=callback,
8990
help="Set slides folder.",
9091
show_default=True,
92+
is_eager=True, # Needed to expose its value to other callbacks
9193
)
9294

9395
return wrapper(function)
96+
97+
98+
def scenes_argument(function: F) -> F:
99+
"""
100+
Wrap a function to add a scenes arguments.
101+
102+
This function assumes that :func:`folder_path_option` is also used
103+
on the same decorated function.
104+
"""
105+
106+
def callback(ctx: Context, param: Parameter, value: tuple[str]) -> list[Path]:
107+
folder: Path = ctx.params.get("folder")
108+
109+
presentation_config_paths = list_presentation_configs(folder)
110+
scene_names = [path.stem for path in presentation_config_paths]
111+
num_scenes = len(scene_names)
112+
num_digits = len(str(num_scenes))
113+
114+
if num_scenes == 0:
115+
raise click.UsageError(
116+
f"Folder {folder} does not contain "
117+
"any valid config file, did you render the animations first?"
118+
)
119+
120+
paths = []
121+
122+
if value:
123+
for scene_name in value:
124+
try:
125+
i = scene_names.index(scene_name)
126+
paths.append(presentation_config_paths[i])
127+
except ValueError:
128+
raise click.UsageError(
129+
f"Could not find scene `{scene_name}` in: "
130+
+ ", ".join(scene_names)
131+
+ ". Did you make a typo or forgot to render the animations first?"
132+
) from None
133+
else:
134+
click.echo(
135+
"Choose at least one or more scenes from "
136+
"(enter the corresponding number):\n"
137+
+ "\n".join(
138+
f"- {i:{num_digits}d}: {name}"
139+
for i, name in enumerate(scene_names, start=1)
140+
)
141+
)
142+
continue_prompt = True
143+
while continue_prompt:
144+
index = click.prompt(
145+
"Please enter a value", type=click.IntRange(1, num_scenes)
146+
)
147+
paths.append(presentation_config_paths[index - 1])
148+
continue_prompt = click.confirm(
149+
"Do you want to enter an additional scene?"
150+
)
151+
152+
return paths
153+
154+
wrapper: Wrapper = click.argument("scenes", nargs=-1, callback=callback)
155+
156+
return wrapper(function)

‎manim_slides/templates/__init__.py‎ renamed to ‎manim_slides/cli/convert/__init__.py‎

File renamed without changes.

0 commit comments

Comments
 (0)