particle-os/debian-koji
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

document convertFault method

Browse source 
Update the convertFault docstring to describe how the method converts
faults, the "fault" parameter type, and possible return values.
This commit is contained in:
Ken Dreyer 2021-10-12 14:27:36 -04:00
parent 52ae5616dc
commit 0747714f6e
1 changed files with 11 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

13
koji/__init__.py
View file

@ -437,9 +437,18 @@ class MultiCallInProgress(object):
pass
# A function to get create an exception from a fault
def convertFault(fault):
"""Convert a fault to the corresponding Exception type, if possible"""
"""Convert a fault to the corresponding Exception type, if possible.
This method compares this fault's faultCode to all the known faultCodes
in the GenericError and sub-classes defined above. If there is a matching
faultCode, return that new Exception class. If there is no match, just
return the fault object as-is.
:param xmlrpc.client.Fault fault: The XML-RPC fault from the hub.
:returns: one of the GenericError sub-classes, if possible.
:returns: fault instance, if no GenericError sub-classes matched.
"""
code = getattr(fault, 'faultCode', None)
if code is None:
return fault