python:S1542 rule partially working

[TristanL (Tristan Larguier)]

Hello,

In a python project I have an async class method called “Modération”. If I understood well the python PEP8 rule, this should be report as a consistancy issue. However this one is not reported. After investigation the file is correctly scanned by sonar, and other issues are discovered, but this one not.
Is it a known bug or work as expected ?

[Colin]

Hey there!

I’ve moved your post to the section on reporting false-positives.

How to Report a False-positive / False-negative

Hey SonarSource Community! False-positives happen, as do false-negatives, and we’re eager to fix them. We are thrilled when our users report problems, so we can make our products better. What is a false-positive (FP)? A false-positive is when an issue is raised unexpectedly on code that should not trigger an issue, or where the suggested action doesn’t make any sense for the code. What is a false-negative (FN)? A false-negative is when an issue should be raised on a piece of code, but isn’t. …

Can you please include which product(s) you’re using (and if relevant, what versions?). A super simple reproducer would also be great.

[TristanL (Tristan Larguier)]

this is on sonar scanner, Community Edition v10.5.1 (90531).

To reproduce, here is a piece of the code

@message_command(default_member_permissions=256)
async def Modérer(self, interaction: Interaction, message):
    view = nextcord.ui.View()
    view.add_item(SelectSanction(message))
    with open("moderate.txt", "a") as file:
        file.write("===\n" + message.content.replace("=", "\=") + "\n===\n")
    await interaction.response.send_message("Quelle sanction appliquer à ce message ?", ephemeral=True, view=view)

In this case, the function name “Modérer” is not detected as problematic.
I dig a little bit and found that in this case, sonar may not detect this because it is a decorator-defined command, not a standard Python function.
I don’t know if it is a bug or a feature.

[sebastian.zumbrunn]

Hi @TristanL,
Thanks for reaching out, and thanks for reporting this false negative.

I was able to reproduce this issue with the following code snippet. I’m assuming that your the class of Modération inherits from another class.

from nextcord.ext import commands

class ModerationCog(commands.Cog):
    async def Modérer(self, interaction, message):
        pass

S100, the rule, which should raise in this case, does not when its class inherits from another class. The logic being that there is a good chance your overriding a method and therefore you cannot change the name. However, in cases like these this logic is a bit too aggressively suppressing issues leading to this false negative.

I’ve added this community thread to the internal ticket which is tracking this issue.

Thank you again for this report.

Best,
Sebastian