Skip to content

Module creation and CLI interface cleaning #4342

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

OliverStrait
Copy link
Contributor

@OliverStrait OliverStrait commented Jul 21, 2025

Overview: What does this pull request change?

Cleaning and documenting Runtime module creation and Scene-class search

  • Old version had knowledge of Scene and did had CLI control flow baked in.
  • New version put CLI control flow back into caller file. Module creation does only one job.
  • New functions are type agnostig and generic

Version checker:

  • Old checker connects to internet every time when rendering is stopped
  • New version caches information into file and fetch information from internet only once a day.

Motivation and Explanation: Why and how do your changes improve the library?

  • Code quality and function documentation and typing
  • Little changes to CLI UX.

Related issue

#4264

Reviewer Checklist

  • The PR title is descriptive enough for the changelog, and the PR is labeled correctly
  • If applicable: newly added non-private functions and classes have a docstring including a short summary and a PARAMETERS section
  • If applicable: newly added functions and classes are tested

Oliver Strait added 3 commits July 21, 2025 18:06
generation.
- Module code does not know manim anymore
- Two CLI helper function in new cli_utils.py
- Commands are only place that has knowledge of
    wider program
- Every CLI choise and desicion is moved inside
    of Commands
def select_scenes(scene_classes: list[type[Scene]]) -> list[type[Scene]]:
"""Collection of selection checks for inserted scenes"""
if not scene_classes:
logger.error(NO_SCENE_MESSAGE)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

'No scene' message never print out because I switched to Exception based feedback and forget to write the try-block.
Fixed in next version.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 🆕 New
Development

Successfully merging this pull request may close these issues.

1 participant