modal 1.0.5.dev2__py3-none-any.whl → 1.0.5.dev3__py3-none-any.whl

modal/container_process.pyi

@@ -7,6 +7,26 @@ import typing_extensions
 T = typing.TypeVar("T")
 
 class _ContainerProcess(typing.Generic[T]):
+    """Abstract base class for generic types.
+
+    A generic type is typically declared by inheriting from
+    this class parameterized with one or more type variables.
+    For example, a generic mapping type might be defined as::
+
+      class Mapping(Generic[KT, VT]):
+          def __getitem__(self, key: KT) -> VT:
+              ...
+          # Etc.
+
+    This class can then be used as follows::
+
+      def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT:
+          try:
+              return mapping[key]
+          except KeyError:
+              return default
+    """
+
     _process_id: typing.Optional[str]
     _stdout: modal.io_streams._StreamReader[T]
     _stderr: modal.io_streams._StreamReader[T]
@@ -23,23 +43,67 @@ class _ContainerProcess(typing.Generic[T]):
         stderr: modal.stream_type.StreamType = modal.stream_type.StreamType.PIPE,
         text: bool = True,
         by_line: bool = False,
-    ) -> None: ...
-    def __repr__(self) -> str: ...
+    ) -> None:
+        """Initialize self.  See help(type(self)) for accurate signature."""
+        ...
+
+    def __repr__(self) -> str:
+        """Return repr(self)."""
+        ...
+
     @property
-    def stdout(self) -> modal.io_streams._StreamReader[T]: ...
+    def stdout(self) -> modal.io_streams._StreamReader[T]:
+        """StreamReader for the container process's stdout stream."""
+        ...
+
     @property
-    def stderr(self) -> modal.io_streams._StreamReader[T]: ...
+    def stderr(self) -> modal.io_streams._StreamReader[T]:
+        """StreamReader for the container process's stderr stream."""
+        ...
+
     @property
-    def stdin(self) -> modal.io_streams._StreamWriter: ...
+    def stdin(self) -> modal.io_streams._StreamWriter:
+        """StreamWriter for the container process's stdin stream."""
+        ...
+
     @property
     def returncode(self) -> int: ...
-    async def poll(self) -> typing.Optional[int]: ...
-    async def wait(self) -> int: ...
+    async def poll(self) -> typing.Optional[int]:
+        """Check if the container process has finished running.
+
+        Returns `None` if the process is still running, else returns the exit code.
+        """
+        ...
+
+    async def wait(self) -> int:
+        """Wait for the container process to finish running. Returns the exit code."""
+        ...
+
     async def attach(self): ...
 
 SUPERSELF = typing.TypeVar("SUPERSELF", covariant=True)
 
 class ContainerProcess(typing.Generic[T]):
+    """Abstract base class for generic types.
+
+    A generic type is typically declared by inheriting from
+    this class parameterized with one or more type variables.
+    For example, a generic mapping type might be defined as::
+
+      class Mapping(Generic[KT, VT]):
+          def __getitem__(self, key: KT) -> VT:
+              ...
+          # Etc.
+
+    This class can then be used as follows::
+
+      def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT:
+          try:
+              return mapping[key]
+          except KeyError:
+              return default
+    """
+
     _process_id: typing.Optional[str]
     _stdout: modal.io_streams.StreamReader[T]
     _stderr: modal.io_streams.StreamReader[T]
@@ -59,23 +123,48 @@ class ContainerProcess(typing.Generic[T]):
     ) -> None: ...
     def __repr__(self) -> str: ...
     @property
-    def stdout(self) -> modal.io_streams.StreamReader[T]: ...
+    def stdout(self) -> modal.io_streams.StreamReader[T]:
+        """StreamReader for the container process's stdout stream."""
+        ...
+
     @property
-    def stderr(self) -> modal.io_streams.StreamReader[T]: ...
+    def stderr(self) -> modal.io_streams.StreamReader[T]:
+        """StreamReader for the container process's stderr stream."""
+        ...
+
     @property
-    def stdin(self) -> modal.io_streams.StreamWriter: ...
+    def stdin(self) -> modal.io_streams.StreamWriter:
+        """StreamWriter for the container process's stdin stream."""
+        ...
+
     @property
     def returncode(self) -> int: ...
 
     class __poll_spec(typing_extensions.Protocol[SUPERSELF]):
-        def __call__(self, /) -> typing.Optional[int]: ...
-        async def aio(self, /) -> typing.Optional[int]: ...
+        def __call__(self, /) -> typing.Optional[int]:
+            """Check if the container process has finished running.
+
+            Returns `None` if the process is still running, else returns the exit code.
+            """
+            ...
+
+        async def aio(self, /) -> typing.Optional[int]:
+            """Check if the container process has finished running.
+
+            Returns `None` if the process is still running, else returns the exit code.
+            """
+            ...
 
     poll: __poll_spec[typing_extensions.Self]
 
     class __wait_spec(typing_extensions.Protocol[SUPERSELF]):
-        def __call__(self, /) -> int: ...
-        async def aio(self, /) -> int: ...
+        def __call__(self, /) -> int:
+            """Wait for the container process to finish running. Returns the exit code."""
+            ...
+
+        async def aio(self, /) -> int:
+            """Wait for the container process to finish running. Returns the exit code."""
+            ...
 
     wait: __wait_spec[typing_extensions.Self]