openstack/python-dracclient
Code Issues Proposed changes

Fix docstrings for params

Browse Source 
Change-Id: I95784e65fcaacb7d74a1a6dab0d8549c2a6cf13a
This commit is contained in:
Imre Farkas
2015-12-08 14:40:50 +01:00
parent 617d5d7e1b
commit d52d16c6e6
4 changed files with 45 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
dracclient/client.py
View File

@@ -139,9 +139,9 @@ class DRACClient(object):
attributes passed in. For the values to be applied, a config job must attributes passed in. For the values to be applied, a config job must
be created and the node must be rebooted. be created and the node must be rebooted.
:param: settings: a dictionary containing the proposed values, with :param settings: a dictionary containing the proposed values, with
each key being the name of attribute and the each key being the name of attribute and the value
value being the proposed value. being the proposed value.
:returns: a dictionary containing the commit_needed key with a boolean :returns: a dictionary containing the commit_needed key with a boolean
value indicating whether a config job must be created for the value indicating whether a config job must be created for the
values to be applied. values to be applied.
@@ -193,15 +193,15 @@ class DRACClient(object):
the instance of the class, on which the CreateTargetedConfigJob method the instance of the class, on which the CreateTargetedConfigJob method
is invoked. is invoked.
:param: resource_uri: URI of resource to invoke :param resource_uri: URI of resource to invoke
:param: cim_creation_class_name: creation class name of the CIM object :param cim_creation_class_name: creation class name of the CIM object
:param: cim_name: name of the CIM object :param cim_name: name of the CIM object
:param: target: target device :param target: target device
:param: cim_system_creation_class_name: creation class name of the :param cim_system_creation_class_name: creation class name of the
scoping system scoping system
:param: cim_system_name: name of the scoping system :param cim_system_name: name of the scoping system
:param: reboot: indicates whether a RebootJob should be also be :param reboot: indicates whether a RebootJob should be also be
created or not created or not
:returns: id of the created job :returns: id of the created job
:raises: WSManRequestFailure on request failures :raises: WSManRequestFailure on request failures
:raises: WSManInvalidResponse when receiving invalid response :raises: WSManInvalidResponse when receiving invalid response
@@ -229,13 +229,13 @@ class DRACClient(object):
the instance of the class, on which the CreateTargetedConfigJob method the instance of the class, on which the CreateTargetedConfigJob method
is invoked. is invoked.
:param: resource_uri: URI of resource to invoke :param resource_uri: URI of resource to invoke
:param: cim_creation_class_name: creation class name of the CIM object :param cim_creation_class_name: creation class name of the CIM object
:param: cim_name: name of the CIM object :param cim_name: name of the CIM object
:param: target: target device :param target: target device
:param: cim_system_creation_class_name: creation class name of the :param cim_system_creation_class_name: creation class name of the
scoping system scoping system
:param: cim_system_name: name of the scoping system :param cim_system_name: name of the scoping system
:raises: WSManRequestFailure on request failures :raises: WSManRequestFailure on request failures
:raises: WSManInvalidResponse when receiving invalid response :raises: WSManInvalidResponse when receiving invalid response
:raises: DRACOperationFailed on error reported back by the DRAC :raises: DRACOperationFailed on error reported back by the DRAC
@@ -249,8 +249,8 @@ class DRACClient(object):
def commit_pending_bios_changes(self, reboot=False): def commit_pending_bios_changes(self, reboot=False):
"""Applies all pending changes on the BIOS by creating a config job """Applies all pending changes on the BIOS by creating a config job
:param: reboot: indicates whether a RebootJob should be also be :param reboot: indicates whether a RebootJob should be also be
created or not created or not
:returns: id of the created job :returns: id of the created job
:raises: WSManRequestFailure on request failures :raises: WSManRequestFailure on request failures
:raises: WSManInvalidResponse when receiving invalid response :raises: WSManInvalidResponse when receiving invalid response
@@ -374,8 +374,8 @@ class DRACClient(object):
...by creating a config job. ...by creating a config job.
:param: reboot: indicates whether a RebootJob should be also be :param reboot: indicates whether a RebootJob should be also be
created or not created or not
:returns: id of the created job :returns: id of the created job
:raises: WSManRequestFailure on request failures :raises: WSManRequestFailure on request failures
:raises: WSManInvalidResponse when receiving invalid response :raises: WSManInvalidResponse when receiving invalid response

6
dracclient/resources/bios.py
View File

@@ -503,9 +503,9 @@ class BIOSConfiguration(object):
attributes passed in. For the values to be applied, a config job must attributes passed in. For the values to be applied, a config job must
be created and the node must be rebooted. be created and the node must be rebooted.
:param: new_settings: a dictionary containing the proposed values, with :param new_settings: a dictionary containing the proposed values, with
each key being the name of attribute and the each key being the name of attribute and the
value being the proposed value. value being the proposed value.
:returns: a dictionary containing the commit_needed key with a boolean :returns: a dictionary containing the commit_needed key with a boolean
value indicating whether a config job must be created for the value indicating whether a config job must be created for the
values to be applied. values to be applied.

32
dracclient/resources/job.py
View File

@@ -96,15 +96,15 @@ class JobManagement(object):
the instance of the class, on which the CreateTargetedConfigJob method the instance of the class, on which the CreateTargetedConfigJob method
is invoked. is invoked.
:param: resource_uri: URI of resource to invoke :param resource_uri: URI of resource to invoke
:param: cim_creation_class_name: creation class name of the CIM object :param cim_creation_class_name: creation class name of the CIM object
:param: cim_name: name of the CIM object :param cim_name: name of the CIM object
:param: target: target device :param target: target device
:param: cim_system_creation_class_name: creation class name of the :param cim_system_creation_class_name: creation class name of the
scoping system scoping system
:param: cim_system_name: name of the scoping system :param cim_system_name: name of the scoping system
:param: reboot: indicates whether a RebootJob should be also be :param reboot: indicates whether a RebootJob should be also be
created or not created or not
:returns: id of the created job :returns: id of the created job
:raises: WSManRequestFailure on request failures :raises: WSManRequestFailure on request failures
:raises: WSManInvalidResponse when receiving invalid response :raises: WSManInvalidResponse when receiving invalid response
@@ -152,13 +152,13 @@ class JobManagement(object):
the instance of the class, on which the CreateTargetedConfigJob method the instance of the class, on which the CreateTargetedConfigJob method
is invoked. is invoked.
:param: resource_uri: URI of resource to invoke :param resource_uri: URI of resource to invoke
:param: cim_creation_class_name: creation class name of the CIM object :param cim_creation_class_name: creation class name of the CIM object
:param: cim_name: name of the CIM object :param cim_name: name of the CIM object
:param: target: target device :param target: target device
:param: cim_system_creation_class_name: creation class name of the :param cim_system_creation_class_name: creation class name of the
scoping system scoping system
:param: cim_system_name: name of the scoping system :param cim_system_name: name of the scoping system
:raises: WSManRequestFailure on request failures :raises: WSManRequestFailure on request failures
:raises: WSManInvalidResponse when receiving invalid response :raises: WSManInvalidResponse when receiving invalid response
:raises: DRACOperationFailed on error reported back by the DRAC :raises: DRACOperationFailed on error reported back by the DRAC

6
dracclient/utils.py
View File

@@ -50,9 +50,9 @@ def get_wsman_resource_attr(doc, resource_uri, attr_name, nullable=False):
:param doc: the element tree object. :param doc: the element tree object.
:param resource_uri: the resource URI of the namespace. :param resource_uri: the resource URI of the namespace.
:param attr_name: the name of the attribute. :param attr_name: the name of the attribute.
:param: nullable: enables checking if the element contains an :param nullable: enables checking if the element contains an
XMLSchema-instance namespaced nil attribute that has a XMLSchema-instance namespaced nil attribute that has a
value of True. In this case, it will return None. value of True. In this case, it will return None.
:returns: value of the attribute :returns: value of the attribute
""" """
item = find_xml(doc, attr_name, resource_uri) item = find_xml(doc, attr_name, resource_uri)