Bump Prospector 1.18.0 (#334)

* Bump prospector 1.18.0

* refactor configuration during tool run

Author: DMarinhoCodacy

.gitignore

@@ -11,3 +11,7 @@ target
 __pycache__
 .mypy_cache
 default.profraw
+
+
+#Ignore vscode AI rules
+.github/instructions/codacy.instructions.md

Dockerfile

@@ -1,4 +1,4 @@
-FROM python:3.11-alpine3.22
+FROM python:3.14-alpine3.23
 COPY requirements.txt requirements.txt
 RUN pip3 install --no-cache-dir -r requirements.txt
 COPY src/codacy_prospector.py codacy_prospector.py

docs/multiple-tests/capitalized/results.xml

@@ -3,5 +3,11 @@
     <file name="example.py">
         <error source="vulture" line="1" message="Unused function 'non_capitalized' (unused-function)" severity="info" />
         <error source="vulture" line="6" message="Unused function 'capitalized' (unused-function)" severity="info" />
+        <error source="pydocstyle" line="2" message="First word of the first line should be properly capitalized ('Compute', not 'compute') (D403)" severity="info" />
+        <error source="pydocstyle" line="2" message="Multi-line docstring summary should start at the first line (D212)" severity="info" />
+        <error source="pydocstyle" line="7" message="Multi-line docstring summary should start at the first line (D212)" severity="info" />
+        <error source="pydocstyle" line="2" message="One-line docstring should fit on one line with quotes (found 3) (D200)" severity="info" />
+        <error source="pydocstyle" line="7" message="One-line docstring should fit on one line with quotes (found 3) (D200)" severity="info" />
+
     </file>
 </checkstyle>

docs/multiple-tests/no-crash/results.xml

@@ -2,7 +2,7 @@
 <checkstyle version="1.5">
     <file name="example.py">
         <error source="pycodestyle" line="1" message="block comment should start with '# ' (E265)" severity="info" />
-        <error source="pylint" line="2" message="Comparison between constants: '1 == 2' has a constant value (comparison-of-constants)" severity="info" />
+        <error source="pylint" line="2" message="Undefined variable 'a' (undefined-variable)" severity="info" />
         <error source="pycodestyle" line="3" message="block comment should start with '# ' (E265)" severity="info" />
     </file>
 </checkstyle>

docs/multiple-tests/no-crash/src/example.py

@@ -1,4 +1,4 @@
 ##Patterns: W0311
-if 1 == 2:
+if a == b:
     ##Info: W0311
     pass

docs/multiple-tests/with-config-file/results.xml

@@ -1,10 +1,11 @@
 <?xml version="1.0" encoding="utf-8" ?>
 <checkstyle version="1.5">
     <file name="example.py">
-        <error source="pydocstyle" line="1" message="Multi-line docstring summary should start at the first line (D212)" severity="info" />
-        <error source="pylint" line="99" message="No value for argument 'on_delete' in constructor call (no-value-for-parameter)" severity="info" />
-        <error source="pylint" line="100" message="No value for argument 'on_delete' in constructor call (no-value-for-parameter)" severity="info" />
-        <error source="pylint" line="114" message="No value for argument 'on_delete' in constructor call (no-value-for-parameter)" severity="info" />
-        <error source="pylint" line="125" message="No value for argument 'on_delete' in constructor call (no-value-for-parameter)" severity="info" />
+        <error source="pylint" line="1" message="Unused import os (unused-import)" severity="info" />
+        <error source="pylint" line="4" message="Line too long (127/120) (line-too-long)" severity="info" />
+        <error source="pycodestyle" line="6" message="expected 2 blank lines, found 1 (E302)" severity="info" />
+        <error source="pylint" line="14" message="Trailing whitespace (trailing-whitespace)" severity="info" />
+        <error source="pylint" line="16" message="Trailing whitespace (trailing-whitespace)" severity="info" />
+        <error source="pylint" line="17" message="Final newline missing (missing-final-newline)" severity="info" />
     </file>
 </checkstyle>

docs/multiple-tests/with-config-file/src/example.py

@@ -1,136 +1,17 @@
-"""
-Checks that Pylint does not complain about various
-methods on Django model fields.
-"""
-#  pylint: disable=C0111
-from __future__ import print_function
-from datetime import datetime, date
-from decimal import Decimal
-from django.db import models
-from django.db.models import ForeignKey, OneToOneField
-
-
-class LotsOfFieldsModel(models.Model):
-
-    bigintegerfield = models.BigIntegerField()
-    booleanfield = models.BooleanField(default=True)
-    charfield = models.CharField(max_length=40, null=True)
-    commaseparatedintegerfield = models.CommaSeparatedIntegerField()
-    datetimefield = models.DateTimeField(auto_now_add=True)
-    datefield = models.DateField(auto_now_add=True)
-    decimalfield = models.DecimalField(max_digits=5, decimal_places=2)
-    emailfield = models.EmailField()
-    filefield = models.FileField(name='test_file', upload_to='test')
-    filepathfield = models.FilePathField()
-    floatfield = models.FloatField()
-    genericipaddressfield = models.GenericIPAddressField()
-    imagefield = models.ImageField(name='test_image', upload_to='test')
-    ipaddressfield = models.IPAddressField()
-    intfield = models.IntegerField(null=True)
-    nullbooleanfield = models.NullBooleanField()
-    positiveintegerfield = models.PositiveIntegerField()
-    positivesmallintegerfield = models.PositiveSmallIntegerField()
-    slugfield = models.SlugField()
-    smallintegerfield = models.SmallIntegerField()
-    textfield = models.TextField()
-    timefield = models.TimeField()
-    urlfield = models.URLField()
-
-    def boolean_field_tests(self):
-        print(self.booleanfield | True)
-        print(self.nullbooleanfield | True)
-
-    def string_field_tests(self):
-        print(self.charfield.strip())
-        print(self.charfield.upper())
-        print(self.charfield.replace('x', 'y'))
-
-        print(self.filepathfield.strip())
-        print(self.filepathfield.upper())
-        print(self.filepathfield.replace('x', 'y'))
-
-        print(self.emailfield.strip())
-        print(self.emailfield.upper())
-        print(self.emailfield.replace('x', 'y'))
-
-        print(self.textfield.strip())
-        print(self.textfield.upper())
-        print(self.textfield.replace('x', 'y'))
-
-    def datetimefield_tests(self):
-        now = datetime.now()
-        print(now - self.datetimefield)
-        print(self.datetimefield.ctime())
-
-    def datefield_tests(self):
-        now = date.today()
-        print(now - self.datefield)
-        print(self.datefield.isoformat())
-
-    def decimalfield_tests(self):
-        print(self.decimalfield.compare(Decimal('1.4')))
-
-    def filefield_tests(self):
-        print(self.filefield.file)
-        print(self.imagefield.file)
-
-    def numberfield_tests(self):
-        print(self.intfield + 5)
-        print(self.bigintegerfield + 4)
-        print(self.smallintegerfield + 3)
-        print(self.positiveintegerfield + 2)
-        print(self.positivesmallintegerfield + 1)
-
-
-class SomeModel(models.Model):
-    pass
-
-
-class Author(models.Model):
-    author_name = models.CharField(max_length=100)
-
-
-class ISBN(models.Model):
-    value = models.CharField(max_length=100)
-
-
-class Book(models.Model):
-    book_name = models.CharField(max_length=100)
-    author = models.ForeignKey(Author)
-    isbn = models.OneToOneField(ISBN)
-
-    def get_isbn(self):
-        return self.isbn.value
-
-    def get_author_name(self):
-        return self.author.author_name
-
-
-class Fruit(models.Model):
-    fruit_name = models.CharField(max_length=20)
-
-
-class Seed(models.Model):
-    fruit = ForeignKey(Fruit)
-
-    def get_fruit_name(self):
-        return self.fruit.fruit_name
-
-
-class User(models.Model):
-    username = models.CharField(max_length=32)
-
-
-class UserProfile(models.Model):
-    user = OneToOneField(User)
-
-    def get_username(self):
-        return self.user.username
-
-
-if __name__ == '__main__':
-    MODEL = SomeModel()
-    MODEL.save()
-    MODEL.delete()
-
-    COUNT = SomeModel.objects.count()
+import os
+
+# 1. RULE: Line length (this line is intentionally way too long for standard 79/88 char limits)
+# This is a very long comment that will definitely trigger a warning if we set the max-line-length rule strictly in our config.
+
+def complex_function(a):
+    # 2. RULE: McCabe Complexity (nested loops/ifs increase the 'score')
+    if a > 0:
+        for i in range(a):
+            if i % 2 == 0:
+                for j in range(i):
+                    if j == 5:
+                        print("Complexity!")
+    
+    # 3. RULE: Pylint Naming (v is a poor variable name)
+    v = 10 
+    return v

requirements.txt

@@ -1,6 +1,6 @@
-mypy==1.17.0
-prospector[with_everything]==1.17.2
-jsonpickle==4.0.2
-Django==5.2.6
-pylint==3.3.7
-Flask==3.1.1
+prospector[with_everything]==1.18.0
+jsonpickle==4.1.1
+Django==6.0.4
+pylint==4.0.5
+Flask==3.1.3
+mypy==1.20.0

src/codacy_prospector.py

@@ -8,7 +8,6 @@
 import signal
 from contextlib import contextmanager
 import traceback
-import django
 import re
 
 @contextmanager
@@ -89,20 +88,19 @@ def generate():
             yield res
     return list(generate())
 
-default_tools = {'pylint', 'pyflakes', 'mccabe', 'dodgy', 'pydocstyle', 'profile-validator','pycodestyle'}
-extra_tools = {'vulture', 'pyroma', 'mypy','bandit','pyright'}
+all_tools = {'pylint', 'pyflakes', 'mccabe', 'dodgy', 'pydocstyle', 'profile-validator','pycodestyle','vulture', 'pyroma', 'mypy','bandit','pyright'}
 
 def readConfiguration(configFile, srcDir):
     def allFiles(): return walkDirectory(srcDir)
     try:
         configuration = readJsonFile(configFile)
         files = configuration.get('files') or allFiles()
         tools = [t for t in configuration['tools'] if t['name'] == 'prospector']
-        if tools and 'patterns' in tools[0]:
+        if tools and tools[0].get('patterns'): 
             prospector = tools[0]
             tools = set([p['patternId'] for p in prospector.get('patterns') or []])
-            tools_to_disable = default_tools.difference(tools)
-            tools_to_enable = extra_tools.intersection(tools)
+            tools_to_disable = all_tools.difference(tools)
+            tools_to_enable = all_tools.intersection(tools)
             options = [f"--without-tool={t}" for t in tools_to_disable] + [f"--with-tool={t}" for t in tools_to_enable] 
         else:
             options = []

src/codacy_prospector_test.py

@@ -72,6 +72,11 @@ def test_readConfiguration(self):
                                '--without-tool=mccabe',
                                '--without-tool=pyflakes',
                                '--without-tool=profile-validator',
+                               '--without-tool=vulture',
+                               '--without-tool=mypy',
+                               '--without-tool=bandit',
+                               '--without-tool=pyright',
+                               '--without-tool=profile-validator',
                                '--with-tool=pyroma'}
             expectedFiles = ['C0111.py']