Inappropriate function docstrings

Bug #1255992 reported by Shree Duth Awasthi
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
python-keystoneclient
Fix Released
Low
Jamie Lennox

Bug Description

There are inappropriate docstrings for the below functions.

1. keystoneclient/service_catalog.py

        def get_urls(self, attr=None, filter_value=None,
                 service_type='identity', endpoint_type='publicURL'):
        """Fetch endpoint urls from the service catalog.

        Fetch the endpoints from the service catalog for a particular
        endpoint attribute. If no attribute is given, return the first
        endpoint of the specified type.

        :param string attr: Endpoint attribute name.
        :param string filter_value: Endpoint attribute value.
        :param string service_type: Service type of the endpoint.
        :param string endpoint_type: Type of endpoint.
                                     Possible values: public or publicURL,
                                         internal or internalURL,
                                         admin or adminURL
        :param string region_name: Region of the endpoint. --> NOT NEEDED

        :returns: tuple of urls or None (if no match found)
        """

2. keystoneclient//openstack/common/strutils.py

    def safe_encode(text, incoming=None,
                encoding='utf-8', errors='strict'):
    """Encodes incoming str/unicode using `encoding`.

    If incoming is not specified, text is expected to be encoded with
    current python's default encoding. (`sys.getdefaultencoding`)

    :param incoming: Text's current encoding
    :param encoding: Expected encoding for text (Default UTF-8)
    :param errors: Errors handling policy. See here for valid
        values http://docs.python.org/2/library/codecs.html
    :returns: text or a bytestring `encoding` encoded -- MISSING INFO FOR PARAMETER "text"
                representation of it.
    :raises TypeError: If text is not an isntance of str
    """
3. Similarly for func "def safe_decode"

Changed in python-keystoneclient:
assignee: nobody → Shree Duth Awasthi (shreeduth-awasthi)
Dolph Mathews (dolph)
Changed in python-keystoneclient:
importance: Undecided → Low
Revision history for this message
Shree Duth Awasthi (shreeduth-awasthi) wrote :

Making the bug as committed as it will be fixed with " https://review.openstack.org/#/c/49106/

Details at https://review.openstack.org/#/c/59721/

Thanks.

Changed in python-keystoneclient:
status: New → Fix Committed
Dolph Mathews (dolph)
Changed in python-keystoneclient:
status: Fix Committed → In Progress
assignee: Shree Duth Awasthi (shreeduth-awasthi) → Jamie Lennox (jamielennox)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to python-keystoneclient (master)

Reviewed: https://review.openstack.org/49106
Committed: http://github.com/openstack/python-keystoneclient/commit/d4c06d3035fa2910bc421d2196f2c0bf76f77cdb
Submitter: Jenkins
Branch: master

commit d4c06d3035fa2910bc421d2196f2c0bf76f77cdb
Author: Jamie Lennox <email address hidden>
Date: Tue Oct 22 09:41:00 2013 +1000

    Properly handle Regions in keystoneclient

    Region name is taken as a parameter but is ignored in all communication
    with the service catalog. Currently region can be stored in the token
    data and then requests to url functions will return the appropriate
    region. This is the wrong approach because there is nothing specific to
    the token (or auth_data) that is region specific. Instead region
    information should be held by the client.

    Closes-Bug: 1147530
    Closes-Bug: 1255992
    Change-Id: I812aa89c8b4af28e294e63926a7f88e8246fffc5

Changed in python-keystoneclient:
status: In Progress → Fix Committed
Dolph Mathews (dolph)
Changed in python-keystoneclient:
milestone: none → 0.4.2
Dolph Mathews (dolph)
Changed in python-keystoneclient:
status: Fix Committed → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.