Repository : http://git.fedorahosted.org/cgit/cura-tools.git
On branch : master
commit c93ec6d7db58200c19662792e752f487c7532a11 Author: Peter Hatina phatina@redhat.com Date: Tue Jul 22 11:09:56 2014 +0200
fix sphinx documentation references
cli/lmi/shell/LMICIMXMLClient.py | 2 +- cli/lmi/shell/LMIConnection.py | 12 ++++---- cli/lmi/shell/LMIConsole.py | 8 ++-- cli/lmi/shell/LMIDecorators.py | 6 ++-- cli/lmi/shell/LMIExceptions.py | 2 +- cli/lmi/shell/LMIInstance.py | 58 ++++++++++++++++++------------------ cli/lmi/shell/LMIObjectFactory.py | 2 +- cli/lmi/shell/LMIShellCache.py | 4 +- cli/lmi/shell/LMIShellConfig.py | 2 +- 9 files changed, 48 insertions(+), 48 deletions(-)
diff --git a/cli/lmi/shell/LMICIMXMLClient.py b/cli/lmi/shell/LMICIMXMLClient.py index 4cd9d5a..fc62394 100644 --- a/cli/lmi/shell/LMICIMXMLClient.py +++ b/cli/lmi/shell/LMICIMXMLClient.py @@ -269,7 +269,7 @@ class LMICIMXMLClient(object): properties 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 - :pyclass:`wbem.CIMInstance` object, if no error occurs; otherwise + :py:class:`wbem.CIMInstance` object, if no error occurs; otherwise ``rval`` is set to None and ``errorstr`` is set to corresponding error string. :raises: :py:exc:`.CIMError`, :py:exc:`.ConnectionError`, diff --git a/cli/lmi/shell/LMIConnection.py b/cli/lmi/shell/LMIConnection.py index 7ab9e2c..97bceaa 100644 --- a/cli/lmi/shell/LMIConnection.py +++ b/cli/lmi/shell/LMIConnection.py @@ -115,7 +115,7 @@ def connect(uri, username="", password="", interactive=False, use_cache=True, certificate needs to be verified, if SSL used; default value is True. :param string prompt_prefix: username and password prompt prefix in case the user is asked for credentials. Default value is empty string. - :returns: :py:class:`LMIConnection` object or None, if LMIShell does not + :returns: :py:class:`.LMIConnection` object or None, if LMIShell does not use exceptions :raises: :py:exc:`.ConnectionError`
@@ -317,7 +317,7 @@ class LMIConnection(object): def get_namespace(self, namespace): """ :param string namespace: namespace path (eg. `root/cimv2`) - :returns: :py:class:`LMINamespace` object + :returns: :py:class:`.LMINamespace` object :raises: :py:exc:`.LMINamespaceNotFound` """ def get_namespace_priv(namespace, namespace_path): @@ -353,11 +353,11 @@ class LMIConnection(object): Connects to CIMOM and verifies credentials by performing a "dummy" request.
- :returns: :py:class:`LMIReturnValue` object with rval set to True, if + :returns: :py:class:`.LMIReturnValue` object with rval set to True, if the user was properly authenticated; False otherwise. In case of any error, rval is set to False and errorstr contains appropriate error string. - :rtype: :py:class:`LMIReturnValue` + :rtype: :py:class:`.LMIReturnValue` """ # Connect to CIMOM. We may fail before the actual "dummy" request is # sent. This only applies for LMIWBEM. @@ -430,7 +430,7 @@ class LMIConnection(object): * **Destination** (*string*) -- destination URI, where the indications should be delivered
- :returns: :py:class:`LMIReturnValue` object with ``rval`` set to True, + :returns: :py:class:`.LMIReturnValue` object with ``rval`` set to True, if indication was subscribed; False otherwise. If a error occurs, ``errorstr`` is set to appropriate error string. """ @@ -550,7 +550,7 @@ class LMIConnection(object): Unsubscribes an indication.
:param string name: indication name - :returns: :py:class:`LMIReturnValue` object with ``rval`` set to True, + :returns: :py:class:`.LMIReturnValue` object with ``rval`` set to True, if unsubscribed; False otherwise """ if name not in self._indications: diff --git a/cli/lmi/shell/LMIConsole.py b/cli/lmi/shell/LMIConsole.py index 2092482..93911cc 100644 --- a/cli/lmi/shell/LMIConsole.py +++ b/cli/lmi/shell/LMIConsole.py @@ -123,7 +123,7 @@ class LMIConsole(code.InteractiveConsole): verify_server_cert=self._verify_server_cert, prompt_prefix=""): """ - Returns :py:class:`LMIConnection` object with provided URI and + Returns :py:class:`.LMIConnection` object with provided URI and credentials.
:param string uri: URI of the CIMOM @@ -142,7 +142,7 @@ class LMIConsole(code.InteractiveConsole): default value is empty string
:returns: connection object - :rtype: :py:class:`LMIConnection` + :rtype: :py:class:`.LMIConnection` """ return connect_internal( uri, username, password, interactive=True, @@ -225,7 +225,7 @@ class LMIConsole(code.InteractiveConsole): verify_server_cert=self._verify_server_cert, prompt_prefix=""): """ - Returns :py:class:`LMIConnection` object with provided URI and + Returns :py:class:`.LMIConnection` object with provided URI and credentials.
:param string uri: URI of the CIMOM @@ -244,7 +244,7 @@ class LMIConsole(code.InteractiveConsole): default value is empty string
:returns: connection object - :rtype: :py:class:`LMIConnection` + :rtype: :py:class:`.LMIConnection` """ return connect_internal( uri, username, password, interactive=interactive, diff --git a/cli/lmi/shell/LMIDecorators.py b/cli/lmi/shell/LMIDecorators.py index cc33605..8be5694 100644 --- a/cli/lmi/shell/LMIDecorators.py +++ b/cli/lmi/shell/LMIDecorators.py @@ -231,7 +231,7 @@ class lmi_possibly_deleted(lmi_return_expr_if_fail):
class lmi_class_fetch_lazy(object): """ - Decorator for :py:class:`LMIClass`, which first fetches a wrapped + Decorator for :py:class:`.LMIClass`, which first fetches a wrapped :py:class:`wbem.CIMClass` object and then executes a wrapped method.
:param bool full_fetch: True, if :py:class:`wbem.CIMClass` should include @@ -310,7 +310,7 @@ class lmi_process_cim_exceptions(object): Execute a wrapped method.
:param instancemethod fn: decorated method - :raises: :py:exc:`CIMError`, :py:exc:`ConnectionError` + :raises: :py:exc:`.CIMError`, :py:exc:`.ConnectionError` """ @wraps(fn) def wrapped(*args, **kwargs): @@ -363,7 +363,7 @@ class lmi_process_wsman_exceptions(object): Execute a wrapped method.
:param instancemethod fn: decorated method - :raises: :py:exc:`CIMError` + :raises: :py:exc:`.CIMError` """ @wraps(fn) def wrapped(*args, **kwargs): diff --git a/cli/lmi/shell/LMIExceptions.py b/cli/lmi/shell/LMIExceptions.py index 58ececc..9a3f65c 100644 --- a/cli/lmi/shell/LMIExceptions.py +++ b/cli/lmi/shell/LMIExceptions.py @@ -17,7 +17,7 @@ class LMIDeletedObjectError(Exception): """ Raised, when there is an attempt to access properties on deleted - :py:class:`LMIInstance` object. + :py:class:`.LMIInstance` object. """
diff --git a/cli/lmi/shell/LMIInstance.py b/cli/lmi/shell/LMIInstance.py index f478b84..f842ab8 100644 --- a/cli/lmi/shell/LMIInstance.py +++ b/cli/lmi/shell/LMIInstance.py @@ -54,7 +54,7 @@ class LMIInstance(LMIWrapperBaseObject):
def __cmp__(self, other): """ - :param LMIInstance other: :py:class:`LMIInstance` object to compare + :param LMIInstance other: :py:class:`.LMIInstance` object to compare :returns: If both instances are (not) deleted: negative number, if self < other; 0 if self == other or positive number, if self > other. If the first or second instance is deleted, -1 or @@ -75,7 +75,7 @@ class LMIInstance(LMIWrapperBaseObject): Returns True, if the specified key is present in the properties, False otherwise.
- **NOTE:** If the method :py:meth:``LMIInstance.delete` was called, this + **NOTE:** If the method :py:meth:`.LMIInstance.delete` was called, this method will not execute its code and will return None. If the shell uses exceptions, :py:exc:`.LMIDeletedObjectError` will be raised.
@@ -90,16 +90,16 @@ class LMIInstance(LMIWrapperBaseObject): @lmi_possibly_deleted(None) def __getattr__(self, name): """ - Returns either a class member, :py:class:`LMIMethod` object, or a + Returns either a class member, :py:class:`.LMIMethod` object, or a :py:class:`wbem.CIMInstance` object property.
- **NOTE:** If the method :py:meth:``LMIInstance.delete` was called, this + **NOTE:** If the method :py:meth:`.LMIInstance.delete` was called, this method will not execute its code and will return None. If the shell uses exceptions, :py:exc:`.LMIDeletedObjectError` will be raised.
:param string name: class member, the method name, or the property to be returned - :returns: class member, :py:class:`LMIMethod` object or + :returns: class member, :py:class:`.LMIMethod` object or :py:class:`wbem.CIMInstance` object property :raises: :py:exc:`.LMIDeletedObjectError` """ @@ -226,13 +226,13 @@ class LMIInstance(LMIWrapperBaseObject): @lmi_possibly_deleted(None) def path(self): """ - Property returning a :py:class:`LMIInstanceName` object. + Property returning a :py:class:`.LMIInstanceName` object.
**NOTE:** If the method :py:meth:`.LMIInstance.delete` was called, this method will not execute its code and will return None. If the shell - uses exceptions, :py:exc:`LMIDeletedObjectError` will be raised. + uses exceptions, :py:exc:`.LMIDeletedObjectError` will be raised.
- :returns: :py:class:`LMIInstanceName` object + :returns: :py:class:`.LMIInstanceName` object :raises: :py:exc:`.LMIDeletedObjectError` """ return lmi_transform_to_lmi(self._conn, self._cim_instance.path) @@ -280,7 +280,7 @@ class LMIInstance(LMIWrapperBaseObject): def associator_names(self, AssocClass=None, ResultClass=None, Role=None, ResultRole=None): """ - Returns a list of associated :py:class:`LMIInstanceName` with this + Returns a list of associated :py:class:`.LMIInstanceName` with this object.
**NOTE:** If the method :py:meth:`.LMIInstance.delete` was called, this @@ -311,7 +311,7 @@ class LMIInstance(LMIWrapperBaseObject): 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. - :returns: list of associated :py:class:`LMIInstanceName` objects + :returns: list of associated :py:class:`.LMIInstanceName` objects :raises: :py:exc:`.LMIDeletedObjectError`
**Usage:** :ref:`associators_instance_names`. @@ -324,7 +324,7 @@ class LMIInstance(LMIWrapperBaseObject): def first_associator_name(self, AssocClass=None, ResultClass=None, Role=None, ResultRole=None): """ - Returns the first associated :py:class:`LMIInstanceName` with this + Returns the first associated :py:class:`.LMIInstanceName` with this object.
**NOTE:** If the method :py:meth:`.LMIInstance.delete` was called, this @@ -355,7 +355,7 @@ class LMIInstance(LMIWrapperBaseObject): 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. - :returns: first associated :py:class:`LMIInstanceName` object + :returns: first associated :py:class:`.LMIInstanceName` object :raises: :py:exc:`.LMIDeletedObjectError`
**Usage:** :ref:`associators_instance_names`. @@ -373,7 +373,7 @@ class LMIInstance(LMIWrapperBaseObject): ResultRole=None, IncludeQualifiers=False, IncludeClassOrigin=False, PropertyList=None): """ - Returns a list of associated :py:class:`LMIInstance` objects with this + Returns a list of associated :py:class:`.LMIInstance` objects with this instance.
**NOTE:** If the method :py:meth:`.LMIInstance.delete` was called, this @@ -413,7 +413,7 @@ class LMIInstance(LMIWrapperBaseObject): *PropertyList* is an empty list, no properties are included in each returned object. If it is None, no additional filtering is defined. - :returns: list of associated :py:class:`LMIInstance` objects + :returns: list of associated :py:class:`.LMIInstance` objects :raises: :py:exc:`.LMIDeletedObjectError`
**Usage:** :ref:`associators_instances`. @@ -429,7 +429,7 @@ class LMIInstance(LMIWrapperBaseObject): ResultRole=None, IncludeQualifiers=False, IncludeClassOrigin=False, PropertyList=None): """ - Returns the first associated :py:class:`LMIInstance` with this object. + Returns the first associated :py:class:`.LMIInstance` with this object.
**NOTE:** If the method :py:meth:`.LMIInstance.delete` was called, this method will not execute its code and will return None. If the shell @@ -467,7 +467,7 @@ class LMIInstance(LMIWrapperBaseObject): elements for any 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. - :returns: first associated :py:class:`LMIInstance` + :returns: first associated :py:class:`.LMIInstance` :raises: :py:exc:`.LMIDeletedObjectError`
**Usage:** :ref:`associators_instances`. @@ -484,7 +484,7 @@ class LMIInstance(LMIWrapperBaseObject): @lmi_return_val_if_fail(lambda obj: obj._cim_instance.path, []) def reference_names(self, ResultClass=None, Role=None): """ - Returns a list of association :py:class:`LMIInstanceName` objects with + Returns a list of association :py:class:`.LMIInstanceName` objects with this object.
**NOTE:** If the method :py:meth:`.LMIInstance.delete` was called, this @@ -500,7 +500,7 @@ class LMIInstance(LMIWrapperBaseObject): name shall identify an object that refers to the target instance through a property with a name that matches the value of this parameter. - :returns: list of association :py:class:`LMIInstanceName` objects + :returns: list of association :py:class:`.LMIInstanceName` objects :raises: :py:exc:`.LMIDeletedObjectError`
**Usage:** :ref:`references_instance_names`. @@ -512,7 +512,7 @@ class LMIInstance(LMIWrapperBaseObject): @lmi_possibly_deleted(None) def first_reference_name(self, ResultClass=None, Role=None): """ - Returns the first association :py:class:`LMIInstanceName` with this + Returns the first association :py:class:`.LMIInstanceName` with this object.
**NOTE:** If the method :py:meth:`.LMIInstance.delete` was called, this @@ -528,7 +528,7 @@ class LMIInstance(LMIWrapperBaseObject): name shall identify an object that refers to the target instance through a property with a name that matches the value of this parameter. - :returns: first association :py:class:`LMIInstanceName` object + :returns: first association :py:class:`.LMIInstanceName` object :raises: :py:exc:`.LMIDeletedObjectError`
**Usage:** :ref:`references_instance_names`. @@ -544,7 +544,7 @@ class LMIInstance(LMIWrapperBaseObject): def references(self, ResultClass=None, Role=None, IncludeQualifiers=False, IncludeClassOrigin=False, PropertyList=None): """ - Returns a list of association :py:class:`LMIInstance` objects with this + Returns a list of association :py:class:`.LMIInstance` objects with this object.
**NOTE:** If the method :py:meth:`.LMIInstance.delete` was called, this @@ -572,7 +572,7 @@ class LMIInstance(LMIWrapperBaseObject): is an empty list, no properties are included in each returned object. If PropertyList is None, no additional filtering is defined. - :returns: list of association :py:class:`LMIInstance` objects + :returns: list of association :py:class:`.LMIInstance` objects :raises: :py:exc:`.LMIDeletedObjectError`
**Usage:** :ref:`references_instances`. @@ -587,7 +587,7 @@ class LMIInstance(LMIWrapperBaseObject): IncludeQualifiers=False, IncludeClassOrigin=False, PropertyList=None): """ - Returns the first association :py:class:`LMIInstance` with this object. + Returns the first association :py:class:`.LMIInstance` with this object.
**NOTE:** If the method :py:meth:`.LMIInstance.delete` was called, this method will not execute its code and will return None. If the shell @@ -614,7 +614,7 @@ class LMIInstance(LMIWrapperBaseObject): is an empty list, no properties are included in each returned object. If PropertyList is None, no additional filtering is defined. - :returns: first association :py:class:`LMIInstance` object + :returns: first association :py:class:`.LMIInstance` object :raises: :py:exc:`.LMIDeletedObjectError`
**Usage:** :ref:`references_instances`. @@ -738,17 +738,17 @@ class LMIInstance(LMIWrapperBaseObject): def refresh(self): """ Retrieves a new :py:class:`wbem.CIMInstance` object. Basically - refreshes the object properties. Returns :py:class:`LMIReturnValue` + refreshes the object properties. Returns :py:class:`.LMIReturnValue` with rval set to 0, if the wrapped :py:class:`wbem.CIMInstance` object was refreshed; otherwise rval is set to -1.
**NOTE:** If the method :py:meth:`.LMIInstance.delete` was called, this method will not execute its code and will return - :py:class:`LMIReturnValue` object containing -1 as a return value with + :py:class:`.LMIReturnValue` object containing -1 as a return value with proper error string set. If the shell uses exceptions, :py:exc:`.LMIDeletedObjectError` will be raised.
- :returns: :py:class:`LMIReturnValue` object with ``rval`` set to 0, if + :returns: :py:class:`.LMIReturnValue` object with ``rval`` set to 0, if refreshed; -1 otherwise :raises: :py:exc:`.LMIDeletedObjectError`
@@ -774,11 +774,11 @@ class LMIInstance(LMIWrapperBaseObject):
**NOTE:** If the method :py:meth:`.LMIInstance.delete` was called, this method will not execute its code and will return - :py:class:`LMIReturnValue` object containing False as a return value + :py:class:`.LMIReturnValue` object containing False as a return value with proper error string set. If the shell uses exceptions, :py:exc:`.LMIDeletedObjectError` will be raised.
- :returns: :py:class:`LMIReturnValue` object with ``rval`` set to True, if + :returns: :py:class:`.LMIReturnValue` object with ``rval`` set to True, if modified; False otherwise :raises: :py:exc:`.LMIDeletedObjectError`
diff --git a/cli/lmi/shell/LMIObjectFactory.py b/cli/lmi/shell/LMIObjectFactory.py index 3847673..e3c6156 100644 --- a/cli/lmi/shell/LMIObjectFactory.py +++ b/cli/lmi/shell/LMIObjectFactory.py @@ -41,7 +41,7 @@ class LMIObjectFactory(object):
def __new__(cls): """ - Creates a new :py:class:`LMIObjectFactory` instance, if not created, + Creates a new :py:class:`.LMIObjectFactory` instance, if not created, and returns the singleton instance object. """ if not cls._instance: diff --git a/cli/lmi/shell/LMIShellCache.py b/cli/lmi/shell/LMIShellCache.py index 385b9fb..33ee5e0 100644 --- a/cli/lmi/shell/LMIShellCache.py +++ b/cli/lmi/shell/LMIShellCache.py @@ -19,7 +19,7 @@ from lmi.shell.compat import * class LMIClassCacheEntry(object): """ Class used for storing :py:class:`wbem.CIMClass` in - :py:class:`LMIShellCache`. + :py:class:`.LMIShellCache`.
:param CIMClass cim_class: :py:class:`wbem.CIMClass` to cache :param bool full_fetch: True, if class is cached with qualifiers @@ -78,7 +78,7 @@ class LMIShellCache(object): :param string classname: cached class name :param string namespace: namespace storing cached classes :returns: cache object, if proper class name provided, None otherwise - :rtype: :py:class:`LMIClassCacheEntry` + :rtype: :py:class:`.LMIClassCacheEntry` """ if namespace not in self._class_dict or \ classname not in self._class_dict[namespace]: diff --git a/cli/lmi/shell/LMIShellConfig.py b/cli/lmi/shell/LMIShellConfig.py index cd472ae..ca6192e 100644 --- a/cli/lmi/shell/LMIShellConfig.py +++ b/cli/lmi/shell/LMIShellConfig.py @@ -23,7 +23,7 @@ class LMIShellConfig(object): loading the configuration from the file and provides a unified API to access these settings.
- Constructs a :py:class:`LMIShellConfig` object and loads the configuration + Constructs a :py:class:`.LMIShellConfig` object and loads the configuration from the file. If there is no such file, the shell's configuration properties are set to default values. Configuration file uses python syntax. If there is a syntax error in the configuration file, the
cura-tools-devel@lists.fedorahosted.org