Documentation anomaly in TransportURL parse classmethod

The documentation for the classmethod `parse` states that

    The last parsed username and password will be propagated to the rest
    of hosts specified::
    user:pass@host1:port1,host2:port2
    [
    {"username": "user", "password": "pass", "host": "host1:port1"},
    {"username": "user", "password": "pass", "host": "host2:port2"}
    ]

However, in practice one needs to specify the usernames and passwords
individually with every host.

DocImpact: Documentation needs to be changed due anomaly in TransportURL
parse classmethod.

Change-Id: I1a9e07e0380a0d6f7d00731df93c9ba01ae20e0e
Closes-Bug: #1355684
This commit is contained in:
Oleksii Zamiatin 2014-10-29 18:14:00 +02:00
parent 6dc19e0b93
commit f74014a7db
1 changed files with 3 additions and 14 deletions

View File

@ -340,25 +340,14 @@ class TransportURL(object):
Netloc is parsed following the sequence bellow: Netloc is parsed following the sequence bellow:
* It is first split by ',' in order to support multiple hosts * It is first split by ',' in order to support multiple hosts
* The last parsed username and password will be propagated to the rest * Username and password should be specified for each host, in
of hosts specified:: case of lack of specification they will be omitted::
user:pass@host1:port1,host2:port2 user:pass@host1:port1,host2:port2
[ [
{"username": "user", "password": "pass", "host": "host1:port1"}, {"username": "user", "password": "pass", "host": "host1:port1"},
{"username": "user", "password": "pass", "host": "host2:port2"} {"host": "host2:port2"}
]
* In order to avoid the above propagation, it is possible to alter the
order in which the hosts are specified or specify a set of fake
credentials using ",:@host2:port2"::
user:pass@host1:port1,:@host2:port2
[
{"username": "user", "password": "pass", "host": "host1:port1"},
{"username": "", "password": "", "host": "host2:port2"}
] ]
:param conf: a ConfigOpts instance :param conf: a ConfigOpts instance