NonelessDict¶
About¶
NonelessDict
is a wrapper around dict that will check if a value is None
/empty/False
, and not add the key in that case.
The class has a method set_with_strict_none_check()
that can be used to set a value and check only for None
values.
NonelessOrderedDict
is based on NonelessDict
and OrderedDict
, so the order of key insertion is preserved.
API Reference¶
Provides NonelessDict.
Classes:
|
A wrapper around dict that will check if a value is |
|
A wrapper around OrderedDict that will check if a value is None/empty/False, and not add the key in that case. |
-
class
NonelessDict
(*args, **kwargs)[source]¶ Bases:
MutableBase
[~KT
,~VT
]A wrapper around dict that will check if a value is
None
/empty/False
, and not add the key in that case.Use the
set_with_strict_none_check()
method to check only forNone
.Methods:
__contains__
(key)Return
key in self
.__delitem__
(key)Delete
self[key]
.__eq__
(other)Return
self == other
.__getitem__
(key)Return
self[key]
.__iter__
()Iterates over the dictionary’s keys.
__len__
()Returns the number of keys in the dictionary.
__repr__
()Return a string representation of the
DictWrapper
.__setitem__
(key, value)Set
self[key]
tovalue
.clear
()copy
(**add_or_replace)Return a copy of the dictionary.
fromkeys
(iterable[, value])Create a new dictionary with keys from iterable and values set to value.
get
(k[, default])Return the value for
k
ifk
is in the dictionary, elsedefault
.items
()Returns a set-like object providing a view on the
bdict
's items.keys
()Returns a set-like object providing a view on the
bdict
's keys.pop
(k[,d])If key is not found, d is returned if given, otherwise KeyError is raised.
popitem
()as a 2-tuple; but raise KeyError if D is empty.
set_with_strict_none_check
(key, value)Set
key
in the dictionary tovalue
, but skippingNone
values.setdefault
(k[,d])update
([E, ]**F)If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v
values
()Returns an object providing a view on the
bdict
's values.-
__delitem__
(key)¶ Delete
self[key]
.
-
__getitem__
(key)¶ Return
self[key]
.- Parameters
key (
~KT
)- Return type
~VT
-
__repr__
()¶ Return a string representation of the
DictWrapper
.- Return type
-
clear
() → None. Remove all items from D.¶
-
classmethod
fromkeys
(iterable, value=None)¶ Create a new dictionary with keys from iterable and values set to value.
- Return type
MutableBase
[~KT
,~VT
]
-
get
(k, default=None)¶ Return the value for
k
ifk
is in the dictionary, elsedefault
.- Parameters
k – The key to return the value for.
default – The value to return if
key
is not in the dictionary. DefaultNone
.
-
items
()¶ Returns a set-like object providing a view on the
bdict
's items.- Return type
AbstractSet
[Tuple
[~KT
,~VT
]]
-
keys
()¶ Returns a set-like object providing a view on the
bdict
's keys.- Return type
AbstractSet
[~KT
]
-
pop
(k[, d]) → v, remove specified key and return the corresponding value.¶ If key is not found, d is returned if given, otherwise KeyError is raised.
-
popitem
() → (k, v), remove and return some (key, value) pair¶ as a 2-tuple; but raise KeyError if D is empty.
-
set_with_strict_none_check
(key, value)[source]¶ Set
key
in the dictionary tovalue
, but skippingNone
values.- Parameters
key (
~KT
)value (
Optional
[~VT
])
-
setdefault
(k[, d]) → D.get(k,d), also set D[k]=d if k not in D¶
-
update
([E, ]**F) → None. Update D from mapping/iterable E and F.¶ If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v
-
values
()¶ Returns an object providing a view on the
bdict
's values.- Return type
ValuesView
[~VT
]
-
-
class
NonelessOrderedDict
(*args, **kwargs)[source]¶ Bases:
MutableBase
[~KT
,~VT
]A wrapper around OrderedDict that will check if a value is None/empty/False, and not add the key in that case. Use the set_with_strict_none_check function to check only for None
Methods:
__contains__
(key)Return
key in self
.__delitem__
(key)Delete
self[key]
.__eq__
(other)Return
self == other
.__getitem__
(key)Return
self[key]
.__iter__
()Iterates over the dictionary’s keys.
__len__
()Returns the number of keys in the dictionary.
__repr__
()Return a string representation of the
DictWrapper
.__setitem__
(key, value)Set
self[key]
tovalue
.clear
()copy
(*args, **kwargs)Return a copy of the dictionary.
fromkeys
(iterable[, value])Create a new dictionary with keys from iterable and values set to value.
get
(k[, default])Return the value for
k
ifk
is in the dictionary, elsedefault
.items
()Returns a set-like object providing a view on the
bdict
's items.keys
()Returns a set-like object providing a view on the
bdict
's keys.pop
(k[,d])If key is not found, d is returned if given, otherwise KeyError is raised.
popitem
()as a 2-tuple; but raise KeyError if D is empty.
set_with_strict_none_check
(key, value)Set
key
in the dictionary tovalue
, but skippingNone
values.setdefault
(k[,d])update
([E, ]**F)If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v
values
()Returns an object providing a view on the
bdict
's values.-
__delitem__
(key)¶ Delete
self[key]
.
-
__getitem__
(key)¶ Return
self[key]
.- Parameters
key (
~KT
)- Return type
~VT
-
__repr__
()¶ Return a string representation of the
DictWrapper
.- Return type
-
clear
() → None. Remove all items from D.¶
-
classmethod
fromkeys
(iterable, value=None)¶ Create a new dictionary with keys from iterable and values set to value.
- Return type
MutableBase
[~KT
,~VT
]
-
get
(k, default=None)¶ Return the value for
k
ifk
is in the dictionary, elsedefault
.- Parameters
k – The key to return the value for.
default – The value to return if
key
is not in the dictionary. DefaultNone
.
-
items
()¶ Returns a set-like object providing a view on the
bdict
's items.- Return type
AbstractSet
[Tuple
[~KT
,~VT
]]
-
keys
()¶ Returns a set-like object providing a view on the
bdict
's keys.- Return type
AbstractSet
[~KT
]
-
pop
(k[, d]) → v, remove specified key and return the corresponding value.¶ If key is not found, d is returned if given, otherwise KeyError is raised.
-
popitem
() → (k, v), remove and return some (key, value) pair¶ as a 2-tuple; but raise KeyError if D is empty.
-
set_with_strict_none_check
(key, value)[source]¶ Set
key
in the dictionary tovalue
, but skippingNone
values.- Parameters
key (
~KT
)value (
Optional
[~VT
])
-
setdefault
(k[, d]) → D.get(k,d), also set D[k]=d if k not in D¶
-
update
([E, ]**F) → None. Update D from mapping/iterable E and F.¶ If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v
-
values
()¶ Returns an object providing a view on the
bdict
's values.- Return type
ValuesView
[~VT
]
-
Copyright¶
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.