added type hinting, document string, TODO statements, fixed small typ… #14
Conversation
|
@rdiankov @ziyan @liuhuanjim013 @kanunikov-denys if no longer needed please close :) |
|
Currently we need to maintain Python2 as well. This pull request can be considered at least 1 year later. |
|
@cielavenir alright, is there anything else more pressing currently you need help on ? |
|
@felixvd @hemangandhi could you check? |
|
@cielavenir Do you have a pipeline ID? |
| def __init__(self, message=''): | ||
| if message is not None and not isinstance(message, six.text_type): | ||
| def __init__(self, message: Optional[str]='') -> None: | ||
| if message is not None and not isinstance(message, six.text_type): |
| @@ -125,7 +127,7 @@ class AuthenticationError(ClientExceptionBase): | |||
|
|
|||
|
|
|||
| class WebstackClientError(ClientExceptionBase): | |||
|
|
|||
| """Exeption class for errors returned by the web stack client""" | |||
There was a problem hiding this comment.
This wording makes me a bit uncomfortable since there's a few error types that a request could raise:
python/mujinwebstackclient/controllerwebclientraw.py
115: raise WebstackClientError(_('Timeout value (%s sec) is too small') % timeout)
180: raise APIServerError(_('Unable to parse server response %d: %s') % (response.status_code, raw))
184: raise APIServerError(content['error_message'], errorcode=content.get('error_code', None), inputcommand=path, detailInfoType=content.get('detailInfoType',None), detailInfo=content.get('detailInfo',None))
187: raise APIServerError(content['error'].get('message', raw), inputcommand=path)
190: raise APIServerError(_('Unexpected server response %d: %s') % (response.status_code, raw))
206: raise APIServerError(_('Unexpected server response %d: %s') % (response.status_code, raw))
229: raise ControllerGraphClientException(_('Unexpected server response %d: %s') % (statusCode, raw), statusCode=statusCode, response=response)
239: # raise any error returned
245: raise ControllerGraphClientException(message, statusCode=statusCode, content=content, response=response, errorCode=errorCode)
248: raise ControllerGraphClientException(_('Unexpected server response %d: %s') % (statusCode, raw), statusCode=statusCode, response=response)
Perhaps this is better:
Exception class raised upon unsuccessful HTTP REST API requests.
I hope this might disambiguate the GraphQL errors.
|
@ziyan https://tiny.mujin.co.jp/qarwm However, since this typing will drop py2 explicitly, @felixvd must approve explicitly. |
|
ok to merge after minor syntax is corrected (this is year-old mr so @hemangandhi do you want to take a look at this? i pushed the same name branch to mujin) |
add type hinting, document strings and typo in readme
Resolves#13Please test on linux machine before merging!!