[pylint] Added in custom PyLint Checker for Aliasing, with tests

scripts/pylint_custom_plugin/pylint_guidelines_checker.py

@@ -1706,6 +1706,67 @@ def visit_functiondef(self, node):
     visit_asyncfunctiondef = visit_functiondef
 
 
+class CheckNoAliasGeneratedCode(BaseChecker):
+    __implements__ = IAstroidChecker
+
+    name = "check-alias"
+    priority = -1
+    msgs = {
+        "C4745": (
+            "Aliasing and exposing generated code."
+            "This messes up sphinx, intellisense, and apiview, so please modify the name of the generated code through"
+            " the swagger / directives, or code customizations",
+            "aliasing-generated-code",
+            "Do not alias models imported from the generated code.",
+        ),
+    }
+    options = (
+        (
+            "ignore-aliasing-generated-code",
+            {
+                "default": False,
+                "type": "yn",
+                "metavar": "<y_or_n>",
+                "help": "Allow generated code to be aliased.",
+            },
+        ),
+    )
+
+    def __init__(self, linter=None):
+        super(CheckNoAliasGeneratedCode, self).__init__(linter)
+
+    def visit_module(self, node):
+        """Visits __init__.py and checks that there are not aliased models.
+
+        :param node: module node
+        :type node: ast.Module
+        :return: None
+        """
+        try:
+
+            if node.file.endswith("__init__.py"):
+                aliased = []
+
+                for nod in node.body:
+                    if isinstance(nod, astroid.ImportFrom) or isinstance(nod, astroid.Import):
+                        # If the model has been aliased
+                        for name in nod.names:
+                            if name[1] != None:
+                                aliased.append(name[1])
+
+                    if isinstance(nod, astroid.Assign):
+                        for models in nod.assigned_stmts():
+                            for model_name in models.elts:
+                                if model_name.value in aliased:
+                                    self.add_message(
+                                        msgid="aliasing-generated-code", node=model_name, confidence=None
+                                    )
+
+        except Exception:
+                logger.debug("Pylint custom checker failed to check if package is aliased.")
+                pass
+
+
 # if a linter is registered in this function then it will be checked with pylint
 def register(linter):
     linter.register_checker(ClientsDoNotUseStaticMethods(linter))
@@ -1723,6 +1784,7 @@ def register(linter):
     linter.register_checker(PackageNameDoesNotUseUnderscoreOrPeriod(linter))
     linter.register_checker(ServiceClientUsesNameWithClientSuffix(linter))
     linter.register_checker(CheckDocstringAdmonitionNewline(linter))
+    linter.register_checker(CheckNoAliasGeneratedCode(linter))
 
     # disabled by default, use pylint --enable=check-docstrings if you want to use it
     linter.register_checker(CheckDocstringParameters(linter))

scripts/pylint_custom_plugin/tests/test_pylint_custom_plugins.py

@@ -2568,4 +2568,73 @@ def __init__(self):
                     msg_id="docstring-admonition-needs-newline", node=class_node
                 )
         ):
-            self.checker.visit_classdef(class_node)
+            self.checker.visit_classdef(class_node)        
+
+
+class TestCheckNoAliasGeneratedCode(pylint.testutils.CheckerTestCase):
+    CHECKER_CLASS = checker.CheckNoAliasGeneratedCode
+
+    def test_ignores_correct_alias_code(self):
+        module_node = astroid.extract_node(
+            """
+            import something as somethingElse
+            """
+        )
+
+        with self.assertNoMessages():
+            self.checker.visit_module(module_node)
+
+    def test_catches_incorrect_alias_code(self):
+        import_one = astroid.extract_node(
+            'import Something'
+
+        )
+        import_two =  astroid.extract_node(
+            'import Something2 as SomethingTwo'
+
+        )
+        assign_one = astroid.extract_node(
+        """
+            __all__ =(
+            "Something",
+            "SomethingTwo", 
+            ) 
+          """
+        )
+
+        module_node = astroid.Module(name = "node", file="__init__.py", doc = """ """)
+        module_node.body = [import_one,import_two,assign_one]
+
+        for name in module_node.body[-1].assigned_stmts():
+            err_node = name.elts[1]
+
+        with self.assertAddsMessages(
+                pylint.testutils.Message(
+                    msg_id="aliasing-generated-code", node=err_node ,confidence=None
+                )
+        ):
+            self.checker.visit_module(module_node)
+
+    def test_ignores_import_init(self):
+        import_one = astroid.extract_node(
+            'import Something'
+
+        )
+        import_two =  astroid.extract_node(
+            'import Something2 as SomethingTwo'
+
+        )
+        assign_one = astroid.extract_node(
+        """
+            __all__ =(
+            "Something",
+            "Something2", 
+            ) 
+          """
+        )
+
+        module_node = astroid.Module(name = "node", file="__init__.py", doc = """ """)
+        module_node.body = [import_one,import_two,assign_one]
+
+        with self.assertNoMessages():
+            self.checker.visit_module(module_node)