workaround Sphinx bug with ivar references

sphinx-doc/sphinx#2549

Author: tomato42

tlslite/extensions.py

@@ -51,8 +51,8 @@ class TLSExtension(object):
     :ivar extType: a 2^16-1 limited integer specifying the type of the
         extension that it contains, e.g. 0 indicates server name extension
 
-    :vartype extData: bytearray
-    :ivar extData: a byte array containing the value of the extension as
+    :vartype ~.extData: bytearray
+    :ivar ~.extData: a byte array containing the value of the extension as
         to be written on the wire
 
     :vartype serverType: boolean
@@ -669,8 +669,8 @@ class SNIExtension(TLSExtension):
     :vartype extType: int
     :ivar extType: numeric type of SNIExtension, i.e. 0
 
-    :vartype extData: bytearray
-    :ivar extData: raw representation of the extension
+    :vartype ~.extData: bytearray
+    :ivar ~.extData: raw representation of the extension
     """
 
     ServerName = namedtuple('ServerName', 'name_type name')
@@ -853,8 +853,8 @@ class SupportedVersionsExtension(VarSeqListExtension):
     :vartype extType: int
     :ivar extType: numeric type of the Supported Versions extension, i.e. 43
 
-    :vartype extData: bytearray
-    :ivar extData: raw representation of the extension data
+    :vartype ~.extData: bytearray
+    :ivar ~.extData: raw representation of the extension data
 
     :vartype versions: list of tuples
     :ivar versions: list of supported protocol versions; each tuple has two
@@ -878,11 +878,11 @@ class SrvSupportedVersionsExtension(TLSExtension):
     :vartype extType: int
     :ivar extType: numeric type of the Supported Versions extension, i.e. 43
 
-    :vartype extData: bytearray
-    :ivar extData: raw representation of the extension payload
+    :vartype ~.extData: bytearray
+    :ivar ~.extData: raw representation of the extension payload
 
-    :vartype version: tuple
-    :ivar version: version selected by the server
+    :vartype ~.version: tuple
+    :ivar ~.version: version selected by the server
     """
 
     def __init__(self):
@@ -950,8 +950,8 @@ class ClientCertTypeExtension(VarListExtension):
     :vartype extType: int
     :ivar extType: numeric type of Certificate Type extension, i.e. 9
 
-    :vartype extData: bytearray
-    :ivar extData: raw representation of the extension data
+    :vartype ~.extData: bytearray
+    :ivar ~.extData: raw representation of the extension data
 
     :vartype certTypes: list of int
     :ivar certTypes: list of certificate type identifiers (each one byte long)
@@ -977,8 +977,8 @@ class ServerCertTypeExtension(IntExtension):
     :vartype extType: int
     :ivar extType: binary type of Certificate Type extension, i.e. 9
 
-    :vartype extData: bytearray
-    :ivar extData: raw representation of the extension data
+    :vartype ~.extData: bytearray
+    :ivar ~.extData: raw representation of the extension data
 
     :vartype cert_type: int
     :ivar cert_type: the certificate type selected by server
@@ -1014,8 +1014,8 @@ class SRPExtension(TLSExtension):
     :vartype extType: int
     :ivar extType: numeric type of SRPExtension, i.e. 12
 
-    :vartype extData: bytearray
-    :ivar extData: raw representation of extension data
+    :vartype ~.extData: bytearray
+    :ivar ~.extData: raw representation of extension data
 
     :vartype identity: bytearray
     :ivar identity: UTF-8 encoding of user name
@@ -1101,8 +1101,8 @@ class NPNExtension(TLSExtension):
     :vartype extType: int
     :ivar extType: numeric type of NPNExtension, i.e. 13172
 
-    :vartype extData: bytearray
-    :ivar extData: raw representation of extension data
+    :vartype ~.extData: bytearray
+    :ivar ~.extData: raw representation of extension data
     """
 
     def __init__(self):
@@ -1527,8 +1527,8 @@ class ALPNExtension(TLSExtension):
     :vartype extType: int
     :ivar extType: numberic type of ALPNExtension, i.e. 16
 
-    :vartype extData: bytearray
-    :ivar extData: raw encoding of the extension data
+    :vartype ~.extData: bytearray
+    :var ~.extData: raw encoding of the extension data
     """
 
     def __init__(self):

tlslite/messages.py

@@ -318,14 +318,14 @@ class ClientHello(HelloMessage):
     :vartype srp_username: bytearray
     :ivar srp_username: name of the user in SRP extension (deprecated)
 
-    :vartype supports_npn: boolean
-    :ivar supports_npn: NPN extension presence (deprecated)
+    :vartype ~.supports_npn: boolean
+    :ivar ~.supports_npn: NPN extension presence (deprecated)
 
-    :vartype tack: boolean
-    :ivar tack: TACK extension presence (deprecated)
+    :vartype ~.tack: boolean
+    :ivar ~.tack: TACK extension presence (deprecated)
 
-    :vartype server_name: bytearray
-    :ivar server_name: first host_name (type 0) present in SNI extension
+    :vartype ~.server_name: bytearray
+    :ivar ~.server_name: first host_name (type 0) present in SNI extension
         (deprecated)
 
     :vartype extensions: list of :py:class:`TLSExtension`
@@ -1620,8 +1620,8 @@ class ClientKeyExchange(HandshakeMsg):
 
     :vartype cipherSuite: int
     :ivar cipherSuite: the cipher suite id used for the connection
-    :vartype version: tuple(int, int)
-    :ivar version: TLS protocol version used for the connection
+    :vartype ~.version: tuple(int, int)
+    :ivar ~.version: TLS protocol version used for the connection
     :vartype srp_A: int
     :ivar srp_A: SRP protocol client answer value
     :vartype dh_Yc: int
@@ -2056,7 +2056,7 @@ class SessionTicketPayload(object):
     This is the internal (meant to be encrypted) representation of server
     state that is set to client in the NewSessionTicket message.
 
-    :ivar int version: implementation detail for forward compatibility
+    :ivar int ~.version: implementation detail for forward compatibility
     :ivar bytearray master_secret: master secret for TLS 1.2-, resumption
         master secret for TLS 1.3
 

tlslite/recordlayer.py

@@ -38,7 +38,7 @@ class RecordSocket(object):
     Socket wrapper for reading and writing TLS Records.
 
     :ivar sock: wrapped socket
-    :ivar version: version for the records to be encoded on the wire
+    :ivar ~.version: version for the records to be encoded on the wire
     :ivar tls13record: flag to indicate that TLS 1.3 specific record limits
         should be used for received records
     :ivar int recv_record_limit: negotiated maximum size of record plaintext
@@ -272,7 +272,7 @@ class RecordLayer(object):
     """
     Implementation of TLS record layer protocol
 
-    :ivar version: the TLS version to use (tuple encoded as on the wire)
+    :ivar ~.version: the TLS version to use (tuple encoded as on the wire)
     :ivar sock: underlying socket
     :ivar client: whether the connection should use encryption
     :ivar handshake_finished: used in SSL2, True if handshake protocol is over

tlslite/session.py

@@ -43,8 +43,8 @@ class Session(object):
     :vartype tackInHelloExt: bool
     :ivar tackInHelloExt: True if a TACK was presented via TLS Extension.
 
-    :vartype encryptThenMAC: bool
-    :ivar encryptThenMAC: True if connection uses CBC cipher in
+    :vartype ~.encryptThenMAC: bool
+    :ivar ~.encryptThenMAC: True if connection uses CBC cipher in
         encrypt-then-MAC mode
 
     :vartype appProto: bytearray

tlslite/tlsrecordlayer.py

@@ -48,8 +48,8 @@ class TLSRecordLayer(object):
         Due to TLS session resumption, multiple connections can correspond
         to the same underlying session.
 
-    :vartype version: tuple
-    :ivar version: The TLS version being used for this connection.
+    :vartype ~.version: tuple
+    :ivar ~.version: The TLS version being used for this connection.
         (3,0) means SSL 3.0, and (3,1) means TLS 1.0.
 
     :vartype closed: bool
@@ -89,8 +89,8 @@ class TLSRecordLayer(object):
         attacker truncating the connection, and only if necessary to avoid
         spurious errors.  The default is False.
 
-    :vartype encryptThenMAC: bool
-    :ivar encryptThenMAC: Whether the connection uses the encrypt-then-MAC
+    :vartype ~.encryptThenMAC: bool
+    :ivar ~.encryptThenMAC: Whether the connection uses the encrypt-then-MAC
         construct for CBC cipher suites, will be False also if connection uses
         RC4 or AEAD.