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
|
from dataclasses import dataclass
import importlib
import inspect
import pkgutil
import sys
import os
import re
@dataclass
class Reflect:
client_code_path:str
imported_modules = {}
def __post_init__(self):
self.client_code_path = os.path.normpath(self.client_code_path)
sys.path.insert(1, self.client_code_path)
self.client_modules = [p for p in pkgutil.iter_modules() if os.path.normpath(str(p[0])[12:-2]) == self.client_code_path]
def import_module(self, module_name):
"""Imports a module. Before reflection can be conducted, a module
must be imported. WARNING: This will execute module code if it isn't
in a if __name__ == "__main__". Takes a module name (that the student made)
as the first argument.
Args:
module_name (str): The name of a student's module to import
"""
for module in self.client_modules:
if module.name == module_name:
self.imported_modules[module_name] = importlib.import_module(module.name)
def get_module_doc(self, module_name):
"""Gets the documentation provided for a module.
Args:
module_name (str): The student's module name to get documentation for
Returns:
str: Provided documentation
"""
return inspect.getdoc(self.imported_modules[module_name])
def get_classes(self, module_name):
"""Gets the classes in a given module. The module must be imported first.
Args:
module_name (str): The name of an imported module to get the name of.
Returns:
dict: Dictionary of classes. The name of the class is the index, followed by
a tuple containing the class object and the classes' documentation.
"""
return {
i[0]: (i[1], inspect.getdoc(i[1]))
for i in inspect.getmembers(self.imported_modules[module_name])
if inspect.isclass(i[1])
}
def get_class_methods(self, module_name, class_name):
"""Gets the user generated methods of a given class. The module must be imported first.
Args:
module_name (str): The name of the module in which the class is contained.
class_name (str): The name of the class.
Returns:
dict: A dictionary of the methods. The index is the function name, followed by a tuple
containing the function object, the documentation, and the args as a dict.
"""
return {
i[0]: (i[1], inspect.getdoc(i[1]), inspect.getfullargspec(i[1])._asdict())
for i in inspect.getmembers(
self.get_classes(module_name)[class_name][0],
predicate=inspect.isfunction
)
}
def get_functions(self, module_name):
return {
i[0]: (i[1], inspect.getdoc(i[1]), inspect.getfullargspec(i[1])._asdict())
for i in inspect.getmembers(self.imported_modules[module_name])
if inspect.isfunction(i[1])
}
def gen_reflection_report(client_code_path, assessment_struct):
reflection = Reflect(client_code_path)
present_module_names = [i.name for i in reflection.client_modules]
out = assessment_struct
for i, required_file in enumerate(assessment_struct["files"], 0):
required_file = list(required_file.keys())[0]
module_name = os.path.splitext(required_file)[0]
if module_name in present_module_names:
out["files"][i][required_file]["present"] = True
else:
out["files"][i][required_file]["present"] = False
continue
reflection.import_module(module_name)
required_files_features = assessment_struct["files"][i][required_file]
if "classes" in required_files_features.keys():
present_classes = reflection.get_classes(module_name)
for j, class_name in enumerate(required_files_features["classes"], 0):
class_name = list(class_name.keys())[0]
if class_name in present_classes.keys():
out["files"][i][required_file]["classes"][j][class_name]["present"] = True
else:
out["files"][i][required_file]["classes"][j][class_name]["present"] = True
continue
out["files"][i][required_file]["classes"][j][class_name]["documentation"] = present_classes[class_name][1]
present_methods = reflection.get_class_methods(module_name, class_name)
for k, required_method in enumerate(assessment_struct["files"][i][required_file]["classes"][j][class_name]["methods"], 0):
out["files"][i][required_file]["classes"][j][class_name]["methods"][k] = {required_method: {}}
method_name = re.sub(r"\(\d+\)", "", required_method)
if method_name in present_methods.keys():
out["files"][i][required_file]["classes"][j][class_name]["methods"][k][required_method]["present"] = True
else:
out["files"][i][required_file]["classes"][j][class_name]["methods"][k][required_method]["present"] = False
continue
out["files"][i][required_file]["classes"][j][class_name]["methods"][k][required_method]["arguments"] = present_methods[method_name][-1]
out["files"][i][required_file]["classes"][j][class_name]["methods"][k][required_method]["documentation"] = present_methods[method_name][-2]
if "functions" in required_files_features.keys():
present_functions = reflection.get_functions(module_name)
# print(present_functions)
for j, required_function in enumerate(assessment_struct["files"][i][required_file]["functions"], 0):
function_name = re.sub(r"\(\d+\)", "", required_function)
out["files"][i][required_file]["functions"][j] = {required_function: {}}
if function_name in present_functions.keys():
out["files"][i][required_file]["functions"][j][required_function]["present"] = True
else:
out["files"][i][required_file]["functions"][j][required_function]["present"] = False
continue
out["files"][i][required_file]["functions"][j][required_function]["documentation"] = present_functions[function_name][-2]
out["files"][i][required_file]["functions"][j][required_function]["arguments"] = present_functions[function_name][-1]
return out
if __name__ == "__main__":
user_code_path = "D:\\Edencloud\\UniStuff\\3.0 - CMP 3rd Year Project\\Smarker\\../ExampleSubmissions/Submission_A"
reflect = Reflect(user_code_path)
reflect.import_module("pjtool")
print(reflect.get_class_methods("pjtool", "Date"))
|
