fix(lock): Fix LockError message when releasing a lock.

[shenxiangzhuang]

Fix #3535

Pull Request check-list

Please make sure to review and check all of these items:

• Do tests and lints pass with this change?
• Do the CI tests pass with this change (enable it first in your forked repo and wait for the github action build to finish)?
• Is the new or changed code fully tested?
• Is a documentation update included (if this change modifies existing APIs, or introduces new ones)?
• Is there an example added to the examples folder (if applicable)?
• Was the change added to CHANGES file?

NOTE: these things are not required to open a PR and can be done
afterwards / while the PR is open.

Description of change

We can get expect result for the test code in #3535 with this implementation:

Thread 2: Lock error: Cannot release a lock that's no longer owned

[petyaslavova]

Hi @shenxiangzhuang, thank you for your contribution! Your change will be reviewed soon.

[petyaslavova]

In the original code, we have the following:

def release(self) -> None:
        """
        Releases the already acquired lock
        """
        expected_token = self.local.token
        if expected_token is None:
            raise LockError("Cannot release an unlocked lock", lock_name=self.name)
        self.local.token = None
        self.do_release(expected_token)

This code can raise the LockError in several cases(Refering in some of the cases to the example in the reported issue):

1. When the token object is not initialized or is already reset to None - it can happen if in thread 1 we have already called release and we call it again - in this case, the error handling is fine - the lock has really been already unlocked.
2. We are in another thread that hasn't acquired a lock - which sounds like the message and meaning of LockNotOwnedError
3. We might get in a similar to the first situation using the locks with context manager and trying to call the release function additionally.

If we are in Thread1 and we call release after the lock has expired, we get to self.do_release(expected_token) which raises the LockNotOwnedError with message "Cannot release a lock that's no longer owned" - which sound correct.

Overall I think that we can just change the Exception to LockNotOwnedError(won't be breaking change, because it is a subtype of the LockError) with a proper error message, something like "Cannot release a lock that's not owned or is already unlocked."

[shenxiangzhuang]

Overall I think that we can just change the Exception to LockNotOwnedError(won't be breaking change, because it is a subtype of the LockError) with a proper error message, something like "Cannot release a lock that's not owned or is already unlocked."

I think it does a more proper way to ease the problem in #3535 and I have changed the code, please review it again!

[vladvildanov]

@shenxiangzhuang Code linters still failing, apart of it it's okay

[petyaslavova]

@shenxiangzhuang, thank you very much for your efforts. Can you please apply the change to the async lock as well? The code there is identical.

[shenxiangzhuang]

@petyaslavova , ok, I have changed the async implementation. Please review it again. cc @vladvildanov

[petyaslavova]

LGTM.