Skip to content

Instantly share code, notes, and snippets.

@gmorain
Forked from jbarratt/nbgrep
Last active May 30, 2016 10:31
Show Gist options
  • Save gmorain/7a88f6cd2e595cbd580829e16702ca92 to your computer and use it in GitHub Desktop.
Save gmorain/7a88f6cd2e595cbd580829e16702ca92 to your computer and use it in GitHub Desktop.
'nbgrep', search the code of all your ipython notebooks
#!/bin/bash
# usage: nbgrep 'pattern'
SEARCHPATH=$PROJECT_HOME
# 'jq' technique lifted with gratitude
# from https://gist.github.com/mlgill/5c55253a3bc84a96addf
# Break on newlines instead of any whitespace
# IPython Notebook files often have spaces in it
SAVEIFS=$IFS
IFS=$(echo -en "\n\b")
if ! type mdfind > /dev/null 2>&1; then
# Use find from findutils
FILES=$(find $SEARCHPATH -name '*.ipynb')
else
# mdfind uses OSX's spotlight search, so it's almost instant
# generate a list of all the ipynb files in any of the directories
FILES=$(mdfind -onlyin $SEARCHPATH -name '.ipynb')
fi
# On the command line we get the argument to search for
PATTERN=$1
for f in $FILES
do
# Use 'jq' to filter out only the code in input cells
# Then remove quoting
# Colorize it with pygments (give it the most context possible to get color right)
# And finally, search the remainder for a given pattern
# Check Notebook JSON format first
NB_VERSION=$(jq '.nbformat' $f)
if [ $NB_VERSION -eq 3 ]; then
# IPython notebook JSON format
OUTPUT=$(jq '.worksheets[]?.cells[]? | select(.cell_type=="code") | .input[]?//.input' $f \
| sed 's/^"//g;s/"$//g;s/\\n$//g;s/\\"/"/g;s/\\\\/\\/g;s/\\n/\n/g' \
| pygmentize -l python 2>/dev/null \
| grep $PATTERN)
elif [ $NB_VERSION -eq 4 ]; then
# Jupyter notebook JSON format
OUTPUT=$(jq '.cells[]? | select(.cell_type=="code") | .source[]?//.source' $f \
| sed 's/^"//g;s/"$//g;s/\\n$//g;s/\\"/"/g;s/\\\\/\\/g;s/\\n/\n/g' \
| pygmentize -l python 2>/dev/null \
| grep $PATTERN)
fi
# If the grep matched anything, print it
if [ $? -eq 0 ]; then
echo -e "$f:\n\n$OUTPUT\n\n"
fi
done
IFS=$SAVEIFS
@gmorain
Copy link
Author

gmorain commented May 30, 2016

Updated to automatically detect notebook JSON format version, since Jupyter is using v4 and Python v3

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment