microsoft
/
FeaturizersLibrary
зеркало из https://github.com/microsoft/FeaturizersLibrary.git
1
0
Форкнуть 0
Код Задачи Пакеты Проекты Релизы Вики Активность

Merged PR 4669: Improved error messages 

Gave more detailed information on errors within functions and structs.
Updated UnitTests and IntegrationTests accordingly.
This commit is contained in:
Teo Magnino Chaban 2019-07-09 18:44:17 +00:00
Родитель c3a9caee65
Коммит 88eb76fad5
4 изменённых файлов: 181 добавлений и 46 удалений
Показать статистику Скачать Patch файл Скачать Diff файл Показать все файлы Свернуть все файлы

103
Libraries/Python/DataPipelines/v1.0/DataPipelines/CppToJson.py
Просмотреть файл

@ -16,7 +16,7 @@ import CommonEnvironment.Shell as CE_Shell
# ----------------------------------------------------------------------
def ObtainFunctions(
input_filename,
on_unsupported_func,
on_unsupported,
policy,
):
"""
@ -89,7 +89,7 @@ def ObtainFunctions(
)"""
)
)
# TODO: Dont support pointers.
# TODO: Dont support pointers (that use the '*' notation).
pattern_star = re.compile(r"\**(\* )*")
pattern_amper = re.compile("&*(& )*")
@ -98,7 +98,7 @@ def ObtainFunctions(
"""
Remove 'const', '*' and '&'
"""
# TODO: Dont support pointers.
# TODO: Dont support pointers (that use the '*' notation).
name = re.sub(pattern_const, "", name)
name = re.sub(pattern_star, "", name)
name = re.sub(pattern_amper, "", name)
@ -185,10 +185,6 @@ def ObtainFunctions(
if obj_type:
object_type_list.append(obj_type)
elif obj_type is None and node.location.file.name == filename:
# TODO: Change this to not require that functions on the file are valid.
# If None was returned, there was a problem with the ObjectType and it can't be processed
on_unsupported_func(_FullName(node), filename if (not is_temp_file or filename != input_filename) else None, node.location.line)
# ----------------------------------------------------------------------
def EnumerateFuncs(node):
@ -287,38 +283,72 @@ def ObtainFunctions(
return False
if obj_type in needed_obj_type_list:
return True
for var_type in obj_type.EnumerateSimpleVarTypes():
invalid_reasons = []
for var_type, var_name in zip(obj_type.EnumerateSimpleVarTypes(), obj_type.EnumerateVarNames()):
if GetObjType(var_type) != obj_type and not IsValidObjType(GetObjType(var_type)) and not TestAndVerify(var_type):
invalid_obj_type_list.append(obj_type)
return False
invalid_reasons.append("\t- Invalid var {} of type {}.".format(var_name, var_type))
for constructor in obj_type.constructor_list:
for arg_type in constructor.EnumerateSimpleVarTypes():
if GetObjType(arg_type) != obj_type and not IsValidObjType(GetObjType(arg_type)) and not TestAndVerify(arg_type):
invalid_obj_type_list.append(obj_type)
return False
invalid_reasons.append("\t- Invalid type {} on constructor argument.".format(arg_type))
if not obj_type.has_move_constructor:
invalid_reasons.append("\t- Struct doesn't have a move constructor.")
if obj_type.has_copy_constructor:
invalid_reasons.append("\t- Struct have a copy constructor.")
if obj_type.has_private:
invalid_reasons.append("\t- Struct has private variables.")
if obj_type.has_other:
invalid_reasons.append("\t- Struct has an unsupported definition.")
if invalid_reasons:
on_unsupported(textwrap.dedent(
"""\
The struct {} is not supported:
{}
"""
).format(obj_type.Name, "\n".join(invalid_reasons)),
obj_type.Filename if (not is_temp_file or obj_type.Filename != input_filename) else None,
obj_type.DefinitionLine
)
invalid_obj_type_list.append(obj_type)
return False
needed_obj_type_list.append(obj_type)
return True
# ----------------------------------------------------------------------
def IsValidFunc(func):
def IsValidFunc(func, filename):
"""
A function is valid if all var types are valid.
"""
for var_type in func["simple_var_types"]:
invalid_reasons = []
for var_type, var_name in zip(func["simple_var_types"], func["var_names"]):
if not TestAndVerify(var_type):
return False
if not IsValidObjType(GetObjType(func["simple_return_type"])) and not TestAndVerify(func["simple_return_type"]):
invalid_reasons.append("\t- Invalid argument {} of type {}.".format(var_name, var_type))
return_type = func["simple_return_type"]
if not IsValidObjType(GetObjType(return_type)) and not TestAndVerify(return_type):
invalid_reasons.append("\t- Invalid return type {}.".format(return_type))
if invalid_reasons:
on_unsupported(textwrap.dedent(
"""\
The function {} is not supported:
{}
"""
).format(func["func_name"], "\n".join(invalid_reasons)),
filename if (not is_temp_file or filename != input_filename) else None,
func["definition_line"]
)
return False
return True
# ----------------------------------------------------------------------
for func in these_results["function_list"]:
if IsValidFunc(func):
if IsValidFunc(func, filename):
clean_results[filename].function_list.append(func)
else:
on_unsupported_func(func['func_name'], filename, func['definition_line'])
# Add required ObjType to the clean_results list.
for object_type in needed_obj_type_list:
@ -381,6 +411,11 @@ class _FuncWithArguments(object):
for _, _, simple_var_type in self._variable_info:
yield simple_var_type
# ----------------------------------------------------------------------
def EnumerateVarNames(self):
for var_name, _, _ in self._variable_info:
yield var_name
# ----------------------------------------------------------------------
def VariableLen(self):
return len(self._variable_info)
@ -398,6 +433,10 @@ class ClassLikeObject(_FuncWithArguments):
filename,
variable_info=None,
constructor_list=None,
has_move_constructor=None,
has_copy_constructor=None,
has_private=None,
has_other=None
):
super(ClassLikeObject, self).__init__(
variable_info=variable_info,
@ -408,6 +447,11 @@ class ClassLikeObject(_FuncWithArguments):
self.Filename = filename
self.constructor_list = constructor_list or []
self.has_move_constructor = has_move_constructor or False
self.has_copy_constructor = has_copy_constructor or False
self.has_private = has_private or False
self.has_other = has_other or False
# ----------------------------------------------------------------------
def __repr__(self):
@ -554,8 +598,6 @@ def _GetObjectType(node, SimpleVarType, FullVarType):
errors.
"""
valid_object_type = True
has_move_constructor = False
object_type = ClassLikeObject(_FullName(node), node.location.line, os.path.realpath(node.location.file.name))
# The way to see if this is a definition or not, is to see if 'node' has any children.
@ -591,7 +633,7 @@ def _GetObjectType(node, SimpleVarType, FullVarType):
object_type.constructor_list.append(constructor)
if child.is_move_constructor() and child.access_specifier == cindex.AccessSpecifier.PUBLIC:
has_move_constructor = True
object_type.has_move_constructor = True
if DeleteDefault(child, "default"):
# If this is a default move constructor, there wont be a variable name for the
# argument in the function, so I create one when I return the dictionary representation.
@ -599,13 +641,13 @@ def _GetObjectType(node, SimpleVarType, FullVarType):
elif child.is_copy_constructor() and child.access_specifier == cindex.AccessSpecifier.PUBLIC:
# No public copy constructors are allowed.
valid_object_type = False
object_type.has_copy_constructor = True
elif child.kind == cindex.CursorKind.FIELD_DECL:
var_type = FullVarType(child.type.spelling)
object_type.AddVar(child.spelling, var_type, SimpleVarType(var_type))
if child.access_specifier != cindex.AccessSpecifier.PUBLIC:
valid_object_type = False
object_type.has_private = True
elif child.kind == cindex.CursorKind.CXX_METHOD:
# If this method ends in "=delete", ignore it.
@ -618,10 +660,10 @@ def _GetObjectType(node, SimpleVarType, FullVarType):
for arg in child.get_arguments():
# Check the arguments to verify that this is a move operator.
if FullVarType(arg.type.spelling) != move_operator_arg_type:
valid_object_type = False
object_type.has_other = True
else:
# No other functions besides move operators are allowed.
valid_object_type = False
object_type.has_other = True
elif child.kind == cindex.CursorKind.CXX_BASE_SPECIFIER:
# TODO: This means that this classLikeObject depends on another one
@ -629,10 +671,9 @@ def _GetObjectType(node, SimpleVarType, FullVarType):
# Check that this is public.
pass
elif child.kind not in accepted_kinds:
valid_object_type = False
object_type.has_other = True
if not is_def and (not valid_object_type or not has_move_constructor):
return None
elif not is_def:
if not is_def:
return object_type
return {}
return None

35
Libraries/Python/DataPipelines/v1.0/DataPipelines/IntegrationTests/CppToJson_IntegrationTest.py
Просмотреть файл

@ -4,6 +4,8 @@ import sys
import os
import json
import unittest
import textwrap
import CommonEnvironment
from DataPipelines import CppToJson
@ -108,8 +110,39 @@ class FileTest(unittest.TestCase):
def onUnsupportedFunc(func, this_filename, line):
nonlocal called_count
called_count += 1
self.assertTrue([func, this_filename, line] in [['Point', filename, 5], ['operator+', filename, 15], ['sum', filename, 22], ['go', filename, 26], ['main', filename, 34]])
unsupported_list = [
[textwrap.dedent("""\
The struct Point is not supported:
\t- Invalid var x of type int.
\t- Invalid var y of type int.
\t- Invalid type int on constructor argument.
\t- Invalid type int on constructor argument.
\t- Struct doesn't have a move constructor.
"""), this_filename, 5],
[textwrap.dedent("""\
The function operator+ is not supported:
\t- Invalid argument a of type Point.
\t- Invalid argument b of type Point.
\t- Invalid return type Point.
"""), this_filename, 15],
[textwrap.dedent("""\
The function sum is not supported:
\t- Invalid argument a of type Point.
\t- Invalid return type int.
"""), this_filename, 22],
[textwrap.dedent("""\
The function go is not supported:
\t- Invalid argument n of type int.
\t- Invalid return type vector<int>.
"""), this_filename, 26],
[textwrap.dedent("""\
The function main is not supported:
\t- Invalid return type int.
"""), this_filename, 34]
]
self.assertTrue([func, this_filename, line] in unsupported_list)
# ----------------------------------------------------------------------
func_list = self._GetFuncList(filename, CppToJson.ObtainFunctions(filename, onUnsupportedFunc, lambda type: False))

83
Libraries/Python/DataPipelines/v1.0/DataPipelines/UnitTests/CppToJson_UnitTest.py
Просмотреть файл

@ -372,10 +372,28 @@ class FuncTest(unittest.TestCase):
}
''')
# ----------------------------------------------------------------------
def onUnsupportedFunc(func, filename, line):
def onUnsupportedFunc(error_desc, filename, line):
nonlocal was_called
was_called = True
self.assertTrue([func, filename, line] in [['x', None, 4], ['go', None, 9], ['main', None, 14]])
unsupported_list = [
[textwrap.dedent("""\
The struct x is not supported:
\t- Invalid var a of type int.
\t- Invalid var b of type int.
"""), None, 4],
[textwrap.dedent("""\
The function go is not supported:
\t- Invalid argument y of type int.
\t- Invalid return type x.
"""), None, 9],
[textwrap.dedent("""\
The function main is not supported:
\t- Invalid return type int.
"""), None, 14]
]
self.assertTrue([error_desc, filename, line] in unsupported_list)
# ----------------------------------------------------------------------
@ -479,10 +497,31 @@ class FuncTest(unittest.TestCase):
}
''')
# ----------------------------------------------------------------------
def onUnsupportedFunc(func, filename, line):
def onUnsupportedFunc(error_desc, filename, line):
nonlocal was_called
was_called = True
self.assertTrue([func, filename, line] in [['Point', None, 1], ['operator+', None, 11], ['main', None, 18]])
unsupported_list = [
[textwrap.dedent("""\
The struct Point is not supported:
\t- Invalid var x of type int.
\t- Invalid var y of type int.
\t- Invalid type int on constructor argument.
\t- Invalid type int on constructor argument.
\t- Struct doesn't have a move constructor.
"""), None, 1],
[textwrap.dedent("""\
The function operator+ is not supported:
\t- Invalid argument a of type Point.
\t- Invalid argument b of type Point.
\t- Invalid return type Point.
"""), None, 11],
[textwrap.dedent("""\
The function main is not supported:
\t- Invalid return type int.
"""), None, 18]
]
self.assertTrue([error_desc, filename, line] in unsupported_list)
# ----------------------------------------------------------------------
func_list = self._GetFuncList(CppToJson.ObtainFunctions(s, onUnsupportedFunc, lambda type: False))
@ -628,10 +667,27 @@ class FuncTest(unittest.TestCase):
# ----------------------------------------------------------------------
def onUnsupportedFunc(func, filename, line):
def onUnsupportedFunc(error_desc, filename, line):
nonlocal was_called
was_called = True
self.assertTrue([func, filename, line] in [["DataPipelines::Arithmetic::MyStruct", None, 6], ["DataPipelines::Arithmetic::Add", None, 11]])
unsupported_list = [
[textwrap.dedent("""\
The struct DataPipelines::Arithmetic::MyStruct is not supported:
\t- Invalid var a of type int64_t.
\t- Invalid var b of type int64_t.
\t- Invalid type int64_t on constructor argument.
\t- Invalid type int64_t on constructor argument.
\t- Struct doesn't have a move constructor.
"""), None, 6],
[textwrap.dedent("""\
The function DataPipelines::Arithmetic::Add is not supported:
\t- Invalid argument s1 of type DataPipelines::Arithmetic::MyStruct.
\t- Invalid argument s2 of type DataPipelines::Arithmetic::MyStruct.
\t- Invalid return type DataPipelines::Arithmetic::MyStruct.
"""), None, 11]
]
self.assertTrue([error_desc, filename, line] in unsupported_list)
# ----------------------------------------------------------------------
func_list = self._GetFuncList(CppToJson.ObtainFunctions(s, onUnsupportedFunc, lambda type: False))
@ -665,10 +721,17 @@ class FuncTest(unittest.TestCase):
# ----------------------------------------------------------------------
def onUnsupportedFunc(func, filename, line):
def onUnsupportedFunc(error_desc, filename, line):
nonlocal was_called
was_called = True
self.assertTrue([func, filename, line] in [["go", None, 7]])
unsupported_list = [
[textwrap.dedent("""\
The function go is not supported:
\t- Invalid argument ya of type x.
"""), None, 7]
]
self.assertTrue([error_desc, filename, line] in unsupported_list)
# ----------------------------------------------------------------------
def Policy(var_type):
@ -719,8 +782,8 @@ class FuncTest(unittest.TestCase):
# ----------------------------------------------------------------------
def onUnsupportedFunc(func, filename, line):
self.assertFalse(False)
def onUnsupportedFunc(error_desc, filename, line):
self.assertTrue(False)
# ----------------------------------------------------------------------
def Policy(var_type):

6
Scripts/CppToJson.py
Просмотреть файл

@ -23,14 +23,12 @@ def EntryPoint(
pass
def OnUnsupportedFunc(func, filename, line):
# TODO: Change this to be more specific.
# usupported function {} in {} <{}> because type {} is not supported.
# Display error
if treat_warnings_as_errors:
sys.stdout.write("Error: Unsupported function '{}' in {} <{}>\n".format(func, filename, line))
sys.stdout.write("Error: {} in {} <{}>\n".format(func, filename, line))
raise UnsupportedException()
else:
sys.stdout.write("Warning: Unsupported function '{}' in {} <{}>\n".format(func, filename, line))
sys.stdout.write("Warning: {} in {} <{}>\n".format(func, filename, line))
# ----------------------------------------------------------------------