magic_hour 0.9.5__py3-none-any.whl → 0.44.0__py3-none-any.whl

magic_hour/resources/v1/audio_projects/client_test.py

@@ -0,0 +1,520 @@
+import datetime
+import pytest
+import httpx
+from pathlib import Path
+from typing import Any, Generator, Literal, Union, List
+from unittest.mock import Mock, AsyncMock
+
+from magic_hour.types import models
+from magic_hour.resources.v1.audio_projects.client import (
+    AudioProjectsClient,
+    AsyncAudioProjectsClient,
+)
+
+
+class DummyResponse(models.V1AudioProjectsGetResponse):
+    """Helper response with defaults"""
+
+    def __init__(
+        self,
+        *,
+        status: Literal[
+            "complete", "queued", "rendering", "error", "canceled"
+        ] = "complete",
+        download_url: Union[str, None] = None,
+        error: Union[str, None] = None,
+    ):
+        # Create error object if error string is provided
+        error_obj = None
+        if error:
+            error_obj = models.V1AudioProjectsGetResponseError(
+                code="TEST_ERROR", message=error
+            )
+
+        super().__init__(
+            id="test-id",
+            created_at=datetime.datetime.now().isoformat(),
+            credits_charged=0,
+            downloads=[
+                models.V1AudioProjectsGetResponseDownloadsItem(
+                    url=download_url, expires_at="2024-01-01T00:00:00Z"
+                )
+            ]
+            if download_url
+            else [],
+            enabled=True,
+            error=error_obj,
+            name="test-name",
+            status=status,
+            type="test-type",
+        )
+
+
+@pytest.fixture
+def mock_base_client() -> Generator[Mock, None, None]:
+    yield Mock()
+
+
+@pytest.fixture
+def mock_async_base_client() -> Generator[AsyncMock, None, None]:
+    yield AsyncMock()
+
+
+def test_delete_calls_base_client(mock_base_client: Mock) -> None:
+    client = AudioProjectsClient(base_client=mock_base_client)
+    client.delete(id="123")
+
+    mock_base_client.request.assert_called_once()
+    call = mock_base_client.request.call_args[1]
+    assert call["method"] == "DELETE"
+    assert "/v1/audio-projects/123" in call["path"]
+
+
+def test_get_calls_base_client(mock_base_client: Mock) -> None:
+    client = AudioProjectsClient(base_client=mock_base_client)
+    mock_base_client.request.return_value = DummyResponse()
+
+    resp = client.get(id="abc")
+
+    mock_base_client.request.assert_called_once()
+    assert isinstance(resp, models.V1AudioProjectsGetResponse)
+    assert resp.id == "test-id"
+
+
+def test_check_result_no_wait_no_download(mock_base_client: Mock) -> None:
+    client = AudioProjectsClient(base_client=mock_base_client)
+    mock_base_client.request.return_value = DummyResponse(status="queued")
+
+    resp = client.check_result(
+        id="xyz",
+        wait_for_completion=False,
+        download_outputs=False,
+    )
+
+    assert resp.downloaded_paths is None
+
+
+def test_check_result_wait_until_complete(
+    monkeypatch: Any, mock_base_client: Mock
+) -> None:
+    client = AudioProjectsClient(base_client=mock_base_client)
+
+    # First calls return queued, then complete
+    mock_base_client.request.side_effect = [
+        DummyResponse(status="queued"),
+        DummyResponse(status="queued"),
+        DummyResponse(status="complete"),
+    ]
+
+    monkeypatch.setattr("time.sleep", lambda _: None)  # type: ignore
+
+    resp = client.check_result(
+        id="xyz", wait_for_completion=True, download_outputs=False
+    )
+
+    assert resp.status == "complete"
+    assert resp.downloaded_paths is None
+
+
+def test_check_result_download_outputs(
+    tmp_path: Path, mock_base_client: Mock, monkeypatch: Any
+) -> None:
+    client = AudioProjectsClient(base_client=mock_base_client)
+
+    file_url = "https://example.com/file.mp3"
+    mock_base_client.request.return_value = DummyResponse(
+        status="complete",
+        download_url=file_url,
+    )
+
+    # Create a mock response for httpx
+    mock_request = httpx.Request("GET", "https://example.com/file.mp3")
+    mock_response = httpx.Response(200, content=b"fake mp3", request=mock_request)
+
+    # Mock the httpx.Client class
+    class MockClient:
+        def __init__(self):
+            pass
+
+        def __enter__(self) -> "MockClient":
+            return self
+
+        def __exit__(self, exc_type: Any, exc_val: Any, exc_tb: Any) -> None:
+            pass
+
+        def get(self, url: str) -> httpx.Response:
+            return mock_response
+
+    monkeypatch.setattr(httpx, "Client", MockClient)
+
+    resp = client.check_result(
+        id="xyz",
+        wait_for_completion=True,
+        download_outputs=True,
+        download_directory=str(tmp_path),
+    )
+
+    assert resp.status == "complete"
+    assert resp.downloaded_paths
+    saved_file = Path(resp.downloaded_paths[0])
+    assert saved_file.exists()
+    assert saved_file.read_bytes() == b"fake mp3"
+
+
+def test_check_result_error_status(mock_base_client: Mock) -> None:
+    client = AudioProjectsClient(base_client=mock_base_client)
+    mock_base_client.request.return_value = DummyResponse(status="error", error="Boom!")
+
+    resp = client.check_result(
+        id="err", wait_for_completion=True, download_outputs=False
+    )
+    assert resp.status == "error"
+    assert resp.error is not None
+    assert resp.error.message == "Boom!"
+    assert resp.downloaded_paths is None
+
+
+def test_check_result_canceled_status(mock_base_client: Mock) -> None:
+    client = AudioProjectsClient(base_client=mock_base_client)
+    mock_base_client.request.return_value = DummyResponse(status="canceled")
+
+    resp = client.check_result(
+        id="cancel", wait_for_completion=True, download_outputs=False
+    )
+    assert resp.status == "canceled"
+    assert resp.downloaded_paths is None
+
+
+def test_check_result_poll_interval_default(
+    mock_base_client: Mock, monkeypatch: Any
+) -> None:
+    client = AudioProjectsClient(base_client=mock_base_client)
+
+    # First calls return queued, then complete
+    mock_base_client.request.side_effect = [
+        DummyResponse(status="queued"),
+        DummyResponse(status="complete"),
+    ]
+
+    # Mock time.sleep to track calls
+    sleep_calls: List[float] = []
+
+    def mock_sleep(seconds: float) -> None:
+        sleep_calls.append(seconds)
+
+    monkeypatch.setattr("time.sleep", mock_sleep)
+
+    resp = client.check_result(
+        id="xyz", wait_for_completion=True, download_outputs=False
+    )
+
+    assert resp.status == "complete"
+    # Should have slept once with default interval (0.5)
+    assert len(sleep_calls) == 1
+    assert sleep_calls[0] == 0.5
+
+
+def test_check_result_poll_interval_custom(
+    mock_base_client: Mock, monkeypatch: Any
+) -> None:
+    client = AudioProjectsClient(base_client=mock_base_client)
+
+    # Set custom poll interval
+    monkeypatch.setenv("MAGIC_HOUR_POLL_INTERVAL", "1.0")
+
+    # First calls return queued, then complete
+    mock_base_client.request.side_effect = [
+        DummyResponse(status="queued"),
+        DummyResponse(status="complete"),
+    ]
+
+    # Mock time.sleep to track calls
+    sleep_calls: List[float] = []
+
+    def mock_sleep(seconds: float) -> None:
+        sleep_calls.append(seconds)
+
+    monkeypatch.setattr("time.sleep", mock_sleep)
+
+    resp = client.check_result(
+        id="xyz", wait_for_completion=True, download_outputs=False
+    )
+
+    assert resp.status == "complete"
+    # Should have slept once with custom interval (1.0)
+    assert len(sleep_calls) == 1
+    assert sleep_calls[0] == 1.0
+
+
+def test_check_result_poll_interval_multiple_polls(
+    mock_base_client: Mock, monkeypatch: Any
+) -> None:
+    client = AudioProjectsClient(base_client=mock_base_client)
+
+    # Set custom poll interval
+    monkeypatch.setenv("MAGIC_HOUR_POLL_INTERVAL", "0.1")
+
+    # Multiple calls return queued before complete
+    mock_base_client.request.side_effect = [
+        DummyResponse(status="queued"),
+        DummyResponse(status="queued"),
+        DummyResponse(status="queued"),
+        DummyResponse(status="complete"),
+    ]
+
+    # Mock time.sleep to track calls
+    sleep_calls: List[float] = []
+
+    def mock_sleep(seconds: float) -> None:
+        sleep_calls.append(seconds)
+
+    monkeypatch.setattr("time.sleep", mock_sleep)
+
+    resp = client.check_result(
+        id="xyz", wait_for_completion=True, download_outputs=False
+    )
+
+    assert resp.status == "complete"
+    # Should have slept 3 times with custom interval (0.1)
+    assert len(sleep_calls) == 3
+    assert all(sleep_time == 0.1 for sleep_time in sleep_calls)
+
+
+@pytest.mark.asyncio
+async def test_async_delete_calls_base_client(
+    mock_async_base_client: AsyncMock,
+) -> None:
+    client = AsyncAudioProjectsClient(base_client=mock_async_base_client)
+    await client.delete(id="456")
+
+    mock_async_base_client.request.assert_called_once()
+    call = mock_async_base_client.request.call_args[1]
+    assert call["method"] == "DELETE"
+    assert "/v1/audio-projects/456" in call["path"]
+
+
+@pytest.mark.asyncio
+async def test_async_get_calls_base_client(mock_async_base_client: AsyncMock) -> None:
+    client = AsyncAudioProjectsClient(base_client=mock_async_base_client)
+    mock_async_base_client.request.return_value = DummyResponse()
+
+    resp = await client.get(id="zzz")
+
+    mock_async_base_client.request.assert_called_once()
+    assert isinstance(resp, models.V1AudioProjectsGetResponse)
+    assert resp.id == "test-id"
+
+
+@pytest.mark.asyncio
+async def test_async_check_result_no_wait_no_download(
+    mock_async_base_client: AsyncMock,
+) -> None:
+    client = AsyncAudioProjectsClient(base_client=mock_async_base_client)
+    mock_async_base_client.request.return_value = DummyResponse(status="queued")
+
+    resp = await client.check_result(
+        id="xyz",
+        wait_for_completion=False,
+        download_outputs=False,
+    )
+
+    assert resp.downloaded_paths is None
+
+
+@pytest.mark.asyncio
+async def test_async_check_result_wait_until_complete(
+    mock_async_base_client: AsyncMock, monkeypatch: Any
+) -> None:
+    client = AsyncAudioProjectsClient(base_client=mock_async_base_client)
+
+    # First calls return queued, then complete
+    mock_async_base_client.request.side_effect = [
+        DummyResponse(status="queued"),
+        DummyResponse(status="queued"),
+        DummyResponse(status="complete"),
+    ]
+
+    monkeypatch.setattr("time.sleep", lambda _: None)  # type: ignore
+
+    resp = await client.check_result(
+        id="xyz", wait_for_completion=True, download_outputs=False
+    )
+
+    assert resp.status == "complete"
+    assert resp.downloaded_paths is None
+
+
+@pytest.mark.asyncio
+async def test_async_check_result_download_outputs(
+    tmp_path: Path, mock_async_base_client: AsyncMock, monkeypatch: Any
+) -> None:
+    client = AsyncAudioProjectsClient(base_client=mock_async_base_client)
+
+    file_url = "https://example.com/file.mp3"
+    mock_async_base_client.request.return_value = DummyResponse(
+        status="complete",
+        download_url=file_url,
+    )
+
+    # Create a mock response for httpx
+    mock_request = httpx.Request("GET", "https://example.com/file.mp3")
+    mock_response = httpx.Response(200, content=b"fake mp3", request=mock_request)
+
+    # Mock the httpx.AsyncClient class
+    class MockAsyncClient:
+        def __init__(self):
+            pass
+
+        async def __aenter__(self) -> "MockAsyncClient":
+            return self
+
+        async def __aexit__(self, exc_type: Any, exc_val: Any, exc_tb: Any) -> None:
+            pass
+
+        async def get(self, url: str) -> httpx.Response:
+            return mock_response
+
+    monkeypatch.setattr(httpx, "AsyncClient", MockAsyncClient)
+
+    resp = await client.check_result(
+        id="xyz",
+        wait_for_completion=True,
+        download_outputs=True,
+        download_directory=str(tmp_path),
+    )
+
+    assert resp.status == "complete"
+    assert resp.downloaded_paths
+    saved_file = Path(resp.downloaded_paths[0])
+    assert saved_file.exists()
+    assert saved_file.read_bytes() == b"fake mp3"
+
+
+@pytest.mark.asyncio
+async def test_async_check_result_error_status(
+    mock_async_base_client: AsyncMock,
+) -> None:
+    client = AsyncAudioProjectsClient(base_client=mock_async_base_client)
+    mock_async_base_client.request.return_value = DummyResponse(
+        status="error", error="Boom!"
+    )
+
+    resp = await client.check_result(
+        id="err", wait_for_completion=True, download_outputs=False
+    )
+    assert resp.status == "error"
+    assert resp.error is not None
+    assert resp.error.message == "Boom!"
+    assert resp.downloaded_paths is None
+
+
+@pytest.mark.asyncio
+async def test_async_check_result_canceled_status(
+    mock_async_base_client: AsyncMock,
+) -> None:
+    client = AsyncAudioProjectsClient(base_client=mock_async_base_client)
+    mock_async_base_client.request.return_value = DummyResponse(status="canceled")
+
+    resp = await client.check_result(
+        id="cancel", wait_for_completion=True, download_outputs=False
+    )
+    assert resp.status == "canceled"
+    assert resp.downloaded_paths is None
+
+
+@pytest.mark.asyncio
+async def test_async_check_result_poll_interval_default(
+    mock_async_base_client: AsyncMock, monkeypatch: Any
+) -> None:
+    client = AsyncAudioProjectsClient(base_client=mock_async_base_client)
+
+    # First calls return queued, then complete
+    mock_async_base_client.request.side_effect = [
+        DummyResponse(status="queued"),
+        DummyResponse(status="complete"),
+    ]
+
+    # Mock time.sleep to track calls
+    sleep_calls: List[float] = []
+
+    def mock_sleep(seconds: float) -> None:
+        sleep_calls.append(seconds)
+
+    monkeypatch.setattr("time.sleep", mock_sleep)
+
+    resp = await client.check_result(
+        id="xyz", wait_for_completion=True, download_outputs=False
+    )
+
+    assert resp.status == "complete"
+    # Should have slept once with default interval (0.5)
+    assert len(sleep_calls) == 1
+    assert sleep_calls[0] == 0.5
+
+
+@pytest.mark.asyncio
+async def test_async_check_result_poll_interval_custom(
+    mock_async_base_client: AsyncMock, monkeypatch: Any
+) -> None:
+    client = AsyncAudioProjectsClient(base_client=mock_async_base_client)
+
+    # Set custom poll interval
+    monkeypatch.setenv("MAGIC_HOUR_POLL_INTERVAL", "2.0")
+
+    # First calls return queued, then complete
+    mock_async_base_client.request.side_effect = [
+        DummyResponse(status="queued"),
+        DummyResponse(status="complete"),
+    ]
+
+    # Mock time.sleep to track calls
+    sleep_calls: List[float] = []
+
+    def mock_sleep(seconds: float) -> None:
+        sleep_calls.append(seconds)
+
+    monkeypatch.setattr("time.sleep", mock_sleep)
+
+    resp = await client.check_result(
+        id="xyz", wait_for_completion=True, download_outputs=False
+    )
+
+    assert resp.status == "complete"
+    # Should have slept once with custom interval (2.0)
+    assert len(sleep_calls) == 1
+    assert sleep_calls[0] == 2.0
+
+
+@pytest.mark.asyncio
+async def test_async_check_result_poll_interval_multiple_polls(
+    mock_async_base_client: AsyncMock, monkeypatch: Any
+) -> None:
+    client = AsyncAudioProjectsClient(base_client=mock_async_base_client)
+
+    # Set custom poll interval
+    monkeypatch.setenv("MAGIC_HOUR_POLL_INTERVAL", "0.3")
+
+    # Multiple calls return queued before complete
+    mock_async_base_client.request.side_effect = [
+        DummyResponse(status="queued"),
+        DummyResponse(status="queued"),
+        DummyResponse(status="queued"),
+        DummyResponse(status="complete"),
+    ]
+
+    # Mock time.sleep to track calls
+    sleep_calls: List[float] = []
+
+    def mock_sleep(seconds: float) -> None:
+        sleep_calls.append(seconds)
+
+    monkeypatch.setattr("time.sleep", mock_sleep)
+
+    resp = await client.check_result(
+        id="xyz", wait_for_completion=True, download_outputs=False
+    )
+
+    assert resp.status == "complete"
+    # Should have slept 3 times with custom interval (0.3)
+    assert len(sleep_calls) == 3
+    assert all(sleep_time == 0.3 for sleep_time in sleep_calls)

magic_hour/resources/v1/auto_subtitle_generator/README.md

@@ -0,0 +1,128 @@
+# v1.auto_subtitle_generator
+
+## Module Functions
+
+<!-- CUSTOM DOCS START -->
+
+### Auto Subtitle Generator Generate Workflow <a name="generate"></a>
+
+The workflow performs the following action
+
+1. upload local assets to Magic Hour storage. So you can pass in a local path instead of having to upload files yourself
+2. trigger a generation
+3. poll for a completion status. This is configurable
+4. if success, download the output to local directory
+
+> [!TIP]
+> This is the recommended way to use the SDK unless you have specific needs where it is necessary to split up the actions.
+
+#### Parameters
+
+In Additional to the parameters listed in the `.create` section below, `.generate` introduces 3 new parameters:
+
+- `wait_for_completion` (bool, default True): Whether to wait for the project to complete.
+- `download_outputs` (bool, default True): Whether to download the generated files
+- `download_directory` (str, optional): Directory to save downloaded files (defaults to current directory)
+
+#### Synchronous Client
+
+```python
+from magic_hour import Client
+from os import getenv
+
+client = Client(token=getenv("API_TOKEN"))
+res = client.v1.auto_subtitle_generator.generate(
+    assets={"video_file_path": "/path/to/1234.mp4"},
+    end_seconds=15.0,
+    start_seconds=0.0,
+    style={},
+    name="Auto Subtitle video",
+    wait_for_completion=True,
+    download_outputs=True,
+    download_directory="outputs"
+)
+```
+
+#### Asynchronous Client
+
+```python
+from magic_hour import AsyncClient
+from os import getenv
+
+client = AsyncClient(token=getenv("API_TOKEN"))
+res = await client.v1.auto_subtitle_generator.generate(
+    assets={"video_file_path": "/path/to/1234.mp4"},
+    end_seconds=15.0,
+    start_seconds=0.0,
+    style={},
+    name="Auto Subtitle video",
+    wait_for_completion=True,
+    download_outputs=True,
+    download_directory="outputs"
+)
+```
+
+<!-- CUSTOM DOCS END -->
+
+### Auto Subtitle Generator <a name="create"></a>
+
+Automatically generate subtitles for your video in multiple languages.
+
+**API Endpoint**: `POST /v1/auto-subtitle-generator`
+
+#### Parameters
+
+| Parameter            | Required | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | Example                                                                                                                                                                                                                                          |
+| -------------------- | :------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `assets`             |    ✓     | Provide the assets for auto subtitle generator                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | `{"video_file_path": "api-assets/id/1234.mp4"}`                                                                                                                                                                                                  |
+| `└─ video_file_path` |    ✓     | This is the video used to add subtitles. This value is either - a direct URL to the video file - `file_path` field from the response of the [upload urls API](https://docs.magichour.ai/api-reference/files/generate-asset-upload-urls). Please refer to the [Input File documentation](https://docs.magichour.ai/api-reference/files/generate-asset-upload-urls#input-file) to learn more.                                                                                                                                                                                                                                                                       | `"api-assets/id/1234.mp4"`                                                                                                                                                                                                                       |
+| `end_seconds`        |    ✓     | The end time of the input video in seconds. This value is used to trim the input video. The value must be greater than 0.1, and more than the start_seconds.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | `15.0`                                                                                                                                                                                                                                           |
+| `start_seconds`      |    ✓     | The start time of the input video in seconds. This value is used to trim the input video. The value must be greater than 0.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | `0.0`                                                                                                                                                                                                                                            |
+| `style`              |    ✓     | Style of the subtitle. At least one of `.style.template` or `.style.custom_config` must be provided. * If only `.style.template` is provided, default values for the template will be used. * If both are provided, the fields in `.style.custom_config` will be used to overwrite the fields in `.style.template`. * If only `.style.custom_config` is provided, then all fields in `.style.custom_config` will be used. To use custom config only, the following `custom_config` params are required: * `.style.custom_config.font` * `.style.custom_config.text_color` * `.style.custom_config.vertical_position` * `.style.custom_config.horizontal_position` | `{}`                                                                                                                                                                                                                                             |
+| `└─ custom_config`   |    ✗     | Custom subtitle configuration.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | `{"font": "Noto Sans", "font_size": 24.0, "font_style": "normal", "highlighted_text_color": "#FFD700", "horizontal_position": "center", "stroke_color": "#000000", "stroke_width": 1.0, "text_color": "#FFFFFF", "vertical_position": "bottom"}` |
+| `└─ template`        |    ✗     | Preset subtitle templates. Please visit https://magichour.ai/create/auto-subtitle-generator to see the style of the existing templates.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | `"cinematic"`                                                                                                                                                                                                                                    |
+| `name`               |    ✗     | The name of video. This value is mainly used for your own identification of the video.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | `"Auto Subtitle video"`                                                                                                                                                                                                                          |
+
+#### Synchronous Client
+
+```python
+from magic_hour import Client
+from os import getenv
+
+client = Client(token=getenv("API_TOKEN"))
+res = client.v1.auto_subtitle_generator.create(
+    assets={"video_file_path": "api-assets/id/1234.mp4"},
+    end_seconds=15.0,
+    start_seconds=0.0,
+    style={},
+    name="Auto Subtitle video",
+)
+```
+
+#### Asynchronous Client
+
+```python
+from magic_hour import AsyncClient
+from os import getenv
+
+client = AsyncClient(token=getenv("API_TOKEN"))
+res = await client.v1.auto_subtitle_generator.create(
+    assets={"video_file_path": "api-assets/id/1234.mp4"},
+    end_seconds=15.0,
+    start_seconds=0.0,
+    style={},
+    name="Auto Subtitle video",
+)
+```
+
+#### Response
+
+##### Type
+
+[V1AutoSubtitleGeneratorCreateResponse](/magic_hour/types/models/v1_auto_subtitle_generator_create_response.py)
+
+##### Example
+
+```python
+{"credits_charged": 450, "estimated_frame_cost": 450, "id": "cuid-example"}
+```

magic_hour/resources/v1/auto_subtitle_generator/__init__.py

@@ -0,0 +1,4 @@
+from .client import AsyncAutoSubtitleGeneratorClient, AutoSubtitleGeneratorClient
+
+
+__all__ = ["AsyncAutoSubtitleGeneratorClient", "AutoSubtitleGeneratorClient"]