2121
2222
2323class streams_provider (Operator ):
24- r"""Create streams (cached file handles) based on provided data sources.
25-
26- - When the data sources contain a single result key, an internal
27- provider is instantiated for that namespace to create streams.
28- - When multiple result keys are present, streams are aggregated from
29- each namespace-specific internal provider.
30- - Upstream data sources (if defined) are opened and attached to the
31- output as upstream streams.
32-
33- When the ``permissive`` configuration is enabled, the operator silently
34- skips result files that cannot be opened or have unsupported namespaces,
35- continuing with valid files. If ``permissive`` is disabled (default),
36- errors are thrown for invalid files.
37-
38- Throws a runtime error if data sources are missing or if all result
39- files are invalid.
24+ r"""Creates streams (files with cache) from the data sources.
4025
4126
4227 Inputs
4328 ------
4429 data_sources: DataSources
45- Data sources describing one or more result files. Supports single or multiple result keys; may include upstream data sources.
46-
47- **Error conditions when `permissive` config is disabled:**
48- - Throws `std::runtime_error` with message "StreamProvider: empty namespace for result key '<key>'" if a result file has no namespace.
49- - Throws `std::runtime_error` with message "StreamProvider: operator <namespace>::stream_provider not found." if the namespace is not supported.
50- - If all result files are invalid, throws an error even in permissive mode.
5130
5231 Outputs
5332 -------
5433 streams_container: StreamsContainer
55- Streams created from the input data sources, including aggregated streams across namespaces and any upstream streams.
5634
5735 Examples
5836 --------
@@ -87,22 +65,7 @@ def __init__(self, data_sources=None, config=None, server=None):
8765
8866 @staticmethod
8967 def _spec () -> Specification :
90- description = r"""Create streams (cached file handles) based on provided data sources.
91-
92- - When the data sources contain a single result key, an internal
93- provider is instantiated for that namespace to create streams.
94- - When multiple result keys are present, streams are aggregated from
95- each namespace-specific internal provider.
96- - Upstream data sources (if defined) are opened and attached to the
97- output as upstream streams.
98-
99- When the ``permissive`` configuration is enabled, the operator silently
100- skips result files that cannot be opened or have unsupported namespaces,
101- continuing with valid files. If ``permissive`` is disabled (default),
102- errors are thrown for invalid files.
103-
104- Throws a runtime error if data sources are missing or if all result
105- files are invalid.
68+ description = r"""Creates streams (files with cache) from the data sources.
10669"""
10770 spec = Specification (
10871 description = description ,
@@ -111,20 +74,15 @@ def _spec() -> Specification:
11174 name = "data_sources" ,
11275 type_names = ["data_sources" ],
11376 optional = False ,
114- document = r"""Data sources describing one or more result files. Supports single or multiple result keys; may include upstream data sources.
115-
116- **Error conditions when `permissive` config is disabled:**
117- - Throws `std::runtime_error` with message "StreamProvider: empty namespace for result key '<key>'" if a result file has no namespace.
118- - Throws `std::runtime_error` with message "StreamProvider: operator <namespace>::stream_provider not found." if the namespace is not supported.
119- - If all result files are invalid, throws an error even in permissive mode.""" ,
77+ document = r"""""" ,
12078 ),
12179 },
12280 map_output_pin_spec = {
12381 0 : PinSpecification (
12482 name = "streams_container" ,
12583 type_names = ["streams_container" ],
12684 optional = False ,
127- document = r"""Streams created from the input data sources, including aggregated streams across namespaces and any upstream streams. """ ,
85+ document = r"""""" ,
12886 ),
12987 },
13088 )
@@ -197,13 +155,6 @@ def __init__(self, op: Operator):
197155 def data_sources (self ) -> Input [DataSources ]:
198156 r"""Allows to connect data_sources input to the operator.
199157
200- Data sources describing one or more result files. Supports single or multiple result keys; may include upstream data sources.
201-
202- **Error conditions when `permissive` config is disabled:**
203- - Throws `std::runtime_error` with message "StreamProvider: empty namespace for result key '<key>'" if a result file has no namespace.
204- - Throws `std::runtime_error` with message "StreamProvider: operator <namespace>::stream_provider not found." if the namespace is not supported.
205- - If all result files are invalid, throws an error even in permissive mode.
206-
207158 Returns
208159 -------
209160 input:
@@ -243,8 +194,6 @@ def __init__(self, op: Operator):
243194 def streams_container (self ) -> Output [StreamsContainer ]:
244195 r"""Allows to get streams_container output of the operator
245196
246- Streams created from the input data sources, including aggregated streams across namespaces and any upstream streams.
247-
248197 Returns
249198 -------
250199 output:
0 commit comments