checkmk icon indicating copy to clipboard operation
checkmk copied to clipboard

Fixed Improper Method Call: Replaced `NotImplementedError`

Open nydelzaf opened this issue 2 years ago • 5 comments

General information

This PR is for a normal bug fix.

Details

While triaging your project, our bug fixing tool generated the following message(s)-

In file: forward.py, class: StructuredDataName, there is a special method __eq__ that raises a NotImplementedError. If a special method supporting a binary operation is not implemented it should return NotImplemented. On the other hand, NotImplementedError should be raised from abstract methods inside user defined base classes to indicate that derived classes should override those methods. iCR suggested that the special method __eq__ should return NotImplemented instead of raising an exception. An example of how NotImplemented helps the interpreter support a binary operation is here.

In file: forward.py, class: StructuredDataID, there is a special method __eq__ that raises a NotImplementedError. If a special method supporting a binary operation is not implemented it should return NotImplemented. On the other hand, NotImplementedError should be raised from abstract methods inside user defined base classes to indicate that derived classes should override those methods. iCR suggested that the special method __eq__ should return NotImplemented instead of raising an exception. An example of how NotImplemented helps the interpreter support a binary operation is here.

Changes

Replaced occurance of NotImplementedError with NotImplemented

CLA Requirements

This section is only relevant if your project requires contributors to sign a Contributor License Agreement (CLA) for external contributions.

All contributed commits are already automatically signed off.

The meaning of a signoff depends on the project, but it typically certifies that committer has the rights to submit this work under the same license and agrees to a Developer Certificate of Origin (see https://developercertificate.org/ for more information). - Git Commit SignOff documentation

Sponsorship and Support

This work is done by the security researchers from OpenRefactory and is supported by the Open Source Security Foundation (OpenSSF): Project Alpha-Omega. Alpha-Omega is a project partnering with open source software project maintainers to systematically find new, as-yet-undiscovered vulnerabilities in open source code - and get them fixed – to improve global software supply chain security.

The bug is found by running the Intelligent Code Repair (iCR) tool by OpenRefactory and then manually triaging the results.

nydelzaf avatar Dec 06 '23 08:12 nydelzaf

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

github-actions[bot] avatar Dec 06 '23 08:12 github-actions[bot]

I have read the CLA Document and I hereby sign the CLA or my organization already has a signed CLA.

nydelzaf avatar Dec 06 '23 08:12 nydelzaf

recheck

nydelzaf avatar Dec 06 '23 08:12 nydelzaf

Thank you for your contribution! This PR needs some improvement before we can merge it: Could you please rebase, since the file forward.py does not exist anymore and the relevant functionality was moved to syslog.py at the same location.

kbaikov avatar Mar 07 '24 08:03 kbaikov

Thank you for your contribution! This PR needs some improvement before we can merge it: Could you please rebase, since the file forward.py does not exist anymore and the relevant functionality was moved to syslog.py at the same location.

Sure. I'll do it as soon as I can.

nydelzaf avatar Mar 13 '24 06:03 nydelzaf

Change has been successfully rebased and submitted as fc3688be110245fffadffb2f66c2100c29045a3a with author metadata. Thank you for your contribution. This inspired several follow-up commits.

kbaikov avatar Jun 10 '24 06:06 kbaikov