From da46736662eeee194ad7c31110df927e45e16ecf Mon Sep 17 00:00:00 2001 From: Ilya Etingof Date: Fri, 22 Feb 2019 09:30:26 +0100 Subject: Fix typos in the docstrings --- pysnmp/hlapi/v1arch/asyncore/ntforg.py | 1 - pysnmp/hlapi/v3arch/asyncio/cmdgen.py | 1 + pysnmp/hlapi/v3arch/asyncio/ntforg.py | 7 ------- pysnmp/hlapi/v3arch/asyncore/ntforg.py | 2 +- pysnmp/hlapi/v3arch/asyncore/sync/ntforg.py | 20 ++++++++++---------- pysnmp/hlapi/v3arch/twisted/ntforg.py | 2 +- pysnmp/smi/rfc1902.py | 6 +++--- 7 files changed, 16 insertions(+), 23 deletions(-) (limited to 'pysnmp') diff --git a/pysnmp/hlapi/v1arch/asyncore/ntforg.py b/pysnmp/hlapi/v1arch/asyncore/ntforg.py index 12917eb0..d68d87bc 100644 --- a/pysnmp/hlapi/v1arch/asyncore/ntforg.py +++ b/pysnmp/hlapi/v1arch/asyncore/ntforg.py @@ -86,7 +86,6 @@ def sendNotification(snmpDispatcher, authData, transportTarget, advised to maintain it for the lifecycle of the application/thread for as long as possible. - Returns ------- sendRequestHandle: int diff --git a/pysnmp/hlapi/v3arch/asyncio/cmdgen.py b/pysnmp/hlapi/v3arch/asyncio/cmdgen.py index c6b380df..89420cb2 100644 --- a/pysnmp/hlapi/v3arch/asyncio/cmdgen.py +++ b/pysnmp/hlapi/v3arch/asyncio/cmdgen.py @@ -500,6 +500,7 @@ def bulkCmd(snmpEngine, authData, transportTarget, contextData, for varBindTableRow in varBindTable] except Exception as e: future.set_exception(e) + else: future.set_result( (errorIndication, errorStatus, errorIndex, varBindsUnmade) diff --git a/pysnmp/hlapi/v3arch/asyncio/ntforg.py b/pysnmp/hlapi/v3arch/asyncio/ntforg.py index afc9875e..72efbfec 100644 --- a/pysnmp/hlapi/v3arch/asyncio/ntforg.py +++ b/pysnmp/hlapi/v3arch/asyncio/ntforg.py @@ -107,13 +107,6 @@ def sendNotification(snmpEngine, authData, transportTarget, contextData, Or its derivative indicating that an error occurred while performing SNMP operation. - Notes - ----- - The `sendNotification` generator will be exhausted immediately unless - an instance of :py:class:`~pysnmp.smi.rfc1902.NotificationType` class - or a sequence of :py:class:`~pysnmp.smi.rfc1902.ObjectType` `varBinds` - are send back into running generator (supported since Python 2.6). - Examples -------- >>> import asyncio diff --git a/pysnmp/hlapi/v3arch/asyncore/ntforg.py b/pysnmp/hlapi/v3arch/asyncore/ntforg.py index 779c4246..7df0bc08 100644 --- a/pysnmp/hlapi/v3arch/asyncore/ntforg.py +++ b/pysnmp/hlapi/v3arch/asyncore/ntforg.py @@ -82,7 +82,7 @@ def sendNotification(snmpEngine, authData, transportTarget, contextData, properly formed SNMP notification (to comply MIB definition). If you build notification PDU out of :py:class:`~pysnmp.smi.rfc1902.ObjectType` objects or simple tuples of OID-value objects, it is your responsibility - to provide well-formed notificaton payload. + to provide well-formed notification payload. Other Parameters ---------------- diff --git a/pysnmp/hlapi/v3arch/asyncore/sync/ntforg.py b/pysnmp/hlapi/v3arch/asyncore/sync/ntforg.py index e334eefd..2cff18df 100644 --- a/pysnmp/hlapi/v3arch/asyncore/sync/ntforg.py +++ b/pysnmp/hlapi/v3arch/asyncore/sync/ntforg.py @@ -19,19 +19,19 @@ def sendNotification(snmpEngine, authData, transportTarget, contextData, Parameters ---------- - snmpEngine : :py:class:`~pysnmp.hlapi.SnmpEngine` + snmpEngine: :py:class:`~pysnmp.hlapi.SnmpEngine` Class instance representing SNMP engine. - authData : :py:class:`~pysnmp.hlapi.CommunityData` or :py:class:`~pysnmp.hlapi.UsmUserData` + authData: :py:class:`~pysnmp.hlapi.CommunityData` or :py:class:`~pysnmp.hlapi.UsmUserData` Class instance representing SNMP credentials. - transportTarget : :py:class:`~pysnmp.hlapi.asyncore.UdpTransportTarget` or :py:class:`~pysnmp.hlapi.asyncore.Udp6TransportTarget` + transportTarget: :py:class:`~pysnmp.hlapi.asyncore.UdpTransportTarget` or :py:class:`~pysnmp.hlapi.asyncore.Udp6TransportTarget` Class instance representing transport type along with SNMP peer address. - contextData : :py:class:`~pysnmp.hlapi.ContextData` + contextData: :py:class:`~pysnmp.hlapi.ContextData` Class instance representing SNMP ContextEngineId and ContextName values. - notifyType : str + notifyType: str Indicates type of notification to be sent. Recognized literal values are *trap* or *inform*. @@ -71,7 +71,7 @@ def sendNotification(snmpEngine, authData, transportTarget, contextData, properly formed SNMP notification (to comply MIB definition). If you build notification PDU out of :py:class:`~pysnmp.smi.rfc1902.ObjectType` objects or simple tuples of OID-value objects, it is your responsibility - to provide well-formed notificaton payload. + to provide well-formed notification payload. Other Parameters ---------------- @@ -81,13 +81,13 @@ def sendNotification(snmpEngine, authData, transportTarget, contextData, Yields ------ - errorIndication : str + errorIndication: str True value indicates SNMP engine error. - errorStatus : str + errorStatus: str True value indicates SNMP PDU error. - errorIndex : int + errorIndex: int Non-zero value refers to `varBinds[errorIndex-1]` - varBinds : tuple + varBinds: tuple A sequence of :py:class:`~pysnmp.smi.rfc1902.ObjectType` class instances representing MIB variables returned in SNMP response. diff --git a/pysnmp/hlapi/v3arch/twisted/ntforg.py b/pysnmp/hlapi/v3arch/twisted/ntforg.py index 681579bb..5243c66f 100644 --- a/pysnmp/hlapi/v3arch/twisted/ntforg.py +++ b/pysnmp/hlapi/v3arch/twisted/ntforg.py @@ -83,7 +83,7 @@ def sendNotification(snmpEngine, authData, transportTarget, contextData, properly formed SNMP notification (to comply MIB definition). If you build notification PDU out of :py:class:`~pysnmp.smi.rfc1902.ObjectType` objects or simple tuples of OID-value objects, it is your responsibility - to provide well-formed notificaton payload. + to provide well-formed notification payload. Other Parameters ---------------- diff --git a/pysnmp/smi/rfc1902.py b/pysnmp/smi/rfc1902.py index ee32470d..9a3d4507 100644 --- a/pysnmp/smi/rfc1902.py +++ b/pysnmp/smi/rfc1902.py @@ -924,14 +924,14 @@ class NotificationType(object): Parameters ---------- - objectIdentity : :py:class:`~pysnmp.smi.rfc1902.ObjectIdentity` + objectIdentity: :py:class:`~pysnmp.smi.rfc1902.ObjectIdentity` Class instance representing MIB notification type identification. - instanceIndex : :py:class:`~pysnmp.proto.rfc1902.ObjectName` + instanceIndex: :py:class:`~pysnmp.proto.rfc1902.ObjectName` Trailing part of MIB variables OID identification that represents concrete instance of a MIB variable. When notification is prepared, `instanceIndex` is appended to each MIB variable identification listed in NOTIFICATION-TYPE->OBJECTS clause. - objects : dict + objects: dict Dictionary-like object that may return values by OID key. The `objects` dictionary is consulted when notification is being prepared. OIDs are taken from MIB variables listed in -- cgit v1.2.1