Turned off general recommendations in all analyzers and added dnd-character test. Re-recorded golden test files. (#76)

BethanyG · web-flow · commit 666c219ffbf2 · 2026-02-27T16:23:27.000-08:00
diff --git a/lib/common/generic_analyzer/analyzer.py b/lib/common/generic_analyzer/analyzer.py
@@ -62,7 +62,8 @@ def analyze(in_path: Path, out_path: Path):
     comments.extend(generate_pylint_comments(in_path))
 
      # If there are no comments, add the general recommendations as comments.
-    if not comments:
-        comments.append(Comment(type=CommentTypes.INFORMATIVE, params={}, comment=Comments.GENERAL_RECS))
+     # We're disabling this for now, until we can find a better way to present these.
+    # if not comments:
+    #     comments.append(Comment(type=CommentTypes.INFORMATIVE, params={}, comment=Comments.GENERAL_RECS))
 
     return Analysis.summarize_comments(comments, output_file)
diff --git a/lib/currency-exchange/analyzer.py b/lib/currency-exchange/analyzer.py
@@ -60,7 +60,7 @@ def analyze(in_path: Path, out_path: Path):
     comments.extend(generate_pylint_comments(in_path))
 
      # If there are no comments, add the general recommendations as comments.
-    if not comments:
-        comments.append(Comment(type=CommentTypes.INFORMATIVE, params={}, comment=Comments.GENERAL_RECS))
+    # if not comments:
+    #     comments.append(Comment(type=CommentTypes.INFORMATIVE, params={}, comment=Comments.GENERAL_RECS))
 
     return Analysis.summarize_comments(comments, output_file)
diff --git a/lib/ellens-alien-game/analyzer.py b/lib/ellens-alien-game/analyzer.py
@@ -60,7 +60,7 @@ def analyze(in_path: Path, out_path: Path):
     comments.extend(generate_pylint_comments(in_path))
 
      # If there are no comments, add the general recommendations as comments.
-    if not comments:
-        comments.append(Comment(type=CommentTypes.INFORMATIVE, params={}, comment=Comments.GENERAL_RECS))
+    # if not comments:
+    #     comments.append(Comment(type=CommentTypes.INFORMATIVE, params={}, comment=Comments.GENERAL_RECS))
 
     return Analysis.summarize_comments(comments, output_file)
diff --git a/lib/ghost-gobble-arcade-game/analyzer.py b/lib/ghost-gobble-arcade-game/analyzer.py
@@ -60,7 +60,7 @@ def analyze(in_path: Path, out_path: Path):
     comments.extend(generate_pylint_comments(in_path))
 
      # If there are no comments, add the general recommendations as comments.
-    if not comments:
-        comments.append(Comment(type=CommentTypes.INFORMATIVE, params={}, comment=Comments.GENERAL_RECS))
+    # if not comments:
+    #     comments.append(Comment(type=CommentTypes.INFORMATIVE, params={}, comment=Comments.GENERAL_RECS))
 
     return Analysis.summarize_comments(comments, output_file)
diff --git a/lib/guidos-gorgeous-lasagna/analyzer.py b/lib/guidos-gorgeous-lasagna/analyzer.py
@@ -60,7 +60,7 @@ def analyze(in_path: Path, out_path: Path):
     comments.extend(generate_pylint_comments(in_path))
 
      # If there are no comments, add the general recommendations as comments.
-    if not comments:
-        comments.append(Comment(type=CommentTypes.INFORMATIVE, params={}, comment=Comments.GENERAL_RECS))
+    # if not comments:
+    #     comments.append(Comment(type=CommentTypes.INFORMATIVE, params={}, comment=Comments.GENERAL_RECS))
 
     return Analysis.summarize_comments(comments, output_file)
diff --git a/lib/inventory-management/analyzer.py b/lib/inventory-management/analyzer.py
@@ -60,7 +60,7 @@ def analyze(in_path: Path, out_path: Path):
     comments.extend(generate_pylint_comments(in_path))
 
      # If there are no comments, add the general recommendations as comments.
-    if not comments:
-        comments.append(Comment(type=CommentTypes.INFORMATIVE, params={}, comment=Comments.GENERAL_RECS))
+    # if not comments:
+    #     comments.append(Comment(type=CommentTypes.INFORMATIVE, params={}, comment=Comments.GENERAL_RECS))
 
     return Analysis.summarize_comments(comments, output_file)
diff --git a/lib/little-sisters-essay/analyzer.py b/lib/little-sisters-essay/analyzer.py
@@ -60,7 +60,7 @@ def analyze(in_path: Path, out_path: Path):
     comments.extend(generate_pylint_comments(in_path))
 
      # If there are no comments, add the general recommendations as comments.
-    if not comments:
-        comments.append(Comment(type=CommentTypes.INFORMATIVE, params={}, comment=Comments.GENERAL_RECS))
+    # if not comments:
+    #     comments.append(Comment(type=CommentTypes.INFORMATIVE, params={}, comment=Comments.GENERAL_RECS))
 
     return Analysis.summarize_comments(comments, output_file)
diff --git a/lib/little-sisters-vocab/analyzer.py b/lib/little-sisters-vocab/analyzer.py
@@ -60,7 +60,7 @@ def analyze(in_path: Path, out_path: Path):
     comments.extend(generate_pylint_comments(in_path))
 
      # If there are no comments, add the general recommendations as comments.
-    if not comments:
-        comments.append(Comment(type=CommentTypes.INFORMATIVE, params={}, comment=Comments.GENERAL_RECS))
+    # if not comments:
+    #     comments.append(Comment(type=CommentTypes.INFORMATIVE, params={}, comment=Comments.GENERAL_RECS))
 
     return Analysis.summarize_comments(comments, output_file)
diff --git a/lib/log-levels/analyzer.py b/lib/log-levels/analyzer.py
@@ -59,7 +59,7 @@ def analyze(in_path: Path, out_path: Path):
     comments.extend(generate_pylint_comments(in_path))
 
      # If there are no comments, add the general recommendations as comments.
-    if not comments:
-        comments.append(Comment(type=CommentTypes.INFORMATIVE, params={}, comment=Comments.GENERAL_RECS))
+    # if not comments:
+    #     comments.append(Comment(type=CommentTypes.INFORMATIVE, params={}, comment=Comments.GENERAL_RECS))
 
     return Analysis.summarize_comments(comments, output_file)
diff --git a/lib/making-the-grade/analyzer.py b/lib/making-the-grade/analyzer.py
@@ -60,7 +60,7 @@ def analyze(in_path: Path, out_path: Path):
     comments.extend(generate_pylint_comments(in_path))
 
      # If there are no comments, add the general recommendations as comments.
-    if not comments:
-        comments.append(Comment(type=CommentTypes.INFORMATIVE, params={}, comment=Comments.GENERAL_RECS))
+    # if not comments:
+    #     comments.append(Comment(type=CommentTypes.INFORMATIVE, params={}, comment=Comments.GENERAL_RECS))
 
     return Analysis.summarize_comments(comments, output_file)
diff --git a/lib/meltdown-mitigation/analyzer.py b/lib/meltdown-mitigation/analyzer.py
@@ -60,7 +60,7 @@ def analyze(in_path: Path, out_path: Path):
     comments.extend(generate_pylint_comments(in_path))
 
      # If there are no comments, add the general recommendations as comments.
-    if not comments:
-        comments.append(Comment(type=CommentTypes.INFORMATIVE, params={}, comment=Comments.GENERAL_RECS))
+    # if not comments:
+    #     comments.append(Comment(type=CommentTypes.INFORMATIVE, params={}, comment=Comments.GENERAL_RECS))
 
     return Analysis.summarize_comments(comments, output_file)
diff --git a/lib/pretty-leaflet/analyzer.py b/lib/pretty-leaflet/analyzer.py
@@ -59,7 +59,7 @@ def analyze(in_path: Path, out_path: Path):
     comments.extend(generate_pylint_comments(in_path))
 
      # If there are no comments, add the general recommendations as comments.
-    if not comments:
-        comments.append(Comment(type=CommentTypes.INFORMATIVE, params={}, comment=Comments.GENERAL_RECS))
+    # if not comments:
+    #     comments.append(Comment(type=CommentTypes.INFORMATIVE, params={}, comment=Comments.GENERAL_RECS))
 
     return Analysis.summarize_comments(comments, output_file)
diff --git a/lib/processing-logs/analyzer.py b/lib/processing-logs/analyzer.py
@@ -59,7 +59,7 @@ def analyze(in_path: Path, out_path: Path):
     comments.extend(generate_pylint_comments(in_path))
 
      # If there are no comments, add the general recommendations as comments.
-    if not comments:
-        comments.append(Comment(type=CommentTypes.INFORMATIVE, params={}, comment=Comments.GENERAL_RECS))
+    # if not comments:
+    #     comments.append(Comment(type=CommentTypes.INFORMATIVE, params={}, comment=Comments.GENERAL_RECS))
 
     return Analysis.summarize_comments(comments, output_file)
diff --git a/lib/restaurant-rozalynn/analyzer.py b/lib/restaurant-rozalynn/analyzer.py
@@ -60,7 +60,7 @@ def analyze(in_path: Path, out_path: Path):
     comments.extend(generate_pylint_comments(in_path))
 
      # If there are no comments, add the general recommendations as comments.
-    if not comments:
-        comments.append(Comment(type=CommentTypes.INFORMATIVE, params={}, comment=Comments.GENERAL_RECS))
+    # if not comments:
+    #     comments.append(Comment(type=CommentTypes.INFORMATIVE, params={}, comment=Comments.GENERAL_RECS))
 
     return Analysis.summarize_comments(comments, output_file)
diff --git a/lib/tisbury-treasure-hunt/analyzer.py b/lib/tisbury-treasure-hunt/analyzer.py
@@ -60,7 +60,7 @@ def analyze(in_path: Path, out_path: Path):
     comments.extend(generate_pylint_comments(in_path))
 
      # If there are no comments, add the general recommendations as comments.
-    if not comments:
-        comments.append(Comment(type=CommentTypes.INFORMATIVE, params={}, comment=Comments.GENERAL_RECS))
+    # if not comments:
+    #     comments.append(Comment(type=CommentTypes.INFORMATIVE, params={}, comment=Comments.GENERAL_RECS))
 
     return Analysis.summarize_comments(comments, output_file)
diff --git a/test/anagram/analysis.json b/test/anagram/analysis.json
@@ -1,10 +1,4 @@
 {
     "summary": "Good work! \ud83c\udf1f Here are some general recommendations for improving your Python code.",
-    "comments": [
-        {
-            "comment": "python.general.general_recommendations",
-            "params": {},
-            "type": "informative"
-        }
-    ]
+    "comments": []
 }
diff --git a/test/currency-exchange/analysis.json b/test/currency-exchange/analysis.json
@@ -1,10 +1,4 @@
 {
     "summary": "Good work! \ud83c\udf1f Here are some general recommendations for improving your Python code.",
-    "comments": [
-        {
-            "comment": "python.general.general_recommendations",
-            "params": {},
-            "type": "informative"
-        }
-    ]
+    "comments": []
 }
diff --git a/test/dnd-character/analysis.json b/test/dnd-character/analysis.json
@@ -0,0 +1,70 @@
+{
+    "summary": "There are a few suggested changes that can bring your solution closer to ideal.",
+    "comments": [
+        {
+            "comment": "python.pylint.convention",
+            "params": {
+                "lineno": "1",
+                "code": "C0114 missing-module-docstring",
+                "message": "Missing module docstring",
+                "bad_code": "Instead of: \n```python\nimport sys  # [missing-module-docstring]\n\n\ndef print_python_version():\n    print(sys.version)\n```\n\n",
+                "good_code": "Try: \n```python\n\"\"\"Module providing a function printing python version.\"\"\"\n\nimport sys\n\n\ndef print_python_version():\n    print(sys.version)\n```\n\n",
+                "related_info": null,
+                "details": null
+            },
+            "type": "informative"
+        },
+        {
+            "comment": "python.pylint.convention",
+            "params": {
+                "lineno": "4",
+                "code": "C0115 missing-class-docstring",
+                "message": "Missing class docstring",
+                "bad_code": "Instead of: \n```python\nclass Person:  # [missing-class-docstring]\n    def __init__(self, first_name, last_name):\n        self.first_name = first_name\n        self.last_name = last_name\n```\n\n",
+                "good_code": "Try: \n```python\nclass Person:\n    \"\"\"Class representing a person\"\"\"\n\n    def __init__(self, first_name, last_name):\n        self.first_name = first_name\n        self.last_name = last_name\n```\n\n",
+                "related_info": null,
+                "details": null
+            },
+            "type": "actionable"
+        },
+        {
+            "comment": "python.pylint.refactor",
+            "params": {
+                "lineno": "16",
+                "code": "R1721 unnecessary-comprehension",
+                "message": "Unnecessary use of a comprehension, use list(vars(self).values()) instead.",
+                "bad_code": "Instead of: \n```python\nNUMBERS = [1, 1, 2, 2, 3, 3]\n\nUNIQUE_NUMBERS = {number for number in NUMBERS}  # [unnecessary-comprehension]\n```\n\n",
+                "good_code": "Try: \n```python\nNUMBERS = [1, 1, 2, 2, 3, 3]\n\nUNIQUE_NUMBERS = set(NUMBERS)\n```\n\n",
+                "related_info": null,
+                "details": null
+            },
+            "type": "actionable"
+        },
+        {
+            "comment": "python.pylint.refactor",
+            "params": {
+                "lineno": "19",
+                "code": "R6301 no-self-use",
+                "message": "Method could be a function",
+                "bad_code": "Instead of: \n```python\nclass Person:\n    def greeting(self):  # [no-self-use]\n        print(\"Greetings pythonista!\")\n```\n\n",
+                "good_code": "Try: \n```python\n# Function\ndef greeting():\n    print(\"Greetings pythonista!\")\n\n\n# Static Method\nclass Person:\n    @staticmethod\n    def greeting():\n        print(\"Greetings pythonista!\")\n\n# Use Self\nclass Person:\n    name: str = \"Amelia\"\n\n    def greeting(self):\n        print(f\"Greetings {self.name} the pythonista!\")\n```\n\n",
+                "related_info": null,
+                "details": "If a function is not using any class attribute it can be a\n`@staticmethod`, or a function outside the class.\n"
+            },
+            "type": "actionable"
+        },
+        {
+            "comment": "python.pylint.refactor",
+            "params": {
+                "lineno": "19",
+                "code": "R6301 no-self-use",
+                "message": "Method could be a function",
+                "bad_code": "Instead of: \n```python\nclass Person:\n    def greeting(self):  # [no-self-use]\n        print(\"Greetings pythonista!\")\n```\n\n",
+                "good_code": "Try: \n```python\n# Function\ndef greeting():\n    print(\"Greetings pythonista!\")\n\n\n# Static Method\nclass Person:\n    @staticmethod\n    def greeting():\n        print(\"Greetings pythonista!\")\n\n# Use Self\nclass Person:\n    name: str = \"Amelia\"\n\n    def greeting(self):\n        print(f\"Greetings {self.name} the pythonista!\")\n```\n\n",
+                "related_info": null,
+                "details": "If a function is not using any class attribute it can be a\n`@staticmethod`, or a function outside the class.\n"
+            },
+            "type": "actionable"
+        }
+    ]
+}
diff --git a/test/ellens-alien-game/analysis.json b/test/ellens-alien-game/analysis.json
@@ -1,10 +1,4 @@
 {
     "summary": "Good work! \ud83c\udf1f Here are some general recommendations for improving your Python code.",
-    "comments": [
-        {
-            "comment": "python.general.general_recommendations",
-            "params": {},
-            "type": "informative"
-        }
-    ]
+    "comments": []
 }
diff --git a/test/ghost-gobble-arcade-game/analysis.json b/test/ghost-gobble-arcade-game/analysis.json
@@ -1,10 +1,4 @@
 {
     "summary": "Good work! \ud83c\udf1f Here are some general recommendations for improving your Python code.",
-    "comments": [
-        {
-            "comment": "python.general.general_recommendations",
-            "params": {},
-            "type": "informative"
-        }
-    ]
+    "comments": []
 }
diff --git a/test/inventory-management/analysis.json b/test/inventory-management/analysis.json
@@ -1,10 +1,4 @@
 {
     "summary": "Good work! \ud83c\udf1f Here are some general recommendations for improving your Python code.",
-    "comments": [
-        {
-            "comment": "python.general.general_recommendations",
-            "params": {},
-            "type": "informative"
-        }
-    ]
+    "comments": []
 }
diff --git a/test/little-sisters-essay/analysis.json b/test/little-sisters-essay/analysis.json
@@ -1,10 +1,4 @@
 {
     "summary": "Good work! \ud83c\udf1f Here are some general recommendations for improving your Python code.",
-    "comments": [
-        {
-            "comment": "python.general.general_recommendations",
-            "params": {},
-            "type": "informative"
-        }
-    ]
+    "comments": []
 }
diff --git a/test/little-sisters-vocab/analysis.json b/test/little-sisters-vocab/analysis.json
@@ -1,10 +1,4 @@
 {
     "summary": "Good work! \ud83c\udf1f Here are some general recommendations for improving your Python code.",
-    "comments": [
-        {
-            "comment": "python.general.general_recommendations",
-            "params": {},
-            "type": "informative"
-        }
-    ]
+    "comments": []
 }
diff --git a/test/locomotive-engineer/analysis.json b/test/locomotive-engineer/analysis.json
@@ -1,10 +1,4 @@
 {
     "summary": "Good work! \ud83c\udf1f Here are some general recommendations for improving your Python code.",
-    "comments": [
-        {
-            "comment": "python.general.general_recommendations",
-            "params": {},
-            "type": "informative"
-        }
-    ]
+    "comments": []
 }
diff --git a/test/tisbury-treasure-hunt/analysis.json b/test/tisbury-treasure-hunt/analysis.json
@@ -1,10 +1,4 @@
 {
     "summary": "Good work! \ud83c\udf1f Here are some general recommendations for improving your Python code.",
-    "comments": [
-        {
-            "comment": "python.general.general_recommendations",
-            "params": {},
-            "type": "informative"
-        }
-    ]
+    "comments": []
 }
