-
Notifications
You must be signed in to change notification settings - Fork 225
/
export_notebook_code.py
executable file
·191 lines (158 loc) · 6.54 KB
/
export_notebook_code.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
#!/usr/bin/env python
import io, os, sys, types, re
import datetime
# from IPython import get_ipython
# from IPython.core.interactiveshell import InteractiveShell
import nbformat
from import_notebooks import RE_CODE
# Things to ignore in exported Python code
RE_IGNORE = re.compile(r'^get_ipython().*|^%.*')
RE_IMPORT_FUZZINGBOOK_UTILS = re.compile(r'^import fuzzingbook_utils.*$', re.MULTILINE)
RE_FROM_FUZZINGBOOK_UTILS = re.compile(r'^from fuzzingbook_utils import .*$', re.MULTILINE)
# Things to import only if main (reduces dependencies)
RE_IMPORT_IF_MAIN = re.compile(r'^(from|import) (matplotlib|graphviz|mpl_toolkits|numpy|IPython|requests|FTB|Collector|fuzzingbook_utils import YouTubeVideo).*$')
# Strip blank lines
RE_BLANK_LINES = re.compile(r'^[ \t]*$', re.MULTILINE)
# Comments
RE_COMMENTS = re.compile(r'^#.*$', re.MULTILINE)
# Common header for all code
HEADER = """#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# This material is part of "Generating Software Tests".
# Web site: https://www.fuzzingbook.org/html/{module}.html
# Last change: {timestamp}
#
#
# Copyright (c) 2018-2019 Saarland University, CISPA, authors, and contributors
#
# Permission is hereby granted, free of charge, to any person obtaining a
# copy of this software and associated documentation files (the
# "Software"), to deal in the Software without restriction, including
# without limitation the rights to use, copy, modify, merge, publish,
# distribute, sublicense, and/or sell copies of the Software, and to
# permit persons to whom the Software is furnished to do so, subject to
# the following conditions:
#
# The above copyright notice and this permission notice shall be included
# in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
# OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
"""
# Replacement for "import fuzzingbook_utils"
SET_FIXED_SEED = r"""# We use the same fixed seed as the notebook to ensure consistency
import random
random.seed(2001)"""
def is_all_comments(code):
executable_code = re.sub(RE_COMMENTS, '', code).strip()
return executable_code == ""
def prefix_code(code, prefix):
return prefix + code.replace('\n', '\n' + prefix)
def indent_code(code):
lines = prefix_code(code, " ")
return re.sub(RE_BLANK_LINES, '', lines)
def fix_imports(code):
# For proper packaging, we must import our modules from the local dir
# Our modules all start with an upper-case letter
if code.startswith("from IPython"):
# IPython
return code
if code.find("Collector") >= 0 or code.find("FTB") >= 0:
# FuzzManager imports
return code
code = re.sub(r"^from *([A-Z].*|fuzzingbook_utils.*)$",
r'''if __package__ is None or __package__ == "":
from \1
else:
from .\1
''', code, flags=re.MULTILINE)
code = re.sub(r"^import *([A-Z].*|fuzzingbook_utils.*)$",
r'''if __package__ is None or __package__ == "":
import \1
else:
from . import \1
''', code, flags=re.MULTILINE)
return code
def first_line(text):
index = text.find('\n')
if index >= 0:
return text[:index]
else:
return text
def print_utf8(s):
sys.stdout.buffer.write(s.encode('utf-8'))
def decode_title(s):
# We have non-breaking spaces in some titles
return s.replace('\xa0', ' ')
def print_if_main(code):
# Run code only if run as main file
print_utf8('\nif __name__ == "__main__":\n')
print_utf8(indent_code(code) + "\n\n")
def export_notebook_code(notebook_name, path=None):
# notebook_path = import_notebooks.find_notebook(notebook_name, path)
notebook_path = notebook_name
# load the notebook
with io.open(notebook_path, 'r', encoding='utf-8') as f:
notebook = nbformat.read(f, 4)
# shell = InteractiveShell.instance()
# Get versioning info
notebook_modification_time = os.path.getmtime(notebook_path)
timestamp = datetime.datetime.fromtimestamp(notebook_modification_time) \
.astimezone().isoformat(sep=' ', timespec='seconds')
module = os.path.splitext(os.path.basename(notebook_name))[0]
header = HEADER.format(module=module, timestamp=timestamp)
print_utf8(header)
sep = ''
for cell in notebook.cells:
if cell.cell_type == 'code':
code = cell.source
if len(code.strip()) == 0:
# Empty code
continue
bang = False
if code.startswith('!'):
code = "import os\nos.system(" + repr(code[1:]) + ")"
bang = True
if RE_IMPORT_FUZZINGBOOK_UTILS.match(code):
# Don't import all of fuzzingbook_utils (requires nbformat & Ipython)
print_if_main(SET_FIXED_SEED)
elif RE_IMPORT_IF_MAIN.match(code):
print_if_main(code)
elif RE_FROM_FUZZINGBOOK_UTILS.match(code):
# This would be "from fuzzingbook_utils import HTML"
# print ("Code: ", repr(code))
code = fix_imports(code)
print_utf8("\n" + code + "\n")
elif RE_IGNORE.match(code):
# Code to ignore - comment out
print_utf8("\n" + prefix_code(code, "# ") + "\n")
elif RE_CODE.match(code) and not bang:
# imports and defs
code = fix_imports(code)
print_utf8("\n" + code + "\n")
elif is_all_comments(code):
# Only comments
print_utf8("\n" + code + "\n")
else:
print_if_main(code)
else:
# Anything else
contents = cell.source
if contents.startswith('#'):
# Header
line = first_line(contents)
print_utf8("\n" + prefix_code(decode_title(line), "# ") + "\n")
print_if_main("print(" + repr(sep + decode_title(line)) + ")\n\n")
sep = '\n'
else:
# We don't include contents, as they fall under a different license
# print_utf8("\n" + prefix_code(contents, "# ") + "\n")
pass
if __name__ == "__main__":
for notebook in sys.argv[1:]:
export_notebook_code(notebook)