[Process] Introduce InputStream and iterator for output #6424

nicolas-grekas · 2016-04-01T17:03:37Z

Q	A
Doc fix?	no
New docs?	yes
Applies to	3.1
Fixed tickets	-

stof · 2016-04-01T17:30:54Z

components/process.rst

+is closed.
+
+In order to write to a subprocess standard input while it is running, the component
+provides the :class:`Symfony\\Component\\Process\\InputStream` class.


documenting its usage is necessary

I was about the say the same. A small practical example would help a lot.

stof · 2016-04-01T17:56:17Z

I think it might be time to split the doc of the Process component into multiple chapters, an dhaving one such chapter dedicated to the way to deal with the input (with basic examples and more complex ones)

…rocesses (nicolas-grekas) This PR was merged into the 3.1-dev branch. Discussion ---------- [Process] Add InputStream to seamlessly feed running processes | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #18262 | License | MIT | Doc PR | symfony/symfony-docs#6424 Look at the tests, beautiful, isn't it? Commits ------- 3d20b6c [Process] Add InputStream to seamlessly feed running processes

…rocesses (nicolas-grekas) This PR was merged into the 3.1-dev branch. Discussion ---------- [Process] Add InputStream to seamlessly feed running processes | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #18262 | License | MIT | Doc PR | symfony/symfony-docs#6424 Look at the tests, beautiful, isn't it? Commits ------- 3d20b6c [Process] Add InputStream to seamlessly feed running processes

linaori · 2016-04-02T14:46:28Z

I think @stof has a valid point here, the process page is already rather big compared to some others.

fabpot · 2016-04-03T11:22:40Z

Don't forget to also document "IteratorAggregate to stream output" from symfony/symfony#18414

… (nicolas-grekas) This PR was merged into the 3.1-dev branch. Discussion ---------- [Process] Implement IteratorAggregate to stream output | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | symfony/symfony-docs#6424 Sibling to #18386 for iterating of the output streams. Commits ------- 5947f5d [Process] Implement IteratorAggregate to stream output

nicolas-grekas · 2016-04-03T17:07:45Z

PR updated, LGTM. Do you think it needs more content?
Comments welcomed. If someone is willing to help and do the split @stof suggests in a later PR, I'd be thankful for it...

fabpot · 2016-04-03T17:11:23Z

components/process.rst


 The :method:`Symfony\\Component\\Process\\Process::clearOutput` method clears
 the contents of the output and
 :method:`Symfony\\Component\\Process\\Process::clearErrorOutput` clears
 the contents of the error output.

+You can also use the :class:`Symfony\\Component\\Process\\Process` class with the
+foreach construct to get the output while it is generated. By default, the loop waits
+for new outputs before going to the next iterations::


output, iteration?

fabpot · 2016-04-03T17:12:09Z

👍

javiereguiluz · 2016-04-03T17:19:19Z

components/process.rst

+    echo $process->getOutput();
+
+The :method:`Symfony\\Component\\Process\\InputStream::write` method accepts scalars,
+stream resources or Traversable objects as argument. As shown is the above example,


As shown is the -> As shown in the

javiereguiluz · 2016-04-07T10:06:20Z

components/process.rst

@@ -128,6 +143,46 @@ are done doing other stuff::
    which means that your code will halt at this line until the external
    process is completed.

+Feeding the standard input of a Process


Streaming instead of Feeding ?

"Feeding" sounds good to me.

"Standard" and "Input" should be uppercased.

javiereguiluz · 2016-04-07T10:07:44Z

👍

@nicolas-grekas thanks for these docs!

xabbuh · 2016-04-10T08:05:47Z

components/process.rst

@@ -43,13 +43,28 @@ The ``getOutput()`` method always returns the whole content of the standard
 output of the command and ``getErrorOutput()`` the content of the error
 output. Alternatively, the :method:`Symfony\\Component\\Process\\Process::getIncrementalOutput`
 and :method:`Symfony\\Component\\Process\\Process::getIncrementalErrorOutput`
-methods returns the new outputs since the last call.
+methods return the new output since their last call.


We should make this fix in all affected lower branches too.

xabbuh · 2016-04-10T08:07:18Z

We need a versionadded directive for the features that are new in Symfony 3.1.

wouterj · 2016-06-11T08:00:04Z

components/process.rst

+
+Before a process is started, you can specify its standard input using either the
+:method:`Symfony\\Component\\Process\\Process::setInput` method or the 4th argument
+of the Process constructor. The provided input can be a string, a stream resource or


"of the constructor."

wouterj · 2016-06-11T08:01:33Z

Hi @nicolas-grekas! Can you please finish this PR? Otherwise, just say it and we'll fix the minor issues while merging.

nicolas-grekas · 2016-06-17T15:50:21Z

Comments addressed hopefully (I'll let you guys split this into several pages...)

xabbuh · 2016-06-18T06:38:44Z

components/process.rst

@@ -68,6 +83,10 @@ with a non-zero code)::
        echo $e->getMessage();
    }

+.. versionadded:: 3.1
+    Streaming the input or the output of a process using iterators
+    were added in Symfony 3.1


I think we should split this.

Above the paragraph added above:

.. versionadded:: 3.1 Support for streaming the output using iterators was introduced in Symfony 3.1.

After the "Streaming to the standard input of a Process" headline:

Support for streaming the input of a process was introduced in Symfony 3.1.

xabbuh · 2016-06-18T06:39:49Z

components/process.rst

@@ -128,6 +147,46 @@ are done doing other stuff::
    which means that your code will halt at this line until the external
    process is completed.

+Streaming to the standard input of a Process


Streaming to the Standard Input of a Process

xabbuh · 2016-06-18T06:40:21Z

👍 except of the minor comments above (but we can address them while merging)

Status: Reviewed

xabbuh · 2016-06-30T16:53:16Z

ping @javiereguiluz @weaverryan @wouterj

wouterj · 2016-07-02T10:57:26Z

Thanks @nicolas-grekas! Fyi, I've rebased this PR in #6705 and merged that one.

… (nicolas-grekas) This PR was merged into the 3.1 branch. Discussion ---------- [Process] Introduce InputStream and iterator for output Rebase of #6424 Commits ------- 51ac1a6 [Process] Introduce InputStream and iterator for output

nicolas-grekas added the Status: Needs Work label Apr 1, 2016

nicolas-grekas mentioned this pull request Apr 1, 2016

[Process] Add InputStream to seamlessly feed running processes symfony/symfony#18386

Merged

stof reviewed Apr 1, 2016
View reviewed changes

nicolas-grekas mentioned this pull request Apr 2, 2016

[Process] Implement IteratorAggregate to stream output symfony/symfony#18414

Merged

nicolas-grekas changed the title ~~[Process] Introduce InputStream~~ [Process] Introduce InputStream and iterator for output Apr 3, 2016

nicolas-grekas force-pushed the process-31 branch 2 times, most recently from 6a7eb39 to 0c8e0d0 Compare April 3, 2016 17:05

fabpot reviewed Apr 3, 2016
View reviewed changes

nicolas-grekas force-pushed the process-31 branch from 0c8e0d0 to cd14410 Compare April 3, 2016 17:13

nicolas-grekas removed the Status: Needs Work label Apr 3, 2016

javiereguiluz reviewed Apr 3, 2016
View reviewed changes

nicolas-grekas force-pushed the process-31 branch from cd14410 to d2066c9 Compare April 3, 2016 17:21

javiereguiluz reviewed Apr 7, 2016
View reviewed changes

xabbuh reviewed Apr 10, 2016
View reviewed changes

xabbuh added the Status: Needs Work label May 21, 2016

wouterj reviewed Jun 11, 2016
View reviewed changes

nicolas-grekas force-pushed the process-31 branch from d2066c9 to 6e32e52 Compare June 17, 2016 15:49

xabbuh reviewed Jun 18, 2016
View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Work labels Jun 18, 2016

[Process] Introduce InputStream and iterator for output

2795261

nicolas-grekas force-pushed the process-31 branch from 6e32e52 to 2795261 Compare June 18, 2016 07:07

wouterj mentioned this pull request Jul 2, 2016

[Process] Introduce InputStream and iterator for output #6705

Merged

wouterj closed this Jul 2, 2016

nicolas-grekas deleted the process-31 branch July 24, 2016 20:08

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Process] Introduce InputStream and iterator for output #6424

[Process] Introduce InputStream and iterator for output #6424

nicolas-grekas commented Apr 1, 2016

stof Apr 1, 2016

fabpot Apr 1, 2016

stof commented Apr 1, 2016

linaori commented Apr 2, 2016

fabpot commented Apr 3, 2016

nicolas-grekas commented Apr 3, 2016

fabpot Apr 3, 2016

fabpot commented Apr 3, 2016

javiereguiluz Apr 3, 2016

javiereguiluz Apr 7, 2016

xabbuh Apr 10, 2016

xabbuh Apr 10, 2016

javiereguiluz commented Apr 7, 2016

xabbuh Apr 10, 2016

xabbuh Jun 18, 2016

xabbuh commented Apr 10, 2016

wouterj Jun 11, 2016

wouterj commented Jun 11, 2016

nicolas-grekas commented Jun 17, 2016

xabbuh Jun 18, 2016

xabbuh Jun 18, 2016

xabbuh commented Jun 18, 2016

xabbuh commented Jun 30, 2016

wouterj commented Jul 2, 2016

[Process] Introduce InputStream and iterator for output #6424

[Process] Introduce InputStream and iterator for output #6424

Conversation

nicolas-grekas commented Apr 1, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

stof commented Apr 1, 2016

linaori commented Apr 2, 2016

fabpot commented Apr 3, 2016

nicolas-grekas commented Apr 3, 2016

Choose a reason for hiding this comment

fabpot commented Apr 3, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

javiereguiluz commented Apr 7, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

xabbuh commented Apr 10, 2016

Choose a reason for hiding this comment

wouterj commented Jun 11, 2016

nicolas-grekas commented Jun 17, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

xabbuh commented Jun 18, 2016

xabbuh commented Jun 30, 2016

wouterj commented Jul 2, 2016