(torchx/workspace) Add deprecation warning to PkgInfo, WorkspaceBuilder, FbpkgWorkspace

Differential Revision: D82245264

Pull Request resolved: meta-pytorch#1113

Author: kiukchung

torchx/runner/api.py

@@ -54,7 +54,7 @@
 from torchx.util.session import get_session_id_or_create_new, TORCHX_INTERNAL_SESSION_ID
 
 from torchx.util.types import none_throws
-from torchx.workspace.api import PkgInfo, WorkspaceBuilder, WorkspaceMixin
+from torchx.workspace.api import WorkspaceMixin
 
 if TYPE_CHECKING:
     from typing_extensions import Self

torchx/workspace/api.py

@@ -9,6 +9,7 @@
 import abc
 import fnmatch
 import posixpath
+import warnings
 from dataclasses import dataclass
 from typing import Any, Dict, Generic, Iterable, Mapping, Tuple, TYPE_CHECKING, TypeVar
 
@@ -35,11 +36,33 @@ class PkgInfo(Generic[PackageType]):
     lazy_overrides: Dict[str, Any]
     metadata: PackageType
 
+    def __post_init__(self) -> None:
+        msg = (
+            f"{self.__class__.__name__} is deprecated and will be removed in the future."
+            " Consider forking this class if your project depends on it."
+        )
+        warnings.warn(
+            msg,
+            FutureWarning,
+            stacklevel=2,
+        )
+
 
 @dataclass
 class WorkspaceBuilder(Generic[PackageType, WorkspaceConfigType]):
     cfg: WorkspaceConfigType
 
+    def __post_init__(self) -> None:
+        msg = (
+            f"{self.__class__.__name__} is deprecated and will be removed in the future."
+            " Consider forking this class if your project depends on it."
+        )
+        warnings.warn(
+            msg,
+            FutureWarning,
+            stacklevel=2,
+        )
+
     @abc.abstractmethod
     def build_workspace(self, sync: bool = True) -> PkgInfo[PackageType]:
         """