Now documenting private members.

Author: malcolmmackay

docs/reference/decoder/index.rst

@@ -7,25 +7,25 @@ Decode a cuplcodec URL
 The decoder extracts a timestamped list of samples from a cuplcodec URL.
 
 .. automodule:: wscodec.decoder.decoderfactory
-    :members:
+    :private-members:
 
 .. inheritance-diagram:: wscodec.decoder.hdc2021.TempRH_URL wscodec.decoder.hdc2021.Temp_URL
    :parts: 2
 
 .. autoclass:: wscodec.decoder.hdc2021.TempRH_URL
-    :members:
+    :private-members:
 
 .. autoclass:: wscodec.decoder.hdc2021.Temp_URL
-    :members:
+    :private-members:
 
 .. autoclass:: wscodec.decoder.samples.SamplesURL
-    :members:
+    :private-members:
 
 .. autoclass:: wscodec.decoder.pairs.PairsURL
-    :members:
+    :private-members:
 
 .. automodule:: wscodec.decoder.circularbuffer
-    :members:
+    :private-members:
 
 Sample
 --------
@@ -34,24 +34,24 @@ Sample
    :parts: 2
 
 .. autoclass:: wscodec.decoder.hdc2021.TempRHSample
-    :members:
+    :private-members:
 
 .. autoclass:: wscodec.decoder.hdc2021.TempSample
-    :members:
+    :private-members:
 
 .. autoclass:: wscodec.decoder.samples.Sample
-    :members:
+    :private-members:
 
 Pair
 -----
 
 .. autoclass:: wscodec.decoder.pairs.Pair
-    :members:
+    :private-members:
 
 Status
 -------
 
 .. automodule:: wscodec.decoder.status
-    :members:
+    :private-members:
 
 

wscodec/decoder/circularbuffer.py

@@ -6,11 +6,11 @@
 
 class CircularBufferURL:
     """
-    t
+
     """
-    ELAPSED_LEN_BYTES = 4
-    ENDSTOP_LEN_BYTES = 16
-    ENDSTOP_BYTE = '~'  # This must be URL Safe
+    ELAPSED_LEN_BYTES = 4   #: Length of the endstop elapsed minutes field in bytes (including the endstop itself).
+    ENDSTOP_LEN_BYTES = 16  #: Length of the endstop in bytes.
+    ENDSTOP_BYTE = '~'      #: The last character in the endstop and the end of the circular buffer. Must be URL safe.
 
     def __init__(self, statb64: str, circb64: str = None):
         """

wscodec/decoder/pairs.py

@@ -7,15 +7,17 @@
 import hashlib
 import hmac
 
-BYTES_PER_PAIR = 3
-BYTES_PER_PAIRB64 = 4
-PAIRS_PER_DEMI = 2
-BYTES_PER_DEMI = BYTES_PER_PAIRB64 * PAIRS_PER_DEMI
+BYTES_PER_PAIR = 3                                      #: The number of bytes in each decoded Pair.
+BYTES_PER_PAIRB64 = 4                                   #: The number of bytes in each base64 encoded Pair.
+PAIRS_PER_DEMI = 2                                      #: The number of pairs in each 8-byte demi.
+BYTES_PER_DEMI = BYTES_PER_PAIRB64 * PAIRS_PER_DEMI     #: The number of bytes in each demi.
+
 
 class HashType(Enum):
     MD5 = 1
     HMAC_MD5 = 2
 
+
 class Pair:
     """
     Class representing a pair of 12-bit sensor readings.
@@ -100,23 +102,23 @@ def readings(self):
 
 
 class PairsURL(CircularBufferURL):
-    def __init__(self, *args, usehmac: bool = False, secretkey: str = None,  **kwargs):
-        """
-        This takes the payload of the linearised buffer, which is a long string of base64 characters. It decodes this
-        into a list of pairs. The hash (MD5 or HMAC-MD5) is taken and compared with that supplied in the URL by the
-        encoder. If the hashes match then the decode has been successful. If not, an exception is raised.
+    """
+    This takes the payload of the linearised buffer, which is a long string of base64 characters. It decodes this
+    into a list of pairs. The hash (MD5 or HMAC-MD5) is taken and compared with that supplied in the URL by the
+    encoder. If the hashes match then the decode has been successful. If not, an exception is raised.
 
-        Parameters
-        ----------
-        *args
-            Variable length argument list.
-        usehmac: bool
-            True if the hash inside the circular buffer endstop is HMAC-MD5. False if it is MD5.
-        secretkey: str
-            HMAC secret key as a string. Normally 16 characters long.
-        **kwargs
-            Keyword arguments to be passed to parent class constructors.
-        """
+    Parameters
+    ----------
+    *args
+        Variable length argument list.
+    usehmac: bool
+        True if the hash inside the circular buffer endstop is HMAC-MD5. False if it is MD5.
+    secretkey: str
+        HMAC secret key as a string. Normally 16 characters long.
+    **kwargs
+        Keyword arguments to be passed to parent class constructors.
+    """
+    def __init__(self, *args, usehmac: bool = False, secretkey: str = None,  **kwargs):
         super().__init__(*args, **kwargs)
 
         self._decode_pairs()