Fixing an improper method call

[fazledyn-or]

In file: coords.py, class: CellMethod, there is a special method add 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 add should return NotImplemented instead of raising an exception.

An example of how NotImplemented helps the interpreter support a binary operation is here.

So, the changes to the code would be something like-

def __add__(self, other):
  # Disable the default tuple behaviour of tuple concatenation
- raiseNotImplementedError()
+ returnNotImplemented

I see the comment written above the exception, but still wondering if it was meant for using NotImplementedError instead of NotImplemented or not. If it's the later, then I suggest that we follow Python's guideline and use return NotImplemented

If it's alright, I can create a PR that you can merge.

Looking forward to hearing from you.

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.

[trexfeathers]

Hi @fazledyn-or

First of all: thanks so much for checking our code base. What a great idea for making the world a better place™ ❤

We discussed as a team this week and we think NotImplemented is the right way to go. It's hard to be certain since this line has been in the code forever, but I ran the tests with NotImplemented and everything passed.

If you'd like the credit of raising a pull request, please go ahead. If you're busy, we'll get to it in the near future.

[fazledyn-or]

Great! Let me submit a PR then.

[fazledyn-or]

Please have a look at it. PR #5544