Result hooks

[adswa]

This adds a section on the new feature of result hooks to the hand book. Currently, I placed this section in the last chapter of the Basics, "Further options". It would be cool if the contents of the sections could be checked for accuracy, and if someone could point me to where I can find all possible keys and values of the result evaluation.

[mih]

Cool, thanks much! I left one critical comment and a few minor suggestions.

[mih]

I know this was me, but it is a stupid example ;-)

What about replacing the command with cp ~/templates/standard-readme.txt {path}/README and sell it as automatically populate a dataset with a default README.

[adswa]

(Personally, I found the example hilarious ;-) Will change it nevertheless)

[adswa]

I fail to get such a hook to run because of an inconveniently coinciding mismatching formatting options and command requirements: I am trying to execute "datalad run --output "README" "cp ~/Templates/standard-readme.txt {path}/README" --explicit" via a hook after successful installation of a dataset. Here are my git config calls:

For matching:

git config --global --add datalad.result-hook.readme.match-json '{"type": "dataset","action":"create","status":"ok"}'

Hook definition:

git config --global --add datalad.result-hook.readme.call-json 'run {{"cmd":"cp ~/Templates/standard-readme.txt {path}/README", "outputs":"["README"]", "dataset":"{path}","explicit":true}}'

The important part here is "outputs":"["README"]". I need to give the output definition as a list with the string. I thought I once PR'ed an assure_list(), but could only find this for create...

This fails with (Debug output):

[WARNING] Invalid argument specification for hook readme (after parameter substitutions): {"cmd":"cp ~/Templates/standard-readme.txt /tmp/ads18/README", "outputs":"["README"]", "dataset":"/tmp/ads18","explicit":true} [Expecting ',' delimiter: line 1 column 77 (char 76) [decoder.py:raw_decode:353]], hook will be skipped 

Because in "outputs":"["README"]", only the "[" part is considered. Switching to single quotes ("outputs":"['README']") or leaving quotation marks completely (both lead to no quotes in the config file) leads to README being split into its components:

[DEBUG  ] Resolved dataset for saving: /tmp/ads21 
[DEBUG  ] Determined class of decorated function: <class 'datalad.core.local.status.Status'> 
[DEBUG  ] Resolved dataset for status reporting: /tmp/ads21 
[DEBUG  ] Resolved dataset for path resolution: /tmp/ads21 
[ERROR  ] path not underneath this dataset [status(/tmp/A)] 
[DEBUG  ] Resolved dataset for path resolution: /tmp/ads21 
[ERROR  ] path not underneath this dataset [status(/tmp/D)] 
[DEBUG  ] Resolved dataset for path resolution: /tmp/ads21 
[ERROR  ] path not underneath this dataset [status(/tmp/E)] 
[DEBUG  ] Resolved dataset for path resolution: /tmp/ads21 
[ERROR  ] path not underneath this dataset [status(/tmp/E)] 
[DEBUG  ] Resolved dataset for path resolution: /tmp/ads21 
[ERROR  ] path not underneath this dataset [status(/tmp/M)] 
[DEBUG  ] Resolved dataset for path resolution: /tmp/ads21 
[ERROR  ] path not underneath this dataset [status(/tmp/R)] 
[DEBUG  ] Resolved dataset for path resolution: /tmp/ads21 
[ERROR  ] path not underneath this dataset [status(/tmp/[)] 
[DEBUG  ] Resolved dataset for path resolution: /tmp/ads21 
[ERROR  ] path not underneath this dataset [status(/tmp/])] 
[DEBUG  ] Determined 0 datasets for saving from input arguments 
[DEBUG  ] chdir '/tmp' -> '/tmp' (coming back) 
[DEBUG  ] could not perform all requested actions: Command did not complete successfully [{'action': 'status', 'path': PosixPath('/tmp/A'), 'refds': '/tmp/ads21', 'status': 'error', 'message': 'path not underneath this dataset'}, {'action': 'status', 'path': PosixPath('/tmp/D'), 'refds': '/tmp/ads21', 'status': 'error', 'message': 'path not underneath this dataset'}, {'action': 'status', 'path': PosixPath('/tmp/E'), 'refds': '/tmp/ads21', 'status': 'error', 'message': 'path not underneath this dataset'}, {'action': 'status', 'path': PosixPath('/tmp/E'), 'refds': '/tmp/ads21', 'status': 'error', 'message': 'path not underneath this dataset'}, {'action': 'status', 'path': PosixPath('/tmp/M'), 'refds': '/tmp/ads21', 'status': 'error', 'message': 'path not underneath this dataset'}, {'action': 'status', 'path': PosixPath('/tmp/R'), 'refds': '/tmp/ads21', 'status': 'error', 'message': 'path not underneath this dataset'}, {'action': 'status', 'path': PosixPath('/tmp/['), 'refds': '/tmp/ads21', 'status': 'error', 'message': 'path not underneath this dataset'}, {'action': 'status', 'path': PosixPath('/tmp/]'), 'refds': '/tmp/ads21', 'status': 'error', 'message': 'path not underneath this dataset'}] [utils.py:generator_func:495] 

I've unsucessfully tried escaping single or double quotes in the config call as well (e.g., git config --global --replace-all datalad.result-hook.readme.call-json 'run {{"cmd":"cp ~/Templates/standard-readme.txt {path}/README", "outputs":"[\'README\']", "dataset":"{path}","explicit":true}}'. Do you see a way of giving a list with a string to the hook definition @mih?

[mih]

I will try it myself, but why "["README"]" instead of ["README"]. This is valid JSON for a list.

[mih]

Seems to work fine without the outer quotes.

% git config --add datalad.result-hook.readme.match-json '{"type": "dataset","action":"create","status":"ok"}'
% git config --add datalad.result-hook.readme.call-json 'run {{"cmd":"cp ~/Templates/standard-readme.txt {path}/README", "outputs":["README"], "dataset":"{path}","explicit":true}}'
% datalad create -d . subds1
[INFO   ] Creating a new annex repo at /tmp/testhook/subds1 
add(ok): subds1 (file)                                                                                                       
add(ok): .gitmodules (file)
save(ok): . (dataset)
create(ok): subds1 (dataset)
[INFO   ] == Command start (output follows) ===== 
[INFO   ] == Command exit (modification check follows) ===== 
(datalad3-dev) 1 mih@meiner /tmp/testhook (git)-[master] % ls subds1
README
(datalad3-dev) mih@meiner /tmp/testhook (git)-[master] % cat subds1/README
dummy

[adswa]

FTR: I've addressed everything but the command example that I could not yet get to work.

[mih]

With the last two minor bits changed, this is good to go! Thx!

[adswa]

This is done, will merge.