message doesn't set properly on ClientException

[Everett Toews]

To reproduce

    >>> from keystoneauth1 import exceptions
    >>> e = exceptions.ClientException(message="test")
    >>> print(e.message)
    None

Also, it seems that if you want to follow the proper idiom for calling a super class init method then this line [1] should be

    super(ClientException, self).__init__(message)

[1] http://git.openstack.org/cgit/openstack/keystoneauth/tree/keystoneauth1/exceptions/base.py#n27

[Morgan Fainberg (mdrnstm)]

Yep, looks like the issue is the superclass .__init__ call.

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/285757

[Dolph Mathews (dolph)]

What's wrong with this?

  >>> from keystoneauth1 import exceptions
  >>> e = exceptions.ClientException(message="test")
  >>> print(e)
  test

[Everett Toews (everett-toews)]

At the very least it violates the principle of least surprise.

If I do

    e = exceptions.ClientException(message="test")

I fully expect that

    e.message

will have the message that was set.

Also the repr can and should be able to change. Clients should never depend on the output of repr.

e.message provides some structure that clients can depend on.

[Tin Lam (lamt)]

Per Brant Knudson's comment, we can rename the message field to _message to allow for this in Python 2.x. However the message attribute was removed in Python 3.x - I presume the code should mirror that behavior instead of reintroducing that attribute for Python 3.x.

[David Stanek (dstanek)]

The new version of the code adds the attribute back for Python 3. After thinking about this a bit I'd rather see either:

1. Rename 'message' to something else like 'default' (since that's what it is anyway). This means that in Python 2 the `e.message` will be what gets computed and passed into the parent's __init__ and in Python 3 there will be no `e.message`. The lack of a `message` attribute in Python 3 isn't a problem for me since it's a well known, well documented compatibility issue.

2. Do something cooler, which I suspect rules it out, but we could pull the message from the `__doc__` and define exceptions like:

    class E(ClientException):
        """An error while doing something"""

[Lance Bragstad (lbragstad)]

Automatically unassigning due to inactivity.

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/285757
Committed: https://git.openstack.org/cgit/openstack/keystoneauth/commit/?id=062dcc9cb29556b82ca7182458fac3038dd64c62
Submitter: Jenkins
Branch: master

commit 062dcc9cb29556b82ca7182458fac3038dd64c62
Author: Tin Lam <email address hidden>
Date: Sat Feb 27 21:36:00 2016 -0600

    Fix ClientException message property not set properly

    To reproduce:

        >>> from keystoneauth1 import exceptions
        >>> e = exceptions.ClientException(message="test")
        >>> print(e.message)
        None

    Change-Id: If73df85768866fb93d90ff95479f29f64aabe73f
    Co-Authored-By: Gage Hugo <email address hidden>
    Closes-Bug: #1534363

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/keystoneauth 2.19.0 release.