[dftimewolf] Docstrings for collector lib.

[dftimewolf] Docstrings for collector lib.

[someguyiknow, 2016-10-21 21:49:26]

Code updated.

[someguyiknow, 2016-10-21 21:54:36]

Code updated.

[onager, 2016-10-22 14:52:25]

https://codereview.appspot.com/314900043/diff/30007/dftimewolf/lib/collectors.py
File dftimewolf/lib/collectors.py (right):

https://codereview.appspot.com/314900043/diff/30007/dftimewolf/lib/collectors...
dftimewolf/lib/collectors.py:61: """Args:
Need to add a single line docstring here: "Initializes a filesystem collector"

https://codereview.appspot.com/314900043/diff/30007/dftimewolf/lib/collectors...
dftimewolf/lib/collectors.py:110: hunt_id (Optional [str]): ID of GRR hunt to
retrieve artifacts from
This isn't optional

https://codereview.appspot.com/314900043/diff/30007/dftimewolf/lib/collectors...
dftimewolf/lib/collectors.py:112: use_tsk (Optional[bool]): toggle for use_tsk
flag on GRR flows and hunts
Not optional

https://codereview.appspot.com/314900043/diff/30007/dftimewolf/lib/collectors...
dftimewolf/lib/collectors.py:117: approvers (str): comma-separated list of users
to send GRR approval to
This is optional

https://codereview.appspot.com/314900043/diff/30007/dftimewolf/lib/collectors...
dftimewolf/lib/collectors.py:316: approvers (str): comma-separated list of users
to send GRR approval to
This is optional

https://codereview.appspot.com/314900043/diff/30007/dftimewolf/lib/collectors...
dftimewolf/lib/collectors.py:391: ValueError: if no approvals exist and no
approvers are specified"""
newline here

[someguyiknow, 2016-10-23 01:49:04]

Code updated.

[someguyiknow, 2016-10-23 01:49:15]

https://codereview.appspot.com/314900043/diff/30007/dftimewolf/lib/collectors.py
File dftimewolf/lib/collectors.py (right):

https://codereview.appspot.com/314900043/diff/30007/dftimewolf/lib/collectors...
dftimewolf/lib/collectors.py:61: """Args:
On 2016/10/22 14:52:25, onager wrote:
> Need to add a single line docstring here: "Initializes a filesystem collector"

Done.

https://codereview.appspot.com/314900043/diff/30007/dftimewolf/lib/collectors...
dftimewolf/lib/collectors.py:110: hunt_id (Optional [str]): ID of GRR hunt to
retrieve artifacts from
On 2016/10/22 14:52:25, onager wrote:
> This isn't optional

I'd argue that it is (when --new_hunt is specified), unless you mean that
*something* will be passed no matter what (None in the case of new_hunt). But
will fix in the meantime.

https://codereview.appspot.com/314900043/diff/30007/dftimewolf/lib/collectors...
dftimewolf/lib/collectors.py:112: use_tsk (Optional[bool]): toggle for use_tsk
flag on GRR flows and hunts
On 2016/10/22 14:52:25, onager wrote:
> Not optional

Looking for the same clarification as above. But will fix in the meantime.

https://codereview.appspot.com/314900043/diff/30007/dftimewolf/lib/collectors...
dftimewolf/lib/collectors.py:117: approvers (str): comma-separated list of users
to send GRR approval to
On 2016/10/22 14:52:25, onager wrote:
> This is optional

Done.

https://codereview.appspot.com/314900043/diff/30007/dftimewolf/lib/collectors...
dftimewolf/lib/collectors.py:316: approvers (str): comma-separated list of users
to send GRR approval to
On 2016/10/22 14:52:25, onager wrote:
> This is optional

Done.

https://codereview.appspot.com/314900043/diff/30007/dftimewolf/lib/collectors...
dftimewolf/lib/collectors.py:391: ValueError: if no approvals exist and no
approvers are specified"""
On 2016/10/22 14:52:25, onager wrote:
> newline here

Done.

[onager, 2016-10-25 16:02:40]

https://codereview.appspot.com/314900043/diff/30007/dftimewolf/lib/collectors.py
File dftimewolf/lib/collectors.py (right):

https://codereview.appspot.com/314900043/diff/30007/dftimewolf/lib/collectors...
dftimewolf/lib/collectors.py:110: hunt_id (Optional [str]): ID of GRR hunt to
retrieve artifacts from
On 2016/10/23 01:49:15, someguyiknow wrote:
> On 2016/10/22 14:52:25, onager wrote:
> > This isn't optional
> 
> I'd argue that it is (when --new_hunt is specified), unless you mean that
> *something* will be passed no matter what (None in the case of new_hunt). But
> will fix in the meantime.

Yeah, this is documenting what you need to do to call this function. You need to
pass something here, it not a optional arg.

https://codereview.appspot.com/314900043/diff/50001/dftimewolf/lib/collectors.py
File dftimewolf/lib/collectors.py (right):

https://codereview.appspot.com/314900043/diff/50001/dftimewolf/lib/collectors...
dftimewolf/lib/collectors.py:389: GRR API Client object
Please fix docstring to include the type.

https://codereview.appspot.com/314900043/diff/50001/dftimewolf/lib/collectors...
dftimewolf/lib/collectors.py:462: urn_components = flow.data.urn.split('/')
u'/'

https://codereview.appspot.com/314900043/diff/50001/dftimewolf/lib/collectors...
dftimewolf/lib/collectors.py:539: new_hunt (Optional[bool]): toggle for starting
new GRR hunt
These aren't optional, please fix

[someguyiknow, 2016-10-25 22:38:38]

Code updated.

[someguyiknow, 2016-10-25 22:38:51]

https://codereview.appspot.com/314900043/diff/50001/dftimewolf/lib/collectors.py
File dftimewolf/lib/collectors.py (right):

https://codereview.appspot.com/314900043/diff/50001/dftimewolf/lib/collectors...
dftimewolf/lib/collectors.py:539: new_hunt (Optional[bool]): toggle for starting
new GRR hunt
On 2016/10/25 16:02:40, onager wrote:
> These aren't optional, please fix

Done.

[onager, 2016-11-01 10:13:29]

OK, let's merge this. LGTM

[onager, 2016-11-01 10:13:29]

OK, let's merge this. LGTM

[someguyiknow, 2016-11-01 16:55:15]

Code updated.