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
|
#!/usr/bin/env python
# --------------------------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
# --------------------------------------------------------------------------------------------
import sys
import os
sys.path.append(os.path.abspath("../../scripts/breaking_changes_checker"))
from _models import CheckerType
import jsondiff
def parse_overload_signature(method_name, overload) -> str:
parsed_overload_signature = f"def {method_name}(" + ", ".join([f"{name}: {data['type']}" for name, data in overload["parameters"].items()]) + ")"
if overload["return_type"] is not None:
parsed_overload_signature += f" -> {overload['return_type']}"
return parsed_overload_signature
class AddedMethodOverloadChecker:
node_type = CheckerType.FUNCTION_OR_METHOD
name = "AddedMethodOverload"
is_breaking = False
message = {
"default": "Method `{}.{}` has a new overload `{}`",
}
def run_check(self, diff, stable_nodes, current_nodes, **kwargs):
module_name = kwargs.get("module_name")
class_name = kwargs.get("class_name")
changes_list = []
for method_name, method_components in diff.items():
# We aren't checking for deleted methods in this checker
if isinstance(method_name, jsondiff.Symbol):
continue
for overload in method_components.get("overloads", []):
if isinstance(overload, jsondiff.Symbol):
if overload.label == "insert":
for _, added_overload in method_components["overloads"][overload]:
parsed_overload_signature = parse_overload_signature(method_name, added_overload)
changes_list.append((self.message["default"], self.name, module_name, class_name, method_name, parsed_overload_signature))
elif isinstance(overload, int):
current_node_overload = current_nodes[module_name]["class_nodes"][class_name]["methods"][method_name]["overloads"][overload]
parsed_overload_signature = f"def {method_name}(" + ", ".join([f"{name}: {data['type']}" for name, data in current_node_overload["parameters"].items()]) + ")"
if current_node_overload["return_type"] is not None:
parsed_overload_signature += f" -> {current_node_overload['return_type']}"
changes_list.append((self.message["default"], self.name, module_name, class_name, method_name, parsed_overload_signature))
else:
# this case is for when the overload is not a symbol and simply shows as a new overload in the diff
parsed_overload_signature = parse_overload_signature(method_name, overload)
changes_list.append((self.message["default"], self.name, module_name, class_name, method_name, parsed_overload_signature))
return changes_list
|
