MNT: Update documentation/changelog for generic packet interface

Author: greglucas

docs/source/changelog.md

@@ -14,8 +14,8 @@ Release notes for the `space_packet_parser` library
 - Add support for creating a packet definition from Python objects and serializing it as XML.
 - BUGFIX: Fix kbps calculation in packet generator for showing progress.
 - Add support for string and float encoded enumerated lookup parameters.
-- Add properties to extract the CCSDS Header items from the ``RawPacketData`` object directly.
-  e.g. ``RawPacketData.apid``
+- Add properties to extract the CCSDS Header items from the ``CCSDSPacketBytes`` object directly.
+  e.g. ``CCSDSPacketBytes.apid``
 - Add a ``create_ccsds_packet`` function that can create a CCSDS Packet
   with the given header items and data. This is useful for creating
   mock packets in testing and experimentation for creating debugging

docs/source/users.md

@@ -45,7 +45,7 @@ We aim to provide examples of usage patterns. Please see the `examples` director
 a specific example you want to see demonstrated, please open a GitHub Issue or Discussion for support.
 
 ## Packet Objects
-The object returned from the `packet_generator` is a `CCSDSPacket` (unless you're yielding parsing
+The object returned from the `packet_generator` is a `Packet` (unless you're yielding parsing
 exceptions for debugging). This object subclasses a python dictionary and behaves as a dictionary. To retrieve
 a parameter value from the yielded packet, you can iterate over its `items()` or you can access individual parameters
 by name.

space_packet_parser/packets.py

@@ -282,7 +282,10 @@ class to extract the header fields with specific methods.
     make up the user data (accessed with ``CCSDSPacket.user_data``). To access the
     raw bytes of the packet, use the ``CCSDSPacket.raw_data`` attribute.
     """
-    pass
+    def __init__(self, *args, **kwargs):
+        warnings.warn("The CCSDSPacket class is deprecated and will be removed in a future release. "
+                    "Use the Packet class instead (no CCSDS prefix).")
+        super().__init__(*args, **kwargs)
 
 
 def ccsds_generator(

tests/unit/test_packets.py

@@ -127,7 +127,8 @@ def test_packet_data_lookups():
 def test_ccsds_packet_data_lookups():
     # Deprecated CCSDSPacket class, an instance of the new Packet class
     # can be removed in a future version
-    assert isinstance(packets.CCSDSPacket(), packets.Packet)
+    with pytest.warns(UserWarning, match="The CCSDSPacket class is deprecated"):
+        assert isinstance(packets.CCSDSPacket(), packets.Packet)
 
 
 def test_continuation_packets(test_data_dir):