def ranges(self):
"""Get node ranges. An node can be restricted by a set of
ranges. For example, an integer can only be provided between
two values. For strings, the restriction is on the length of
the string.
The returned value can be `None` if no restriction on range
exists for the current node, a single value if the range is
fixed or a list of tuples or fixed values otherwise.
:return: The valid range for this node.
"""
t = _smi.smiGetNodeType(self.node)
if t == ffi.NULL:
return None
ranges = []
range = _smi.smiGetFirstRange(t)
while range != ffi.NULL:
m1 = self._convert(range.minValue)
m2 = self._convert(range.maxValue)
if m1 == m2:
ranges.append(m1)
else:
ranges.append((m1, m2))
range = _smi.smiGetNextRange(range)
if len(ranges) == 0:
return None
if len(ranges) == 1:
return ranges[0]
return ranges
def typeName(self, type_name):
"""Override the node's type to type_name, found using _getType.
The new type must resolve to the same basictype.
:param type_name: string name of the type.
"""
current_override = self._override_type
declared_type = _smi.smiGetNodeType(self.node)
declared_basetype = self.type
new_type = _getType(type_name)
if not new_type:
raise SMIException(
"no type named {0} in any loaded module".format(type_name))
# Easiest way to find the new basetype is to set the override
# and ask.
self._override_type = new_type
new_basetype = self.type
if declared_basetype != new_basetype:
self._override_type = current_override
raise SMIException("override type {1} not compatible with "
"basetype of {0}".format(
ffi.string(declared_type.name),
ffi.string(new_type.name)))
def ranges(self):
"""Get node ranges. An node can be restricted by a set of
ranges. For example, an integer can only be provided between
two values. For strings, the restriction is on the length of
the string.
The returned value can be `None` if no restriction on range
exists for the current node, a single value if the range is
fixed or a list of tuples or fixed values otherwise.
:return: The valid range for this node.
"""
t = _smi.smiGetNodeType(self.node)
if t == ffi.NULL:
return None
ranges = []
range = _smi.smiGetFirstRange(t)
while range != ffi.NULL:
m1 = self._convert(range.minValue)
m2 = self._convert(range.maxValue)
if m1 == m2:
ranges.append(m1)
else:
ranges.append((m1, m2))
range = _smi.smiGetNextRange(range)
if len(ranges) == 0:
return None
if len(ranges) == 1:
return ranges[0]
return ranges
def typeName(self, type_name):
"""Override the node's type to type_name, found using _getType.
The new type must resolve to the same basictype.
:param type_name: string name of the type.
"""
current_override = self._override_type
declared_type = _smi.smiGetNodeType(self.node)
declared_basetype = self.type
new_type = _getType(type_name)
if not new_type:
raise SMIException("no type named {0} in any loaded module".format(
type_name))
# Easiest way to find the new basetype is to set the override
# and ask.
self._override_type = new_type
new_basetype = self.type
if declared_basetype != new_basetype:
self._override_type = current_override
raise SMIException("override type {1} not compatible with "
"basetype of {0}".format(
ffi.string(declared_type.name),
ffi.string(new_type.name)))
def type(self):
"""Get the basic type associated with this node.
:return: The class from :mod:`basictypes` module which can
represent the node. When retrieving a valid value for
this node, the returned class can be instanciated to get
an appropriate representation.
"""
from snimpy import basictypes
if self._override_type:
t = self._override_type
else:
t = _smi.smiGetNodeType(self.node)
target = {
_smi.SMI_BASETYPE_INTEGER32: basictypes.Integer,
_smi.SMI_BASETYPE_INTEGER64: basictypes.Integer,
_smi.SMI_BASETYPE_UNSIGNED32: {b"TimeTicks": basictypes.Timeticks, None: basictypes.Unsigned32},
_smi.SMI_BASETYPE_UNSIGNED64: basictypes.Unsigned64,
_smi.SMI_BASETYPE_OCTETSTRING: {b"IpAddress": basictypes.IpAddress, None: basictypes.OctetString},
_smi.SMI_BASETYPE_OBJECTIDENTIFIER: basictypes.Oid,
_smi.SMI_BASETYPE_ENUM: {b"TruthValue": basictypes.Boolean, None: basictypes.Enum},
_smi.SMI_BASETYPE_BITS: basictypes.Bits,
}.get(t.basetype, None)
if isinstance(target, dict):
tt = _smi.smiGetParentType(t)
target = target.get(
(t.name != ffi.NULL and ffi.string(t.name)) or (tt.name != ffi.NULL and ffi.string(tt.name)) or None,
target.get(None, None),
)
if target is None:
raise SMIException("unable to retrieve type of node")
return target
def fmt(self):
"""Get node format. The node format is a string to use to display
a user-friendly version of the node. This is can be used for
both octet strings or integers (to make them appear as decimal
numbers).
:return: The node format as a string or None if there is no
format available.
"""
if self._override_type:
t = self._override_type
else:
t = _smi.smiGetNodeType(self.node)
tt = _smi.smiGetParentType(t)
f = (
t != ffi.NULL
and t.format != ffi.NULL
and ffi.string(t.format)
or tt != ffi.NULL
and tt.format != ffi.NULL
and ffi.string(tt.format)
) or None
if f is None:
return None
return f.decode("ascii")
def enum(self):
"""Get possible enum values. When the node can only take a discrete
number of values, those values are defined in the MIB and can
be retrieved through this property.
:return: The dictionary of possible values keyed by the integer value.
"""
t = _smi.smiGetNodeType(self.node)
if t == ffi.NULL or t.basetype not in (_smi.SMI_BASETYPE_ENUM, _smi.SMI_BASETYPE_BITS):
return None
result = {}
element = _smi.smiGetFirstNamedNumber(t)
while element != ffi.NULL:
result[self._convert(element.value)] = ffi.string(element.name).decode("ascii")
element = _smi.smiGetNextNamedNumber(element)
return result
def type(self):
"""Get the basic type associated with this node.
:return: The class from :mod:`basictypes` module which can
represent the node. When retrieving a valid value for
this node, the returned class can be instanciated to get
an appropriate representation.
"""
from snimpy import basictypes
if self._override_type:
t = self._override_type
else:
t = _smi.smiGetNodeType(self.node)
if t == ffi.NULL:
raise SMIException("unable to retrieve type of node")
target = {
_smi.SMI_BASETYPE_INTEGER32: basictypes.Integer,
_smi.SMI_BASETYPE_INTEGER64: basictypes.Integer,
_smi.SMI_BASETYPE_UNSIGNED32: {
b"TimeTicks": basictypes.Timeticks,
None: basictypes.Unsigned32
},
_smi.SMI_BASETYPE_UNSIGNED64: basictypes.Unsigned64,
_smi.SMI_BASETYPE_OCTETSTRING: {
b"IpAddress": basictypes.IpAddress,
None: basictypes.OctetString
},
_smi.SMI_BASETYPE_OBJECTIDENTIFIER: basictypes.Oid,
_smi.SMI_BASETYPE_ENUM: {
b"TruthValue": basictypes.Boolean,
None: basictypes.Enum
},
_smi.SMI_BASETYPE_BITS: basictypes.Bits
}.get(t.basetype, None)
if isinstance(target, dict):
tt = _smi.smiGetParentType(t)
target = target.get(
(t.name != ffi.NULL and ffi.string(t.name))
or (tt.name != ffi.NULL and ffi.string(tt.name)) or None,
target.get(None, None))
if target is None:
raise SMIException("unable to retrieve type of node")
return target
def enum(self):
"""Get possible enum values. When the node can only take a discrete
number of values, those values are defined in the MIB and can
be retrieved through this property.
:return: The dictionary of possible values keyed by the integer value.
"""
t = _smi.smiGetNodeType(self.node)
if t == ffi.NULL or t.basetype not in (_smi.SMI_BASETYPE_ENUM,
_smi.SMI_BASETYPE_BITS):
return None
result = {}
element = _smi.smiGetFirstNamedNumber(t)
while element != ffi.NULL:
result[self._convert(element.value)] = ffi.string(
element.name).decode("ascii")
element = _smi.smiGetNextNamedNumber(element)
return result
def typeName(self):
"""Retrieves the name of the the node's current declared type
(not basic type).
:return: A string representing the current declared type,
suitable for assignment to type.setter.
"""
if self._override_type:
t = self._override_type
else:
t = _smi.smiGetNodeType(self.node)
# This occurs when the type is "implied".
if t.name == ffi.NULL:
t = _smi.smiGetParentType(t)
if t is None or t == ffi.NULL:
raise SMIException("unable to retrieve the declared type " "of the node '{}'".format(self.node.name))
return ffi.string(t.name)
def fmt(self):
"""Get node format. The node format is a string to use to display
a user-friendly version of the node. This is can be used for
both octet strings or integers (to make them appear as decimal
numbers).
:return: The node format as a string or None if there is no
format available.
"""
if self._override_type:
t = self._override_type
else:
t = _smi.smiGetNodeType(self.node)
tt = _smi.smiGetParentType(t)
f = (t != ffi.NULL and t.format != ffi.NULL and ffi.string(t.format)
or tt != ffi.NULL and tt.format != ffi.NULL
and ffi.string(tt.format)) or None
if f is None:
return None
return f.decode("ascii")
def typeName(self):
"""Retrieves the name of the the node's current declared type
(not basic type).
:return: A string representing the current declared type,
suitable for assignment to type.setter.
"""
if self._override_type:
t = self._override_type
else:
t = _smi.smiGetNodeType(self.node)
# This occurs when the type is "implied".
if t.name == ffi.NULL:
t = _smi.smiGetParentType(t)
if t is None or t == ffi.NULL:
raise SMIException("unable to retrieve the declared type "
"of the node '{0}'".format(self.node.name))
return ffi.string(t.name)