Repository : http://git.fedorahosted.org/cgit/cura-tools.git
On branch : openlmi-tools-lmiwbem
commit 13d0890825feb54f5fb5791f39b737cc4b7d4b68 Author: Peter Hatina phatina@redhat.com Date: Wed Apr 23 15:42:06 2014 +0200
fix html links in documentation
cli/lmi/shell/LMIBaseClient.py | 56 +++++++++++++++++++------------------- cli/lmi/shell/LMIBaseObject.py | 10 +++--- cli/lmi/shell/LMIClass.py | 26 +++++++++--------- cli/lmi/shell/LMIConnection.py | 10 +++--- cli/lmi/shell/LMIInstanceName.py | 38 +++++++++++++------------- cli/lmi/shell/LMIJob.py | 12 ++++---- cli/lmi/shell/LMIMethod.py | 14 +++++----- cli/lmi/shell/LMINamespace.py | 26 +++++++++--------- cli/lmi/shell/LMIShellClient.py | 18 ++++++------ cli/lmi/shell/LMISubscription.py | 2 +- cli/lmi/shell/LMIUtil.py | 42 ++++++++++++++-------------- 11 files changed, 127 insertions(+), 127 deletions(-)
diff --git a/cli/lmi/shell/LMIBaseClient.py b/cli/lmi/shell/LMIBaseClient.py index da9884f..fa967c0 100644 --- a/cli/lmi/shell/LMIBaseClient.py +++ b/cli/lmi/shell/LMIBaseClient.py @@ -28,17 +28,17 @@ from LMIExceptions import LMIFilterError class LMIBaseClient(object): """ Base client class for CIMOM communication. It abstracts the :py:mod:`lmiwbem` dependent - calls to :py:class:`LMIBaseClient` API. + calls to :py:class:`.LMIBaseClient` API.
:param string uri: URI of the CIMOM :param string username: account, under which, the CIM calls will be performed :param string password: user's password :param conn_type: type of connection; can be of 2 values:
- * :py:attr:`LMIBaseClient.CONN_TYPE_WBEM` -- WBEM connection - * :py:attr:`LMIBaseClient.CONN_TYPE_PEGASUS_UDS` -- applicable only for + * :py:attr:`.LMIBaseClient.CONN_TYPE_WBEM` -- WBEM connection + * :py:attr:`.LMIBaseClient.CONN_TYPE_PEGASUS_UDS` -- applicable only for Tog-Pegasus CIMOM, it uses Unix socket for the connection; default value is - :py:attr:`LMIbaseClient.CONN_TYPE_WBEM` + :py:attr:`.LMIbaseClient.CONN_TYPE_WBEM`
:param string key_file: path to x509 key file; default value is None :param string cert_file: path to x509 cert file; default value is None @@ -102,7 +102,7 @@ class LMIBaseClient(object): * **Key** or **key** (*string*) -- filtering key, see above * **Value** or **value** (*string*) -- filtering value, see above
- :returns: :py:class:`LMIReturnValue` object with ``rval`` contains a list of + :returns: :py:class:`.LMIReturnValue` object with ``rval`` contains a list of :py:class:`CIMInstanceName` objects, if no error occurs; otherwise ``rval`` is set to None and ``errorstr`` contains appropriate error string :raises: :py:exc:`.LMIFilterError`, :py:exc:`CIMError`, :py:exc:`ConnectionError` @@ -154,8 +154,8 @@ class LMIBaseClient(object):
* :py:class:`CIMInstanceName` * :py:class:`CIMInstance` - * :py:class:`LMIInstanceName` - * :py:class:`LMIInstance` + * :py:class:`.LMIInstanceName` + * :py:class:`.LMIInstance`
:param bool LocalOnly: indicates if to include the only elements (properties, @@ -174,7 +174,7 @@ class LMIBaseClient(object): are included in the response. If the PropertyList input parameter is None, no additional filtering is defined.
- :returns: :py:class:`LMIReturnValue` object, where ``rval`` is set to + :returns: :py:class:`.LMIReturnValue` object, where ``rval`` is set to :pyclass:`CIMInstance` object, if no error occurs; otherwise ``errorstr`` is set to corresponding error string :raises: :py:exc:`CIMError`, :py:exc:`ConnectionError`, :py:exc:`TypeError` @@ -205,7 +205,7 @@ class LMIBaseClient(object): * **Key** or **key** (*string*) -- filtering key, see above * **Value** or **value** (*string*) -- filtering value, see above
- :returns: :py:class:`LMIReturnValue` object with ``rval`` set to a list of + :returns: :py:class:`.LMIReturnValue` object with ``rval`` set to a list of :py:class:`CIMIntance` objects, if no error occurs; otherwise ``rval`` is set to None and ``errorstr`` is set to corresponding error string. @@ -286,7 +286,7 @@ class LMIBaseClient(object): :param bool DeepInheritance: if not present, of False, only the names of immediate child subclasses are returned, otherwise the names of all subclasses of the specified class should be returned. Default value is False. - :returns: :py:class:`LMIReturnValue` object with ``rval`` set to a list of strings + :returns: :py:class:`.LMIReturnValue` object with ``rval`` set to a list of strings containing class names, if no error occurs; otherwise ``rval`` is set to None and ``errorstr`` contains an appropriate error string :raises: :py:exc:`CIMError`, :py:exc:`ConnectionError` @@ -320,7 +320,7 @@ class LMIBaseClient(object): response. :param bool IncludeClassOrigin: indicates, if the ``CLASSORIGIN`` attribute shall be present on all appropriate elements in each returned class. - :returns: :py:class:`LMIReturnValue` object with ``rval`` set to a list of + :returns: :py:class:`.LMIReturnValue` object with ``rval`` set to a list of :py:class:`CIMClass` objects, if no error occurs; otherwise ``rval`` is set to None and ``errorstr`` to appropriate error string :raises: :py:exc:`CIMError`, :py:exc:`ConnectionError` @@ -358,7 +358,7 @@ class LMIBaseClient(object): response. If the PropertyList input parameter is an empty list, no properties are included in the response. If the PropertyList input parameter is None, no additional filtering is defined. Default value is None. - :returns: :py:class:`LMIReturnValue` object with rval set to + :returns: :py:class:`.LMIReturnValue` object with rval set to :py:class:`CIMClass`, if no error occurs; otherwise rval is set to none and errorstr to appropriate error string :raises: :py:exc:`CIMError`, :py:exc:`ConnectionError` @@ -394,12 +394,12 @@ class LMIBaseClient(object):
* :py:class:`CIMInstance` * :py:class:`CIMInstanceName` - * :py:class:`LMIInstance` - * :py:class:`LMIInstanceName` + * :py:class:`.LMIInstance` + * :py:class:`.LMIInstanceName`
:param string method: string containing a method name :param dictionary params: parameters passed to the method call - :returns: :py:class:`LMIReturnValue` object with rval set to return value of the + :returns: :py:class:`.LMIReturnValue` object with rval set to return value of the method call, rparams set to returned parameters from the method call, if no error occurs; otherwise rval is set to -1 and errorstr to appropriate error string @@ -424,8 +424,8 @@ class LMIBaseClient(object):
* :py:class:`CIMInstance` * :py:class:`CIMInstanceName` - * :py:class:`LMIInstance` - * :py:class:`LMIInstanceName` + * :py:class:`.LMIInstance` + * :py:class:`.LMIInstanceName`
:param string AssocClass: valid CIM association class name. It acts as a filter on the returned set of names by mandating that each returned name identify an @@ -469,8 +469,8 @@ class LMIBaseClient(object):
* :py:class:`CIMInstance` * :py:class:`CIMInstanceName` - * :py:class:`LMIInstance` - * :py:class:`LMIInstanceName` + * :py:class:`.LMIInstance` + * :py:class:`.LMIInstanceName`
:param string AssocClass: valid CIM association class name. It acts as a filter on the returned set of objects by mandating that each returned object shall be @@ -524,8 +524,8 @@ class LMIBaseClient(object):
* :py:class:`CIMInstance` * :py:class:`CIMInstanceName` - * :py:class:`LMIInstance` - * :py:class:`LMIInstanceName` + * :py:class:`.LMIInstance` + * :py:class:`.LMIInstanceName`
:param string ResultClass: valid CIM class name. It acts as a filter on the returned set of object names by mandating that each returned Object Name identify @@ -556,8 +556,8 @@ class LMIBaseClient(object):
* :py:class:`CIMInstance` * :py:class:`CIMInstanceName` - * :py:class:`LMIInstance` - * :py:class:`LMIInstanceName` + * :py:class:`.LMIInstance` + * :py:class:`.LMIInstanceName`
:param string ResultClass: valid CIM class name. It acts as a filter on the returned set of objects by mandating that each returned object shall be an @@ -634,7 +634,7 @@ class LMIBaseClient(object): If the PropertyList is None, the set of properties to be modified consists of those of *ModifiedInstance* with values different from the current values in the instance to be modified. Default value is None. - :returns: :py:class:`LMIReturnValue` object with ``rval`` set to 0, if no error + :returns: :py:class:`.LMIReturnValue` object with ``rval`` set to 0, if no error occurs; otherwise ``rval`` is set to -1 and ``errorstr`` is set to corresponding error string. :raises: :py:exc:`CIMError`, :py:exc:`ConnectionError` @@ -654,10 +654,10 @@ class LMIBaseClient(object):
* :py:class:`CIMInstance` * :py:class:`CIMInstanceName` - * :py:class:`LMIInstance` - * :py:class:`LMIInstanceName` + * :py:class:`.LMIInstance` + * :py:class:`.LMIInstanceName`
- :returns: :py:class:`LMIReturnValue` object with ``rval`` set to 0, if no error + :returns: :py:class:`.LMIReturnValue` object with ``rval`` set to 0, if no error occurs; otherwise ``rval`` is set to -1 and ``errorstr`` is set to corresponding error string :raises: :py:exc:`CIMError`, :py:exc:`ConnectionError`, :py:exc:`TypeError` @@ -675,7 +675,7 @@ class LMIBaseClient(object): :param string query_lang: query language :param string query: query to execute :param string namespace: target namespace for the query - :returns: :py:class:`LMIReturnValue` object with ``rval`` set to list of + :returns: :py:class:`.LMIReturnValue` object with ``rval`` set to list of :py:class:`CIMInstance` objects, if no error occurs; otherwise ``rval`` is set to empty list and ``errorstr`` is set to corresponding error string :raises: :py:exc:`CIMError`, :py:exc:`ConnectionError` diff --git a/cli/lmi/shell/LMIBaseObject.py b/cli/lmi/shell/LMIBaseObject.py index 565c89c..aec22ee 100644 --- a/cli/lmi/shell/LMIBaseObject.py +++ b/cli/lmi/shell/LMIBaseObject.py @@ -18,9 +18,9 @@
class LMIWrapperBaseObject(object): """ - Base class for all LMI wrapper classes, such as :py:class:`LMINamespace`, - :py:class:`LMIClass`, :py:class:`LMIInstanceName`, :py:class:`LMIInstance`, - :py:class:`LMIMethod`. + Base class for all LMI wrapper classes, such as :py:class:`.LMINamespace`, + :py:class:`.LMIClass`, :py:class:`.LMIInstanceName`, :py:class:`.LMIInstance`, + :py:class:`.LMIMethod`.
:param LMIConnection conn: connection object """ @@ -31,9 +31,9 @@ class LMIWrapperBaseObject(object): @property def connection(self): """ - Property returning :class:`LMIConnection` object. + Property returning :class:`.LMIConnection` object.
:returns: connection object - :rtype: :py:class:`LMIConnection` + :rtype: :py:class:`.LMIConnection` """ return self._conn diff --git a/cli/lmi/shell/LMIClass.py b/cli/lmi/shell/LMIClass.py index 0c440c1..698320f 100644 --- a/cli/lmi/shell/LMIClass.py +++ b/cli/lmi/shell/LMIClass.py @@ -65,7 +65,7 @@ class LMIClass(LMIWrapperBaseObject): :samp:`object.constant_value`.
:param string name: object member or constant values member - :returns: class member of :py:class:`LMIConstantValuesParamProp` object + :returns: class member of :py:class:`.LMIConstantValuesParamProp` object """ if name.endswith("Values"): if not self.is_fetched(True): @@ -79,12 +79,12 @@ class LMIClass(LMIWrapperBaseObject): def create_instance(self, properties=None, qualifiers=None, property_list=None): """ Creates a new :py:class:`CIMInstance` at the server side and returns - :py:class:`LMIReturnValue` object containing :py:class:`LMIInstance` as a result. + :py:class:`.LMIReturnValue` object containing :py:class:`.LMIInstance` as a result.
:param dictionary properties: initial properties with corresponding values :param dictionary qualifiers: initial qualifiers :param list property_list: list of properties, which should be present in - :py:class:`LMIInstance` object + :py:class:`.LMIInstance` object
**Usage:** See :ref:`class_create_instance`. """ @@ -176,8 +176,8 @@ class LMIClass(LMIWrapperBaseObject): * **Key** or **key** (*string*) -- filtering key, see above * **Value** or **value** -- filtering value, see above
- :returns: :py:class:`LMIReturnValue` object with ``rval`` set to a list of - :py:class:`LMIInstanceName` objects + :returns: :py:class:`.LMIReturnValue` object with ``rval`` set to a list of + :py:class:`.LMIInstanceName` objects
**Usage:** See :ref:`class_get_instance_names` and :ref:`class_instance_filtering`. """ @@ -189,12 +189,12 @@ class LMIClass(LMIWrapperBaseObject):
def new_instance_name(self, keybindings): """ - Create new :py:class:`LMIInstanceName` object by passing all the + Create new :py:class:`.LMIInstanceName` object by passing all the keys/values of the object.
:param dictionary keybindings: primary keys of instance name with corresponding values - :returns: new :py:class:`LMIInstanceName` object + :returns: new :py:class:`.LMIInstanceName` object
**Usage:** See :ref:`class_new_instance_name`. """ @@ -214,7 +214,7 @@ class LMIClass(LMIWrapperBaseObject): # NOTE: inst_filter is either None or dict def first_instance_name(self, inst_filter=None, **kwargs): """ - Returns the first :py:class:`LMIInstanceName` of the corresponding + Returns the first :py:class:`.LMIInstanceName` of the corresponding class.
:param dictionary inst_filter: filter values, where the key corresponds to the @@ -225,7 +225,7 @@ class LMIClass(LMIWrapperBaseObject): * **Key** or **key** (*string*) -- filtering key, see above * **Value** or **value** -- filtering value, see above
- :returns: first :py:class:`LMIInstanceName` object + :returns: first :py:class:`.LMIInstanceName` object
**Usage:** See :ref:`class_get_instance_names` and :ref:`class_instance_filtering`. """ @@ -239,7 +239,7 @@ class LMIClass(LMIWrapperBaseObject): @lmi_return_val_if_fail(lambda obj: obj._namespace, []) def instances(self, inst_filter=None, **kwargs): """ - Returns a list of objects of :py:class:`LMIInstance`. + Returns a list of objects of :py:class:`.LMIInstance`.
:param dictionary inst_filter: filter values, where the key corresponds to the key of :py:class:`CIMInstance`; value contains the filtering value @@ -248,7 +248,7 @@ class LMIClass(LMIWrapperBaseObject): * **Key** or **key** (*string*) -- filtering key, see above * **Value** or **value** -- filtering value, see above
- :returns: list of :py:class:`LMIInstance` objects + :returns: list of :py:class:`.LMIInstance` objects
**Usage:** See :ref:`class_get_instances` and :ref:`class_instance_filtering`. """ @@ -262,7 +262,7 @@ class LMIClass(LMIWrapperBaseObject): # NOTE: inst_filter is either None or dict def first_instance(self, inst_filter=None, **kwargs): """ - Returns the first :py:class:`LMIInstance` of the corresponding class. + Returns the first :py:class:`.LMIInstance` of the corresponding class.
:param dictionary inst_filter: filter values, where the key corresponds to the key of :py:class:`CIMInstance`; value contains the filtering value. @@ -271,7 +271,7 @@ class LMIClass(LMIWrapperBaseObject): * **Key** or **key** -- filtering key, see above * **Value** or **value** -- filtering value, see above
- :returns: first :py:class:`LMIInstance` object + :returns: first :py:class:`.LMIInstance` object
**Usage:** See :ref:`class_get_instances` and :ref:`class_instance_filtering`. """ diff --git a/cli/lmi/shell/LMIConnection.py b/cli/lmi/shell/LMIConnection.py index 275f63e..2c75623 100644 --- a/cli/lmi/shell/LMIConnection.py +++ b/cli/lmi/shell/LMIConnection.py @@ -122,7 +122,7 @@ def connect(uri, username="", password="", interactive=False, use_cache=True, asked for credentials. Default value is empty string. :returns: :py:class:`LMIConnection` object or None, if LMIShell does not use exceptions - :raises: :py:exc:`ConnectionError` + :raises: :py:exc:`.ConnectionError`
**NOTE:** If interactive is set to True, LMIShell will:
@@ -313,9 +313,9 @@ class LMIConnection(object): """ Connects to CIMOM and verifies credentials by performing a "dummy" :func:`GetClass` call on "SomeNonExistingClass". Provided credentials - are OK, if the LMIShell obtains :py:exc:`CIMError` exception with the + are OK, if the LMIShell obtains :py:exc:`.CIMError` exception with the flag ``CIM_ERR_NOT_FOUND`` set. Otherwise, we should receive - :py:exc:`ConnectionError`. + :py:exc:`.ConnectionError`.
:returns: :py:class:`LMIReturnValue` object with rval set to True, if the user was properly authenticated; False otherwise. In case of any @@ -360,9 +360,9 @@ class LMIConnection(object): :param dictionary kwargs: parameters for the indication subscription
* **Filter** (*LMIInstance*) -- if provided, the - :py:class:`LMIInstance` object will be used instead of creating a new one; + :py:class:`.LMIInstance` object will be used instead of creating a new one; **optional** - * **Handler** (*LMIInstance*) -- if provided, the :py:class:`LMIInstance` + * **Handler** (*LMIInstance*) -- if provided, the :py:class:`.LMIInstance` object will be used instead of creating a new one; **optional** * **Query** (*string*) -- string containing a query for the indications filtering * **QueryLanguage** (*string*) -- query language; eg. *WQL*, or *DMTF:CQL*. diff --git a/cli/lmi/shell/LMIInstanceName.py b/cli/lmi/shell/LMIInstanceName.py index ec6d240..f7e8d07 100644 --- a/cli/lmi/shell/LMIInstanceName.py +++ b/cli/lmi/shell/LMIInstanceName.py @@ -36,7 +36,7 @@ class LMIInstanceName(LMIWrapperBaseObject):
def __cmp__(self, other): """ - :param LMIInstanceName other: :py:class:`LMIInstanceName` object to compare + :param LMIInstanceName other: :py:class:`.LMIInstanceName` object to compare :returns: negative number, if self < other; 0 if self == other or positive number, if self > other :rtype: int @@ -105,7 +105,7 @@ class LMIInstanceName(LMIWrapperBaseObject):
def associator_names(self, **kwargs): """ - Returns a list of associated :py:class:`LMIInstanceName` with this object. + Returns a list of associated :py:class:`.LMIInstanceName` with this object.
:param string AssocClass: valid CIM association class name. It acts as a filter on the returned set of names by mandating that each returned name identify an @@ -127,7 +127,7 @@ class LMIInstanceName(LMIWrapperBaseObject): named returned object plays the specified role. That is, the name of the property in the association class that refers to the returned object shall match the value of this parameter. Default value is None. - :returns: list of associated :py:class:`LMIInstanceName` objects + :returns: list of associated :py:class:`.LMIInstanceName` objects
**Usage:** :ref:`associators_instance_names`. """ @@ -137,7 +137,7 @@ class LMIInstanceName(LMIWrapperBaseObject):
def first_associator_name(self, **kwargs): """ - Returns the first associated :py:class:`LMIInstanceName` with this object. + Returns the first associated :py:class:`.LMIInstanceName` with this object.
:param string AssocClass: valid CIM association class name. It acts as a filter on the returned set of names by mandating that each returned name identify an @@ -159,7 +159,7 @@ class LMIInstanceName(LMIWrapperBaseObject): named returned object plays the specified role. That is, the name of the property in the association class that refers to the returned object shall match the value of this parameter. Default value is None. - :returns: first associated :py:class:`LMIInstanceName` object + :returns: first associated :py:class:`.LMIInstanceName` object
**Usage:** :ref:`associators_instance_names`. """ @@ -168,7 +168,7 @@ class LMIInstanceName(LMIWrapperBaseObject):
def associators(self, **kwargs): """ - Returns a list of associated :py:class:`LMIInstance` objects with this instance. + Returns a list of associated :py:class:`.LMIInstance` objects with this instance.
:param string AssocClass: valid CIM association class name. It acts as a filter on the returned set of objects by mandating that each returned object shall be @@ -202,7 +202,7 @@ class LMIInstanceName(LMIWrapperBaseObject): properties missing from this list. If *PropertyList* is an empty list, no properties are included in each returned object. If it is None, no additional filtering is defined. Default value is None. - :returns: list of associated :py:class:`LMIInstance` objects + :returns: list of associated :py:class:`.LMIInstance` objects
**Usage:** :ref:`associators_instances`. """ @@ -211,7 +211,7 @@ class LMIInstanceName(LMIWrapperBaseObject):
def first_associator(self, **kwargs): """ - Returns the first associated :py:class:`LMIInstance` with this object. + Returns the first associated :py:class:`.LMIInstance` with this object.
:param string AssocClass: valid CIM association class name. It acts as a filter on the returned set of objects by mandating that each returned object shall be @@ -245,7 +245,7 @@ class LMIInstanceName(LMIWrapperBaseObject): properties missing from this list. If PropertyList is an empty list, no properties are included in each returned object. If it is None, no additional filtering is defined. Default value is None. - :returns: first associated :py:class:`LMIInstance` + :returns: first associated :py:class:`.LMIInstance`
**Usage:** :ref:`associators_instances`. """ @@ -254,7 +254,7 @@ class LMIInstanceName(LMIWrapperBaseObject):
def reference_names(self, **kwargs): """ - Returns a list of association :py:class:`LMIInstanceName` objects with this + Returns a list of association :py:class:`.LMIInstanceName` objects with this object.
:param string ResultClass: valid CIM class name. It acts as a filter on the @@ -265,7 +265,7 @@ class LMIInstanceName(LMIWrapperBaseObject): of object names by mandating that each returned object name shall identify an object that refers to the target instance through a property with a name that matches the value of this parameter. Default value is None. - :returns: list of association :py:class:`LMIInstanceName` objects + :returns: list of association :py:class:`.LMIInstanceName` objects
**Usage:** :ref:`references_instance_names`. """ @@ -275,7 +275,7 @@ class LMIInstanceName(LMIWrapperBaseObject):
def first_reference_name(self, **kwargs): """ - Returns the first association :py:class:`LMIInstanceName` with this object. + Returns the first association :py:class:`.LMIInstanceName` with this object.
:param string ResultClass: valid CIM class name. It acts as a filter on the returned set of object names by mandating that each returned Object Name @@ -285,7 +285,7 @@ class LMIInstanceName(LMIWrapperBaseObject): of object names by mandating that each returned object name shall identify an object that refers to the target instance through a property with a name that matches the value of this parameter. Default value is None. - :returns: first association :py:class:`LMIInstanceName` object + :returns: first association :py:class:`.LMIInstanceName` object
**Usage:** :ref:`references_instance_names`. """ @@ -294,7 +294,7 @@ class LMIInstanceName(LMIWrapperBaseObject):
def references(self, **kwargs): """ - Returns a list of association :py:class:`LMIInstance` objects with this object. + Returns a list of association :py:class:`.LMIInstance` objects with this object.
:param string ResultClass: valid CIM class name. It acts as a filter on the returned set of objects by mandating that each returned object shall be an @@ -315,7 +315,7 @@ class LMIInstanceName(LMIWrapperBaseObject): properties missing from this list. If PropertyList is an empty list, no properties are included in each returned object. If PropertyList is None, no additional filtering is defined. Default value is None. - :returns: list of association :py:class:`LMIInstance` objects + :returns: list of association :py:class:`.LMIInstance` objects
**Usage:** :ref:`references_instances`. """ @@ -325,7 +325,7 @@ class LMIInstanceName(LMIWrapperBaseObject):
def first_reference(self, **kwargs): """ - Returns the first association :py:class:`LMIInstance` with this object. + Returns the first association :py:class:`.LMIInstance` with this object.
:param string ResultClass: valid CIM class name. It acts as a filter on the returned set of objects by mandating that each returned object shall be an @@ -346,7 +346,7 @@ class LMIInstanceName(LMIWrapperBaseObject): properties missing from this list. If PropertyList is an empty list, no properties are included in each returned object. If PropertyList is None, no additional filtering is defined. Default value is None. - :returns: first association :py:class:`LMIInstance` object + :returns: first association :py:class:`.LMIInstance` object
**Usage:** :ref:`references_instances`. """ @@ -361,9 +361,9 @@ class LMIInstanceName(LMIWrapperBaseObject):
def to_instance(self): """ - Creates a new :py:class:`LMIInstance` object from :py:class:`LMIInstanceName`. + Creates a new :py:class:`.LMIInstance` object from :py:class:`.LMIInstanceName`.
- :returns: :py:class:`LMIInstance` object if the object was retrieved successfully; + :returns: :py:class:`.LMIInstance` object if the object was retrieved successfully; None otherwise.
**Usage:** :ref:`instance_names_conversion`. diff --git a/cli/lmi/shell/LMIJob.py b/cli/lmi/shell/LMIJob.py index e42888e..6e4fc37 100644 --- a/cli/lmi/shell/LMIJob.py +++ b/cli/lmi/shell/LMIJob.py @@ -34,7 +34,7 @@ def _lmi_get_job_state(job): """ Helper function, which returns a numeric Job state value.
- :param job: :py:class:`LMIInstance` or :py:class:`CIMInstance` representing a job + :param job: :py:class:`.LMIInstance` or :py:class:`CIMInstance` representing a job """ if isinstance(job, LMIObjectFactory().LMIInstance): return job.JobState @@ -46,7 +46,7 @@ def lmi_is_job_finished(job): """ Helper function, which returns bool flag, if the job is in finished state.
- :param job: :py:class:`LMIInstance` or :py:class:`CIMInstance` representing a job + :param job: :py:class:`.LMIInstance` or :py:class:`CIMInstance` representing a job """ return _lmi_get_job_state(job) in ( \ JOB_STATE_COMPLETED, \ @@ -59,7 +59,7 @@ def lmi_is_job_completed(job): """ Helper function, which returns bool flag, if the job is in completed state.
- :param job: :py:class:`LMIInstance` or :py:class:`CIMInstance` representing a job + :param job: :py:class:`.LMIInstance` or :py:class:`CIMInstance` representing a job """ return _lmi_get_job_state(job) == JOB_STATE_COMPLETED
@@ -67,7 +67,7 @@ def lmi_is_job_terminated(job): """ Helper function, which returns bool flag, if the job is in terminated state.
- :param job: :py:class:`LMIInstance` or :py:class:`CIMInstance` representing a job + :param job: :py:class:`.LMIInstance` or :py:class:`CIMInstance` representing a job """ return _lmi_get_job_state(job) == JOB_STATE_TERMINATED
@@ -75,7 +75,7 @@ def lmi_is_job_killed(job): """ Helper function, which returns bool flag, if the job is killed.
- :param job: :py:class:`LMIInstance` or :py:class:`CIMInstance` representing a job + :param job: :py:class:`.LMIInstance` or :py:class:`CIMInstance` representing a job """ return _lmi_get_job_state(job) == JOB_STATE_KILLED
@@ -83,6 +83,6 @@ def lmi_is_job_exception(job): """ Helper function, which returns bool flag, if the job is in the exception state.
- :param job: :py:class:`LMIInstance` or :py:class:`CIMInstance` representing a job + :param job: :py:class:`.LMIInstance` or :py:class:`CIMInstance` representing a job """ return _lmi_get_job_state(job) == JOB_STATE_EXCEPTION diff --git a/cli/lmi/shell/LMIMethod.py b/cli/lmi/shell/LMIMethod.py index 8169ff2..0038551 100644 --- a/cli/lmi/shell/LMIMethod.py +++ b/cli/lmi/shell/LMIMethod.py @@ -138,7 +138,7 @@ class LMIMethod(LMIWrapperBaseObject): LMI wrapper class representing :py:class:`CIMMethod`.
:param LMIConnection conn: connection object - :param LMIInstance lmi_instance: :py:class:`LMIInstance` object, on which the method + :param LMIInstance lmi_instance: :py:class:`.LMIInstance` object, on which the method call will be issued :param string method: method name """ @@ -191,12 +191,12 @@ class LMIMethod(LMIWrapperBaseObject):
def __return_synchro_method_call(self, job_inst, job_refresh=True): """ - Returns a :py:class:`LMIReturnValue` object with Job output parameters set. + Returns a :py:class:`.LMIReturnValue` object with Job output parameters set.
:param LMIInstance job_inst: job returned from a synchronous method call :param bool job_refresh: flag, which indicates, if the ``job_inst`` needs to be refreshed - :returns: :py:class:`LMIReturnValue` object with ``rval`` set to Job output parameters + :returns: :py:class:`.LMIReturnValue` object with ``rval`` set to Job output parameters """ # Adjust return value from the job object. if job_refresh: @@ -239,7 +239,7 @@ class LMIMethod(LMIWrapperBaseObject):
:param LMIInstance job_inst: job object returned from a synchronous method call - :returns: :py:class:`LMIReturnValue` object with ``rval`` set to 0 and ``rparams`` + :returns: :py:class:`.LMIReturnValue` object with ``rval`` set to 0 and ``rparams`` set to job's output parameters :raises: :py:exc:`.LMIIndicationListenerError`, :py:exc:`.LMISynchroMethodCallError`, @@ -251,7 +251,7 @@ class LMIMethod(LMIWrapperBaseObject): """ def handle_job(ind, cond, job_finished, job_exception): """ - :py:class:`LMIListener` handler for synchronous method call, which uses + :py:class:`.LMIListener` handler for synchronous method call, which uses indication means of waiting for the job. This function is called, when a job changes its state.
@@ -437,7 +437,7 @@ class LMIMethod(LMIWrapperBaseObject): This call uses polling method to wait for the job to finish.
:param LMIInstance job_inst: job object - :returns: :py:class:`LMIReturnValue` object with ``rval`` set to 0 and ``rparams`` + :returns: :py:class:`.LMIReturnValue` object with ``rval`` set to 0 and ``rparams`` set to job's output parameters. :raises: :py:exc:`.LMISynchroMethodCallError` """ @@ -511,7 +511,7 @@ class LMIMethod(LMIWrapperBaseObject): the instance should be refreshed after a method call. Default value is False.
- :returns: :py:class:`LMIReturnValue` object with ``rval`` set to method's return + :returns: :py:class:`.LMIReturnValue` object with ``rval`` set to method's return value; ``rparams`` set to method's return parameters; ``errorstr`` set method's error string in case of failure :raises: :py:exc:`.LMIUnknownParameterError`, diff --git a/cli/lmi/shell/LMINamespace.py b/cli/lmi/shell/LMINamespace.py index 2e9b131..4fc41ff 100644 --- a/cli/lmi/shell/LMINamespace.py +++ b/cli/lmi/shell/LMINamespace.py @@ -37,10 +37,10 @@ class LMINamespace(LMIWrapperBaseObject):
def __getattr__(self, name): """ - Returns a :py:class:`LMIClass` object. + Returns a :py:class:`.LMIClass` object.
:param string name: class name - :returns: :py:class:`LMIClass` object + :returns: :py:class:`.LMIClass` object """ return lmi_wrap_cim_class(self._conn, name, self.name)
@@ -92,11 +92,11 @@ class LMINamespace(LMIWrapperBaseObject):
def cql(self, query): """ - Executes a CQL query and returns a list of :py:class:`LMIInstance` objects. + Executes a CQL query and returns a list of :py:class:`.LMIInstance` objects.
:param string query: CQL query to execute - :returns: :py:class:`LMIReturnValue` object with ``rval`` set to a list - of :py:class:`LMIInstance` objects + :returns: :py:class:`.LMIReturnValue` object with ``rval`` set to a list + of :py:class:`.LMIInstance` objects
**Usage:** :ref:`namespaces_queries`. """ @@ -107,11 +107,11 @@ class LMINamespace(LMIWrapperBaseObject):
def wql(self, query): """ - Executes a WQL query and returns a list of :py:class:`LMIInstance` objects. + Executes a WQL query and returns a list of :py:class:`.LMIInstance` objects.
:param string query: WQL query to execute - :returns: :py:class:`LMIReturnValue` object with ``rval`` set to a list - of :py:class:`LMIInstance` objects + :returns: :py:class:`.LMIReturnValue` object with ``rval`` set to a list + of :py:class:`.LMIInstance` objects
**Usage:** :ref:`namespaces_queries`. """ @@ -131,7 +131,7 @@ class LMINamespace(LMIWrapperBaseObject): class LMINamespaceRoot(LMINamespace): """ Derived class for *root* namespace. Object of this class is accessible - from :py:class:`LMIConnection` object as a hierarchy entry. + from :py:class:`.LMIConnection` object as a hierarchy entry.
:param LMIConnection conn: connection object """ @@ -142,7 +142,7 @@ class LMINamespaceRoot(LMINamespace): def cimv2(self): """ :returns: *root/cimv2* namespace - :rtype: :py:class:`LMINamespace` + :rtype: :py:class:`.LMINamespace` """ return lmi_wrap_cim_namespace(self._conn, "root/cimv2")
@@ -150,7 +150,7 @@ class LMINamespaceRoot(LMINamespace): def interop(self): """ :returns: *root/interop* namespace - :rtype: :py:class:`LMINamespace` + :rtype: :py:class:`.LMINamespace` """ return lmi_wrap_cim_namespace(self._conn, "root/interop")
@@ -158,7 +158,7 @@ class LMINamespaceRoot(LMINamespace): def PG_InterOp(self): """ :returns: *root/PG_InterIp* namespace - :rtype: :py:class:`LMINamespace` + :rtype: :py:class:`.LMINamespace` """ return lmi_wrap_cim_namespace(self._conn, "root/PG_InterOp")
@@ -166,7 +166,7 @@ class LMINamespaceRoot(LMINamespace): def PG_Internal(self): """ :returns: *root/PG_Internal* namespace - :rtype: :py:class:`LMINamespace` + :rtype: :py:class:`.LMINamespace` """ return lmi_wrap_cim_namespace(self._conn, "root/PG_Internal")
diff --git a/cli/lmi/shell/LMIShellClient.py b/cli/lmi/shell/LMIShellClient.py index 809a6b5..e704745 100644 --- a/cli/lmi/shell/LMIShellClient.py +++ b/cli/lmi/shell/LMIShellClient.py @@ -19,7 +19,7 @@ from LMIShellCache import LMIShellCache
class LMIShellClient(LMIBaseClient): """ - :class:`LMIShellClient` overrides few methods due to caching purposes. + :class:`.LMIShellClient` overrides few methods due to caching purposes.
:param string uri: URI of the CIMOM :param string username: account, under which, the CIM calls will be performed @@ -28,14 +28,14 @@ class LMIShellClient(LMIBaseClient): interactive mode; default value is False. :param bool use_cache: flag indicating, if the LMIShell client should use cache for :class:`CIMClass` objects. This saves a lot's of communication, if there is often - the :meth:`LMIShellClient._get_class_names()` or - :meth:`LMIShellClient.attr._get_class()` call issued. + the :meth:`.LMIShellClient._get_class_names()` or + :meth:`.LMIShellClient.attr._get_class()` call issued. :param conn_type: type of connection; can be of 2 values:
- * :attr:`LMIBaseClient.CONN_TYPE_WBEM` -- WBEM connection, - * :attr:`LMIBaseClient.CONN_TYPE_PEGASUS_UDS` -- applicable only for + * :attr:`.LMIBaseClient.CONN_TYPE_WBEM` -- WBEM connection, + * :attr:`.LMIBaseClient.CONN_TYPE_PEGASUS_UDS` -- applicable only for Tog-Pegasus CIMOM, it uses Unix socket for the connection; default value is - :attr:`LMIBaseClient.CONN_TYPE_WBEM` + :attr:`.LMIBaseClient.CONN_TYPE_WBEM`
:param string key_file: path to x509 key file; default value is None :param string cert_file: path to x509 cert file; default value is None @@ -71,7 +71,7 @@ class LMIShellClient(LMIBaseClient): :param bool DeepInheritance: if not present, of False, only the names of immediate child subclasses are returned, otherwise the names of all subclasses of the specified class should be returned. Default value is False. - :returns: :class:`LMIReturnValue` object with ``rval`` set to list of + :returns: :class:`.LMIReturnValue` object with ``rval`` set to list of string with class names, if no error occurs; otherwise ``rval`` is set to None and ``errorstr`` contains an appropriate error string. :raises: :exc:`CIMError`, :exc:`ConnectionError` @@ -115,7 +115,7 @@ class LMIShellClient(LMIBaseClient): additional filtering is defined. :param bool full_fetch: True, if :py:class:`CIMClass` is cached with qualifiers; False otherwise. Default value is False. - :returns: :class:`LMIReturnValue` object with ``rval`` set to :class:`CIMClass`, + :returns: :class:`.LMIReturnValue` object with ``rval`` set to :class:`CIMClass`, if no error occurs; otherwise ``rval`` is set to None and ``errorstr`` to appropriate error string :raises: :exc:`CIMError`, :exc:`ConnectionError` @@ -174,7 +174,7 @@ class LMIShellClient(LMIBaseClient): """ Property setter for interactive flag.
- :param bool i: new :attr:`LMIShellClient.interactive` state + :param bool i: new :attr:`.LMIShellClient.interactive` state """ self._interactive = bool(i)
diff --git a/cli/lmi/shell/LMISubscription.py b/cli/lmi/shell/LMISubscription.py index a61dcc2..dcafe7d 100644 --- a/cli/lmi/shell/LMISubscription.py +++ b/cli/lmi/shell/LMISubscription.py @@ -43,7 +43,7 @@ class LMISubscription(object): :py:attr:`.LMISubscription._cim_handler_tlp` contains an flag, that the handler object was created temporarily, it will be deleted as well.
- This is called from :py:class:`LMIConnection` object, which holds an internal list + This is called from :py:class:`.LMIConnection` object, which holds an internal list of all subscribed indications by the LMIShell (if not created by hand). """ self._client._delete_instance(self._cim_subscription.path) diff --git a/cli/lmi/shell/LMIUtil.py b/cli/lmi/shell/LMIUtil.py index 8f02692..c32660a 100644 --- a/cli/lmi/shell/LMIUtil.py +++ b/cli/lmi/shell/LMIUtil.py @@ -31,7 +31,7 @@ class LMIUseExceptionsHelper(object):
def __new__(cls): """ - Return a new :py:class:`LMIUseExceptionsHelper` instance, if no shared object is + Return a new :py:class:`.LMIUseExceptionsHelper` instance, if no shared object is present; otherwise an existing instance is returned. By default the ``use_exceptions`` flag is set to False. """ @@ -185,23 +185,23 @@ def lmi_cast_to_lmi(t, value):
def lmi_wrap_cim_namespace(conn, cim_namespace_name): """ - Helper function, which returns wrapped CIM namespace in :py:class:`LMINamespace`. + Helper function, which returns wrapped CIM namespace in :py:class:`.LMINamespace`.
:param LMIConnection conn: connection object :param string cim_namespace_name: CIM namespace name - :returns: wrapped CIM namespace into :py:class:`LMINamespace` + :returns: wrapped CIM namespace into :py:class:`.LMINamespace` """ return LMIObjectFactory().LMINamespace(conn, cim_namespace_name)
def lmi_wrap_cim_class(conn, cim_class_name, cim_namespace_name): """ - Helper function, which returns wrapped :py:class:`CIMClass` into LMIClass. + Helper function, which returns wrapped :py:class:`CIMClass` into :py:class:`.LMIClass`.
:param LMIConnection conn: connection object :param string cim_class_name: string containing :py:class:`CIMClass` name :param string cim_namespace_name: string containing :py:class:`CIMNamespace` name, or None, if the namespace is not known - :returns: wrapped :py:class:`CIMClass` into :py:class:`LMIClass` + :returns: wrapped :py:class:`CIMClass` into :py:class:`.LMIClass` """ lmi_namespace = None if cim_namespace_name: @@ -211,14 +211,14 @@ def lmi_wrap_cim_class(conn, cim_class_name, cim_namespace_name): def lmi_wrap_cim_instance(conn, cim_instance, cim_class_name, cim_namespace_name): """ Helper function, which returns wrapped :py:class:`CIMInstance` into - :py:class:`LMIInstance`. + :py:class:`.LMIInstance`.
:param LMIConnection conn: connection object :param CIMInstance cim_instance: :py:class:`CIMInstance` object to be wrapped :param string cim_class_name: :py:class:`CIMClass` name :param string cim_namespace_name: :py:class:`CIMNamespace` name, or None, if the namespace is not known - :returns: wrapped :py:class:`CIMInstance` into :py:class:`LMIInstance` + :returns: wrapped :py:class:`CIMInstance` into :py:class:`.LMIInstance` """ lmi_class = lmi_wrap_cim_class(conn, cim_class_name, cim_namespace_name) return LMIObjectFactory().LMIInstance(conn, lmi_class, cim_instance) @@ -226,24 +226,24 @@ def lmi_wrap_cim_instance(conn, cim_instance, cim_class_name, cim_namespace_name def lmi_wrap_cim_instance_name(conn, cim_instance_name): """ Helper function, which returns wrapped :py:class:`CIMInstanceName` into - :py:class:`LMIInstanceName`. + :py:class:`.LMIInstanceName`.
:param LMIConnection conn: connection object :param CIMInstanceName cim_instance_name: :py:class:`CIMInstanceName` object to be wrapped - :returns: wrapped :py:class:`CIMInstanceName` into :py:class:`LMIInstanceName` + :returns: wrapped :py:class:`CIMInstanceName` into :py:class:`.LMIInstanceName` """ return LMIObjectFactory().LMIInstanceName(conn, cim_instance_name)
def lmi_wrap_cim_method(conn, cim_method_name, lmi_instance): """ Helper function, which returns wrapped :py:class:`CIMMethod` into - :py:class:`LMIMethod`. + :py:class:`.LMIMethod`.
:param LMIConnection conn: connection object :param string cim_method_name: method name :param LMIInstance lmi_instance: object, on which the method call will be issued - :returns: wrapped :py:class:`CIMMethod` into :py:class:`LMIMethod` + :returns: wrapped :py:class:`CIMMethod` into :py:class:`.LMIMethod` """ return LMIObjectFactory().LMIMethod(conn, lmi_instance, cim_method_name)
@@ -303,17 +303,17 @@ def lmi_transform_to_cim_param(t, value): def lmi_isinstance(lmi_obj, lmi_class): """ Function returns True if :samp:`lmi_obj` is an instance of a :samp:`lmi_class`, False - otherwise. When passed :py:class:`LMIInstance`, :py:class:`LMIInstanceName` as - :samp:`lmi_obj` and :samp:`lmi_class` is of :py:class:`LMIClass` type, function can - tell, if such :samp:`lmi_obj` is direct instance of :py:class:`LMIClass`, or it's + otherwise. When passed :py:class:`.LMIInstance`, :py:class:`.LMIInstanceName` as + :samp:`lmi_obj` and :samp:`lmi_class` is of :py:class:`.LMIClass` type, function can + tell, if such :samp:`lmi_obj` is direct instance of :py:class:`.LMIClass`, or it's super class.
If :samp:`lmi_obj` and :samp:`lmi_class` is not instance of mentioned classes, an exception will be raised.
- :param lmi_obj: instance of :py:class:`LMIInstance` or :py:class:`LMIInstanceName` + :param lmi_obj: instance of :py:class:`.LMIInstance` or :py:class:`.LMIInstanceName` which is checked, if such instance is instance of the ``lmi_class`` - :param LMIClass lmi_class: instance of :py:class:`LMIClass` object + :param LMIClass lmi_class: instance of :py:class:`.LMIClass` object :returns: whether **lmi_obj** is instance of **lmi_class** :rtype: bool :raises: :py:exc:`TypeError` @@ -336,11 +336,11 @@ def lmi_isinstance(lmi_obj, lmi_class): def lmi_associators(assoc_classes): """ Helper function to speed up associator traversal. Returns a list of tuples, where each - tuple contains :py:class:`LMIInstance` objects, which are in association. + tuple contains :py:class:`.LMIInstance` objects, which are in association.
- :param list assoc_classes: list of :py:class:`LMIClass` objects, for which the + :param list assoc_classes: list of :py:class:`.LMIClass` objects, for which the associations will be returned - :returns: list of tuples of :py:class:`LMIInstance` objects in association + :returns: list of tuples of :py:class:`.LMIInstance` objects in association """ def make_key(path): path.host = None @@ -400,8 +400,8 @@ def lmi_instance_to_path(instance):
* :py:class:`CIMInstance` * :py:class:`CIMInstanceName` - * :py:class:`LMIInstance` - * :py:class:`LMIInstanceName` + * :py:class:`.LMIInstance` + * :py:class:`.LMIInstanceName`
:returns: extracteed :py:class:`CIMInstanceName` object :raises: :py:exc:`TypeError`
cura-tools-devel@lists.fedorahosted.org