Merge pull request #13 from icgood/doc

Fix generated API doc issues

Author: icgood

doc/source/proxyprotocol.rst

@@ -47,6 +47,13 @@
 .. automodule:: proxyprotocol.result
    :members:
 
+``proxyprotocol.tlv``
+----------------------
+
+.. automodule:: proxyprotocol.tlv
+   :members:
+   :undoc-members:
+
 ``proxyprotocol.sock``
 ----------------------
 

proxyprotocol/__init__.py

@@ -135,7 +135,7 @@ def build(self, source: Address, dest: Address, *, family: AddressFamily,
             protocol: The original socket protocol.
             ssl: The original socket SSL information.
             unique_id: The original connection unique identifier.
-            proxied: True if the connection should not be considered proxied.
+            proxied: True if the connection should be considered proxied.
 
         Raises:
             :exc:`KeyError`: This PROXY protocol header format does not support

proxyprotocol/sock.py

@@ -18,10 +18,6 @@ class SocketInfo:
     """Provides information about the connection, from either the underlying
     :mod:`asyncio` transport layer or overridden by the PROXY protocol result.
 
-    Undocumented properties will pass through as calls to
-    :meth:`~asyncio.BaseTransport.get_extra_info` and will raise
-    :exc:`AttributeError` if there is no value available.
-
     Args:
         transport: The :class:`~asyncio.BaseTransport` or
             :class:`~asyncio.StreamWriter` for the connection.
@@ -96,23 +92,23 @@ def sockname(self) -> Address:
     @property
     def sockname_ip(self) -> Union[None, IPv4Address, IPv6Address]:
         """The IP address object from :attr:`.sockname`, for
-        :attr:`~socket.AF_INET` or :attr:`~socket.AF_INET6` connections.
+        :data:`~socket.AF_INET` or :data:`~socket.AF_INET6` connections.
 
         """
         return self._get_ip(self.sockname)
 
     @property
     def sockname_port(self) -> Optional[int]:
         """The port number from :attr:`.sockname`, for
-        :attr:`~socket.AF_INET` or :attr:`~socket.AF_INET6` connections.
+        :data:`~socket.AF_INET` or :data:`~socket.AF_INET6` connections.
 
         """
         return self._get_port(self.sockname)
 
     @property
     def sockname_str(self) -> Optional[str]:
         """The :attr:`.sockname` address as a string. For
-        :attr:`~socket.AF_INET`/:attr:`~socket.AF_INET6` families, this is
+        :data:`~socket.AF_INET`/:data:`~socket.AF_INET6` families, this is
         ``ip:port``.
 
         """
@@ -136,23 +132,23 @@ def peername(self) -> Address:
     @property
     def peername_ip(self) -> Union[None, IPv4Address, IPv6Address]:
         """The IP address object from :attr:`.peername`, for
-        :attr:`~socket.AF_INET` or :attr:`~socket.AF_INET6` connections.
+        :data:`~socket.AF_INET` or :data:`~socket.AF_INET6` connections.
 
         """
         return self._get_ip(self.peername)
 
     @property
     def peername_port(self) -> Optional[int]:
         """The port number from :attr:`.peername`, for
-        :attr:`~socket.AF_INET` or :attr:`~socket.AF_INET6` connections.
+        :data:`~socket.AF_INET` or :data:`~socket.AF_INET6` connections.
 
         """
         return self._get_port(self.peername)
 
     @property
     def peername_str(self) -> Optional[str]:
         """The :attr:`.peername` address as a string. For
-        :attr:`~socket.AF_INET`/:attr:`~socket.AF_INET6` families, this is
+        :data:`~socket.AF_INET`/:data:`~socket.AF_INET6` families, this is
         ``ip:port``.
 
         """
@@ -254,11 +250,11 @@ def unique_id(self) -> bytes:
     def from_localhost(self) -> bool:
         """True for local socket connections, if:
 
-        * :attr:`.family` is :attr:`~socket.AF_UNIX`, or
+        * :attr:`.family` is :data:`~socket.AF_UNIX`, or
         * :attr:`.peername_ip` has True
           :attr:`~ipaddress.IPv4Address.is_loopback` flag.
 
-        To be specific, True for :attr:`~socket.AF_UNIX` connections and True
+        To be specific, True for :data:`~socket.AF_UNIX` connections and True
         for IPv4/IPv6 connections with True
         :attr:`~ipaddress.IPv4Address.is_loopback` flags.
 

proxyprotocol/tlv.py

@@ -11,7 +11,7 @@
 from .typing import PeerCert
 
 __all__ = ['Type', 'SSLClient', 'TLV', 'ProxyProtocolTLV',
-           'ProxyProtocolSSLTLV']
+           'ProxyProtocolSSLTLV', 'ProxyProtocolExtTLV']
 
 
 class Type(IntEnum):
@@ -209,12 +209,7 @@ def netns(self) -> Optional[str]:
 
     @property
     def ext(self) -> ProxyProtocolExtTLV:
-        """The ``PP2_TYPE_NOOP`` value, possibly parsed as an extension TLV.
-
-        See Also:
-            :class:`ProxyProtocolExtTLV`
-
-        """
+        """The ``PP2_TYPE_NOOP`` value, possibly parsed as an extension TLV."""
         val = self.get(Type.PP2_TYPE_NOOP)
         if val is not None:
             return ProxyProtocolExtTLV(val)
@@ -381,6 +376,8 @@ class ProxyProtocolExtTLV(TLV):
 
     """
 
+    #: The ``PP2_TYPE_NOOP`` value must begin with this byte sequence to be
+    #: parsed as a :class:`ProxyProtocolExtTLV`.
     MAGIC_PREFIX: ClassVar[bytes] = b'\x88\x1b\x79\xc1\xce\x96\x85\xb0'
 
     _secret_bits_fmt = Struct('!H')
@@ -416,7 +413,7 @@ def _pack(self) -> bytes:
     @property
     def compression(self) -> Optional[str]:
         """The ``PP2_SUBTYPE_EXT_COMPRESSION`` value. This is used by the
-        :attr:`~proxyprotocol.sock.SockInfo.compression` value.
+        :attr:`~proxyprotocol.sock.SocketInfo.compression` value.
 
         """
         val = self.get(Type.PP2_SUBTYPE_EXT_COMPRESSION)
@@ -427,7 +424,7 @@ def compression(self) -> Optional[str]:
     @property
     def secret_bits(self) -> Optional[int]:
         """The ``PP2_SUBTYPE_EXT_SECRET_BITS`` value. This is used to populate
-        the third member of the: attr: `~proxyprotocol.sock.SockInfo.cipher`
+        the third member of the: attr:`~proxyprotocol.sock.SocketInfo.cipher`
         tuple.
 
         """
@@ -440,7 +437,7 @@ def secret_bits(self) -> Optional[int]:
     @property
     def peercert(self) -> Optional[PeerCert]:
         """The ``PP2_SUBTYPE_EXT_PEERCERT`` value. This is used by the
-        :attr:`~proxyprotocol.sock.SockInfo.peercert` value.
+        :attr:`~proxyprotocol.sock.SocketInfo.peercert` value.
 
         """
         val = self.get(Type.PP2_SUBTYPE_EXT_PEERCERT)

proxyprotocol/v2.py

@@ -164,7 +164,7 @@ def build_header(self, data_len: int, *,
             data_len: The length of the data (addresses + TLV).
             family: The original socket family.
             protocol: The original socket protocol.
-            proxied: True if the connection should not be considered proxied.
+            proxied: True if the connection should be considered proxied.
 
         """
         byte_12 = 0x20 + self._commands_r['proxy' if proxied else 'local']

setup.py

@@ -28,7 +28,7 @@
     license = f.read()
 
 setup(name='proxy-protocol',
-      version='0.5.3',
+      version='0.5.4',
       author='Ian Good',
       author_email='[email protected]',
       description='PROXY protocol library with asyncio server implementation',