update type hint for Client
Change-Id: I6ea692497141fe9c2199ab07ba653cc7b0d55087
This commit is contained in:
parent
cdeab76bbb
commit
35f701fbd4
@ -13,7 +13,7 @@
|
|||||||
# limitations under the License.
|
# limitations under the License.
|
||||||
|
|
||||||
from freezerclient import utils
|
from freezerclient import utils
|
||||||
from typing import Any
|
# from typing import Any
|
||||||
|
|
||||||
import os
|
import os
|
||||||
|
|
||||||
@ -24,7 +24,7 @@ def Client(version: str = None, endpoint: str = None, username: str = None,
|
|||||||
project_id: str = None, token: str = None, cacert: str = None,
|
project_id: str = None, token: str = None, cacert: str = None,
|
||||||
project_domain_name: str = None, user_domain_id: str = None,
|
project_domain_name: str = None, user_domain_id: str = None,
|
||||||
user_domain_name: str = None, project_domain_id: str = None,
|
user_domain_name: str = None, project_domain_id: str = None,
|
||||||
**kwargs) -> Any:
|
**kwargs) -> str:
|
||||||
"""Initialize client object based on given version.
|
"""Initialize client object based on given version.
|
||||||
|
|
||||||
HOW-TO:
|
HOW-TO:
|
||||||
@ -34,11 +34,7 @@ def Client(version: str = None, endpoint: str = None, username: str = None,
|
|||||||
>>> from freezerclient import client
|
>>> from freezerclient import client
|
||||||
>>> freezer = client.Client('2',username='admin',password='stack')
|
>>> freezer = client.Client('2',username='admin',password='stack')
|
||||||
|
|
||||||
Here ``VERSION`` is freezer API Version, you can use ``1``(v1) or ``2``
|
Here ``VERSION`` is freezer API VersrPython API" page at
|
||||||
(v2),default is API v2.
|
|
||||||
|
|
||||||
Alternatively, you can create a client instance using the keystoneauth
|
|
||||||
session API. See "The freezerclient Python API" page at
|
|
||||||
python-freezerclient's doc.
|
python-freezerclient's doc.
|
||||||
"""
|
"""
|
||||||
if endpoint:
|
if endpoint:
|
||||||
|
Loading…
Reference in New Issue
Block a user