Skip to content

Deprecate video feature and unify legacy wrapper (app.py as canonical)#24

Open
SaltProphet wants to merge 1 commit intomainfrom
decide-on-canonical-contract-for-render_video
Open

Deprecate video feature and unify legacy wrapper (app.py as canonical)#24
SaltProphet wants to merge 1 commit intomainfrom
decide-on-canonical-contract-for-render_video

Conversation

@SaltProphet
Copy link
Owner

Motivation

  • Video export/rendering was removed from the core implementation but remained referenced across docs, API imports, tests, and legacy wrappers, causing duplication and behavior drift.
  • The goal was to make Option A canonical: remove active video support claims, keep an explicit deprecated compatibility surface, and consolidate wrappers so app.py is the single source of truth.

Description

  • Removed active video references and the unused render_video import from api.py and trimmed the REST API docs to stop advertising video support.
  • Removed video configuration constants and the output/videos directory from FORGEConfig in app.py, while keeping a deprecated render_video wrapper that raises NotImplementedError.
  • Replaced the previous large procedural forgev1.py with a thin compatibility re-export module that delegates to app.py to eliminate duplicated wrapper logic and reduce drift.
  • Updated documentation and tests to reflect deprecation by adding a README note and removing output/videos expectations from fixtures and integration/benchmark descriptions.

Testing

  • Ran a focused pytest invocation: pytest -q -o addopts='' tests/integration/test_workflows.py::TestDirectoryManagement::test_directory_creation tests/unit/test_utils.py, and the selected tests passed (10 passed in 3.83s).
  • Verified Python source compilation with python -m py_compile api.py app.py forgev1.py, which succeeded with no syntax errors.
  • Performed a repository-level commit recorded as: Deprecate video feature canonically and align wrappers and validated the edited files (api.py, app.py, forgev1.py, README.md, tests/conftest.py, tests/integration/test_speed_benchmarks.py, tests/integration/test_workflows.py).

Codex Task

Copilot AI review requested due to automatic review settings February 21, 2026 21:46
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This pull request deprecates the video rendering feature and consolidates the legacy wrapper module to eliminate code duplication. The changes establish app.py as the single canonical source of truth by converting forgev1.py from a ~190-line duplicate implementation into a thin ~55-line compatibility re-export module. Video functionality is formally deprecated by removing configuration constants, directory setup, documentation references, and the render_video import from the REST API, while maintaining a deprecated stub that raises NotImplementedError for backward compatibility.

Changes:

  • Removed video feature configuration (VIDEO_FPS, VIDEO_BITRATE, ASPECT_RATIOS), the output/videos directory from FORGEConfig, and video references from module docstrings
  • Refactored forgev1.py to re-export all functions from app.py instead of maintaining duplicate implementations, preserving the same public API surface
  • Updated tests to remove output/videos directory expectations and video benchmark references, and added README deprecation notice

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.

Show a summary per file
File Description
app.py Removed video configuration constants (VIDEO_FPS, VIDEO_BITRATE, ASPECT_RATIOS) and output/videos directory from FORGEConfig.DIRECTORIES; kept render_video stub raising NotImplementedError
forgev1.py Replaced ~190 lines of duplicated wrapper logic with thin re-export module (~55 lines) importing all public functions from app.py
api.py Removed render_video import and video rendering from REST API documentation
README.md Added deprecation notice under REST API section stating "Video export is deprecated and no longer supported"
tests/conftest.py Removed output/videos from test directory setup fixture
tests/integration/test_workflows.py Removed output/videos from required directory validation test
tests/integration/test_speed_benchmarks.py Removed "Video rendering" from benchmark feature list comment

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants