Fix #7422: autodoc: fails with ValueError when using autodoc_mock_imports #7431
Conversation
|
Confirmed this avoids the failure encountered in the OpenStack cinder project. Thanks! |
| def unwrap(obj: Any) -> Any: | ||
| """Get an original object from wrapped object (wrapped functions).""" | ||
| try: | ||
| return inspect.unwrap(obj) |
There was a problem hiding this comment.
How about providing some callback to unwrap to check if wrapped object (if there is any) id is equal to the object itself. Like (based on https://github.com/python/cpython/blob/master/Lib/inspect.py#L509):
def checker(f):
return id(f) == id(f.__wrapped__)
inspect.unwrap(obj, stop = checker)
I guess that you may get ValueError for an object that is not mock and miss the real error.
There was a problem hiding this comment.
@JanuszL ValueError is being thrown from https://github.com/python/cpython/blob/master/Lib/inspect.py#L524 and it's catching exactly the error you're looking for this to catch.
see: https://github.com/python/cpython/blob/master/Lib/inspect.py#L506
There was a problem hiding this comment.
Yes, ValueError means "a cycle is encountered". It's a real error in this case. I think it is an abnormal case. So let's talk if we encountered.
There was a problem hiding this comment.
Sure. I was only thinking about the situation where the cycle is encountered and this is not due to mocking. In such a case it should really throw, so maybe there is an easier way to check if this is a moc or some valid object.
| return inspect.unwrap(obj) | ||
| except ValueError: | ||
| # might be a mock object | ||
| return obj |
There was a problem hiding this comment.
@tk0miya this looks good, but maybe log DEBUG/INFO?
| return obj | |
| logger.debug('Giving up trying to unwrap %r', obj) | |
| return obj |
There was a problem hiding this comment.
I doubt the log will be helpful. Do you want to see it?
There was a problem hiding this comment.
I'm fine not seeing it, I was just thinking it could be useful if you were already debugging.
|
Thanks, this also fixes the build in urllib3. |
|
Thank you. This fixed the issue for my project (gwcelery). |
|
Merged. Thank you for reviewing & confirming. |
|
@tk0miya Thank you for resolving this issue. Do you have an ETA on when a version of Sphinx including this fix will be released? I have a number of projects blocked on it. |
|
@tk0miya Thanks so much! Will do. |
Feature or Bugfix
Purpose