Source code for bacommon.restapi.v1.prefabs

# Released under the MIT License. See LICENSE for details.
#
"""Prefab-build related REST API types."""

from __future__ import annotations  # Docs-generation hack.

# See CLAUDE.md in this directory for contributor conventions.

from dataclasses import dataclass
from typing import Annotated

from efro.dataclassio import IOAttrs, ioprepped



[docs]
@ioprepped
@dataclass
class PrefabSymbolsResponse:
    """Debug-symbols lookup result for a prefab binary.

    Returned by :attr:`~bacommon.restapi.v1.Endpoint.PREFAB_SYMBOLS`.
    """

    #: Suggested local file name for the symbols file (the app's
    #: ``.pdb`` name). Place the downloaded file under this
    #: name next to the binary it was looked up for; debuggers and the
    #: engine's own stack-trace symbolication will then find it
    #: automatically.
    file_name: str

    #: Size of the symbols file in bytes.
    size: int

    #: Time-limited download URL for the symbols file.
    download_url: str



# Docs-generation hack; import some stuff that we likely only forward-declared
# in our actual source code so that docs tools can find it.
from typing import (Coroutine, Any, Literal, Callable,
  Generator, Awaitable, Sequence, Self)
import asyncio
from concurrent.futures import Future
from pathlib import Path
from enum import Enum