Fixes #1298 null value keybindings #1301
Conversation
KSchopmeyer
force-pushed
the
ks/#1298-null-keybindings
branch
from
d700af4
to
b459a91
Compare
|
It seems to me there is a general issue that we (I) don't understand yet, and that applies to all config variables: It seems that Given that we document to use the config variables in the We need to do some basic research on this and find a general solution. |
|
I agree. One more discussion item on the agenda. |
andy-maier
changed the title
|
We agreed to change the access methods for config. We will commit this change and andy will do the general change. |
|
I created issue #1302 for the general config variable update issue. This PR here can go on to set and read its new config variable through the |
pywbem/cim_obj.py
Outdated
| @@ -253,6 +253,7 @@ class (the parent object) has a list of CIM properties, CIM methods and CIM | |||
|
|
|||
| from . import cim_xml | |||
| from .config import DEBUG_WARNING_ORIGIN, SEND_VALUE_NULL | |||
| import pywbem.config | |||
There was a problem hiding this comment.
This should import from ., not from pywbem, to make sure it remains a relative import. In other words, this would become:
from . import config
and your new config variable would be accessed as:
config.IGNORE_NULL_KEY_VALUE
And just to be on the safe side, since you mentioned issues with from ... import ...:
>>> from pywbem import config
>>> import pywbem
>>> id(pywbem.config)
4439529464
>>> id(config)
4439529464
Both pywbem.config and config are bound to the same module object, so I don't see an issue with from ... import ....
pywbem/config.py
Outdated
| @@ -93,3 +93,17 @@ | |||
| #: | |||
| #: *New in pywbem 0.12.* | |||
| SEND_VALUE_NULL = True | |||
|
|
|||
| #: Backward compatibility option that controls creating CIMInstanceNames with | |||
There was a problem hiding this comment.
Instead of using plural on a class name, use a link on the class name:
... creating :class:`~pywbem.CIMInstanceName` objects with ...
pywbem/config.py
Outdated
| #: null values for keybindings. | ||
|
|
||
| #: :term:`DSP0004`, section 7.9 specifically forbids key properties with | ||
| #: no values but because pywbem has always allowed this, adding the code to |
There was a problem hiding this comment.
Instead of saying "with no values", I suggest to say "that are NULL".
pywbem/config.py
Outdated
| #: no values but because pywbem has always allowed this, adding the code to | ||
| #: disallow None as a keybinding value is an incompatible change. | ||
| #: | ||
| #: * True: Pywbem ignores None as a value when keybindings are defined. |
There was a problem hiding this comment.
It does not "ignore" None in this case, but "tolerates" it.
pywbem/config.py
Outdated
| #: disallow None as a keybinding value is an incompatible change. | ||
| #: | ||
| #: * True: Pywbem ignores None as a value when keybindings are defined. | ||
| #: * False (default): Pywbem generates ValueError when keybindings are created |
There was a problem hiding this comment.
Use back quotes around True, False, None.
pywbem/config.py
Outdated
| #: disallow None as a keybinding value is an incompatible change. | ||
| #: | ||
| #: * True: Pywbem ignores None as a value when keybindings are defined. | ||
| #: * False (default): Pywbem generates ValueError when keybindings are created |
There was a problem hiding this comment.
It does not "generate" ValueError, but "raises" ValueError. Also, use a link for ValueError.
Adds a new config variable IGNORE_NULL_KEY_VALUE that controls whether CIMInstanceName keybindings can set None as a key value. Adds test for this variable and adds comment to changes.rst. Added import pywbem.config to cim_obj.py to that we always get the original variable, not the copy made by from .config import ... That works. Marked this whole thing for Discussion
KSchopmeyer
force-pushed
the
ks/#1298-null-keybindings
branch
from
b459a91
to
7812c53
Compare
KSchopmeyer
changed the title
This is ready for review and merge. See commit for details