refactor: DRY up duplicate docstrings in stream functions

Author: zeke

src/replicate/_client.py

@@ -330,34 +330,16 @@ def stream(
         """
         Stream output from a model prediction.
 
-        This creates a prediction and returns an iterator that yields output chunks
-        as strings as they become available from the streaming API.
-
-        Args:
-            ref: Reference to the model or version to run. Can be:
-                - A string containing a version ID (e.g. "5c7d5dc6dd8bf75c1acaa8565735e7986bc5b66206b55cca93cb72c9bf15ccaa")
-                - A string with owner/name format (e.g. "replicate/hello-world")
-                - A string with owner/name:version format (e.g. "replicate/hello-world:5c7d5dc6...")
-                - A Model instance with owner and name attributes
-                - A Version instance with id attribute
-                - A ModelVersionIdentifier dictionary with owner, name, and/or version keys
-            file_encoding_strategy: Strategy for encoding file inputs, options are "base64" or "url"
-            **params: Additional parameters to pass to the prediction creation endpoint including
-                      the required "input" dictionary with model-specific parameters
-
-        Yields:
-            str: Output chunks from the model as they become available
-
-        Raises:
-            ValueError: If the reference format is invalid or model doesn't support streaming
-            ReplicateError: If the prediction fails
-
         Example:
-            for event in replicate.stream(
+            ```python
+            for event in client.stream(
                 "meta/meta-llama-3-70b-instruct",
                 input={"prompt": "Write a haiku about coding"},
             ):
                 print(str(event), end="")
+            ```
+
+        See `replicate.lib._predictions_stream.stream` for full documentation.
         """
         from .lib._predictions_stream import stream
 
@@ -753,34 +735,16 @@ async def stream(
         """
         Stream output from a model prediction asynchronously.
 
-        This creates a prediction and returns an async iterator that yields output chunks
-        as strings as they become available from the streaming API.
-
-        Args:
-            ref: Reference to the model or version to run. Can be:
-                - A string containing a version ID (e.g. "5c7d5dc6dd8bf75c1acaa8565735e7986bc5b66206b55cca93cb72c9bf15ccaa")
-                - A string with owner/name format (e.g. "replicate/hello-world")
-                - A string with owner/name:version format (e.g. "replicate/hello-world:5c7d5dc6...")
-                - A Model instance with owner and name attributes
-                - A Version instance with id attribute
-                - A ModelVersionIdentifier dictionary with owner, name, and/or version keys
-            file_encoding_strategy: Strategy for encoding file inputs, options are "base64" or "url"
-            **params: Additional parameters to pass to the prediction creation endpoint including
-                      the required "input" dictionary with model-specific parameters
-
-        Yields:
-            str: Output chunks from the model as they become available
-
-        Raises:
-            ValueError: If the reference format is invalid or model doesn't support streaming
-            ReplicateError: If the prediction fails
-
         Example:
-            async for event in replicate.stream(
+            ```python
+            async for event in client.stream(
                 "meta/meta-llama-3-70b-instruct",
                 input={"prompt": "Write a haiku about coding"},
             ):
                 print(str(event), end="")
+            ```
+
+        See `replicate.lib._predictions_stream.async_stream` for full documentation.
         """
         from .lib._predictions_stream import async_stream
 

src/replicate/lib/_predictions_stream.py

@@ -13,6 +13,31 @@
 if TYPE_CHECKING:
     from .._client import Replicate, AsyncReplicate
 
+_STREAM_DOCSTRING = """
+Stream output from a model prediction.
+
+This creates a prediction and returns an iterator that yields output chunks
+as strings as they become available from the streaming API.
+
+Args:
+    ref: Reference to the model or version to run. Can be:
+        - A string containing a version ID
+        - A string with owner/name format (e.g. "replicate/hello-world")
+        - A string with owner/name:version format
+        - A Model instance
+        - A Version instance
+        - A ModelVersionIdentifier dictionary
+    file_encoding_strategy: Strategy for encoding file inputs
+    **params: Additional parameters including the required "input" dictionary
+
+Yields:
+    str: Output chunks from the model as they become available
+
+Raises:
+    ValueError: If the reference format is invalid
+    ReplicateError: If the prediction fails or streaming is not available
+"""
+
 
 def _resolve_reference(
     ref: Union[Model, Version, ModelVersionIdentifier, str],
@@ -35,31 +60,7 @@ def stream(
     file_encoding_strategy: Optional["FileEncodingStrategy"] = None,
     **params: Unpack[PredictionCreateParamsWithoutVersion],
 ) -> Iterator[str]:
-    """
-    Stream output from a model prediction.
-
-    This creates a prediction and returns an iterator that yields output chunks
-    as strings as they become available from the streaming API.
-
-    Args:
-        client: The Replicate client instance
-        ref: Reference to the model or version to run. Can be:
-            - A string containing a version ID
-            - A string with owner/name format (e.g. "replicate/hello-world")
-            - A string with owner/name:version format
-            - A Model instance
-            - A Version instance
-            - A ModelVersionIdentifier dictionary
-        file_encoding_strategy: Strategy for encoding file inputs
-        **params: Additional parameters including the required "input" dictionary
-
-    Yields:
-        str: Output chunks from the model as they become available
-
-    Raises:
-        ValueError: If the reference format is invalid
-        ReplicateError: If the prediction fails or streaming is not available
-    """
+    __doc__ = _STREAM_DOCSTRING
     version, owner, name, version_id = _resolve_reference(ref)
 
     # Create prediction
@@ -112,25 +113,7 @@ async def async_stream(
     file_encoding_strategy: Optional["FileEncodingStrategy"] = None,
     **params: Unpack[PredictionCreateParamsWithoutVersion],
 ) -> AsyncIterator[str]:
-    """
-    Async stream output from a model prediction.
-
-    This creates a prediction and returns an async iterator that yields output chunks
-    as strings as they become available from the streaming API.
-
-    Args:
-        client: The AsyncReplicate client instance
-        ref: Reference to the model or version to run
-        file_encoding_strategy: Strategy for encoding file inputs
-        **params: Additional parameters including the required "input" dictionary
-
-    Yields:
-        str: Output chunks from the model as they become available
-
-    Raises:
-        ValueError: If the reference format is invalid
-        ReplicateError: If the prediction fails or streaming is not available
-    """
+    __doc__ = _STREAM_DOCSTRING
     version, owner, name, version_id = _resolve_reference(ref)
 
     # Create prediction