Skip to content

Commit

Permalink
Docs: Explained WBEM URI instance path comparison
Browse files Browse the repository at this point in the history
Signed-off-by: Andreas Maier <maiera@de.ibm.com>
  • Loading branch information
andy-maier committed Jan 15, 2018
1 parent fcba132 commit 0b05668
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions pywbem/cim_obj.py
Original file line number Diff line number Diff line change
Expand Up @@ -2350,6 +2350,20 @@ def to_wbem_uri(self, omit_local_slash=False):
order of keybindings preserved, and the lexical case of keybinding
names preserved.
:term:`DSP0004` defines instance paths without a concept of order in
their keybindings, and that keybinding names in instance paths match
case-insensitively. Because the WBEM URI string returned by this method
preserves the order of keybindings (relative to how the keybindings
were first added to this object) and because the lexical case of the
keybinding names is also preserved, equality of WBEM URIs should *not*
be determined by comparing the returned WBEM URI strings. Instead,
compare :class:`~pywbem.CIMInstanceName` objects using the ``==``
operator, which performs the comparison at the logical level required
by DSP0004. If you have WBEM URI strings without the corresponding
:class:`~pywbem.CIMInstanceName` object, such an object can be created
by using the static method
:meth:`~pywbem.CIMInstanceName.from_wbem_uri`.
Parameters:
omit_local_slash (bool): Omit the leading slash in "local" WBEM URIs
Expand Down

0 comments on commit 0b05668

Please sign in to comment.