907308 - Add mozprocess docs

Status: RESOLVED FIXED

(Testing :: Mozbase, defect)

Description

[William Lachance (:wlach)]

jgriffin did some basic documentation for the mozbase hackfest almost a year ago, but we never merged it in. Let's fix that.

The wip is in this pull request: https://github.com/mozilla/mozbase/pull/41

Comment 1

[William Lachance (:wlach)]

Attachment: 0001-Bug-907308-Add-mozprocess-docs-r-ahal.patch

There are some definite problems with this patch:

1. It puts ProcessHandlerMixin, which is probably not the class we normally want to use, on top.
2. It lacks any kind of examples.

Still, I think it would be good for this to go in as is. We can file followup "good first bugs" for people to fix the remaining issues.

Comment 2

[Andrew Halberstadt [:ahal]]

Comment on attachment 793110 [details] [diff] [review]
0001-Bug-907308-Add-mozprocess-docs-r-ahal.patch

Review of attachment 793110 [details] [diff] [review]:
-----------------------------------------------------------------

Looks good! r+ with nitfix.

::: mozprocess/mozprocess/processhandler.py
@@ +35,5 @@
> +    :param args: is a list of arguments to pass to the command (defaults to None).
> +    :param cwd: working directory for command (defaults to None).
> +    :param env: is the environment to use for the process (defaults to os.environ).
> +    :param ignore_children: causes system to ignore child processes when True, defaults to False (which tracks child processes).
> +    :param processOutputLine: function to be called for each line of output produed by the process (defaults to None).

This can also be a list of functions.. though imo the name is confusing and this should be refactored. I think this can land as is in the name of simplicity.

@@ +36,5 @@
> +    :param cwd: working directory for command (defaults to None).
> +    :param env: is the environment to use for the process (defaults to os.environ).
> +    :param ignore_children: causes system to ignore child processes when True, defaults to False (which tracks child processes).
> +    :param processOutputLine: function to be called for each line of output produed by the process (defaults to None).
> +    :param onTimeout: unction to be called when the process times out.

nit: missing 'f'

Comment 3

[William Lachance (:wlach)]

Pushed: https://github.com/mozilla/mozbase/commit/06ab7ad28d058e0588a1c027e8232847c2617a38