space-packet-parser 4.0.2__tar.gz → 4.1.0__tar.gz

{space_packet_parser-4.0.2 → space_packet_parser-4.1.0}/CITATION.cff

@@ -1,7 +1,7 @@
 cff-version: 1.2.0
 title: 'space_packet_parser'
 type: software
-version: '4.0.2'
+version: '4.1.0'
 description: A CCSDS telemetry packet decoding library based on the XTCE packet format description standard.
 license: BSD-3-Clause
 abstract: The space_packet_parser Python library is a generalized, configurable packet decoding library for CCSDS telemetry
@@ -11,9 +11,9 @@ abstract: The space_packet_parser Python library is a generalized, configurable
     generator pattern. The binary string may originate from an in-memory bit stream, a buffered file reader opened in
     binary mode, or a python socket object; in every case, a small buffer is used to read chunks of data to ensure that
     memory usage is minimal. The space_packet_parser library supports robust error handling and is capable of skipping malformed
-    packet structures, unidentified packet structures, and can dynamically parse mixed APID packet streams. The
+    packet structures and unidentified packet structures and can dynamically parse mixed APID packet streams. The
     `Parser.generator` object supports keyword arguments for debugging such as the ability to return unraised parsing
-    errors, which contain
+    errors, which contain partial instances of parsed packet data to aid in debugging.
 authors:
 - email: gavin.medley@lasp.colorado.edu
   name: Gavin Medley

{space_packet_parser-4.0.2 → space_packet_parser-4.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: space-packet-parser
-Version: 4.0.2
+Version: 4.1.0
 Summary: A CCSDS telemetry packet decoding library based on the XTCE packet format description standard.
 Home-page: https://github.com/medley56/space_packet_parser
 License: BSD-3-Clause
@@ -16,12 +16,19 @@ Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
-Requires-Dist: bitstring (>=3.0.0,<5)
+Requires-Dist: bitstring (>=3.0.0,<4.2)
 Project-URL: Repository, https://github.com/medley56/space_packet_parser
 Description-Content-Type: text/markdown
 
-# Space Packet Parser - a configurable parser for CCSDS telemetry packets
-This is a package for decoding CCSDS telemetry packets according to an XTCE or CSV packet structure definition. 
+# Space Packet Parser
+
+----------
+![Test Status](https://github.com/medley56/space_packet_parser/actions/workflows/tests.yml/badge.svg)
+![Doc Status](https://readthedocs.org/projects/space-packet-parser/badge/?version=latest)
+
+Documentation: https://space-packet-parser.readthedocs.io/en/latest/
+
+Space Packet Parser is a package for decoding CCSDS telemetry packets according to an XTCE or CSV packet structure definition. 
 It is based on the UML model of the XTCE spec and aims to support all but the most esoteric elements of the 
 XTCE telemetry packet specification.
 
@@ -35,3 +42,4 @@ Resources:
 pip install space_packet_parser
 ```
 
+

{space_packet_parser-4.0.2 → space_packet_parser-4.1.0}/README.md

@@ -1,5 +1,12 @@
-# Space Packet Parser - a configurable parser for CCSDS telemetry packets
-This is a package for decoding CCSDS telemetry packets according to an XTCE or CSV packet structure definition. 
+# Space Packet Parser
+
+----------
+![Test Status](https://github.com/medley56/space_packet_parser/actions/workflows/tests.yml/badge.svg)
+![Doc Status](https://readthedocs.org/projects/space-packet-parser/badge/?version=latest)
+
+Documentation: https://space-packet-parser.readthedocs.io/en/latest/
+
+Space Packet Parser is a package for decoding CCSDS telemetry packets according to an XTCE or CSV packet structure definition. 
 It is based on the UML model of the XTCE spec and aims to support all but the most esoteric elements of the 
 XTCE telemetry packet specification.
 
@@ -12,3 +19,4 @@ Resources:
 ```bash
 pip install space_packet_parser
 ```
+

{space_packet_parser-4.0.2 → space_packet_parser-4.1.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "space_packet_parser"
-version = "4.0.2"
+version = "4.1.0"
 description = "A CCSDS telemetry packet decoding library based on the XTCE packet format description standard."
 license = "BSD-3-Clause"
 readme = "README.md"
@@ -35,7 +35,7 @@ keywords = [
 
 [tool.poetry.dependencies]
 python = ">=3.8,<3.12"
-bitstring = ">=3.0.0,<5"
+bitstring = ">=3.0.0,<4.2"
 
 [tool.poetry.group.dev.dependencies]
 pylint = "^2"
@@ -47,6 +47,7 @@ sphinx = "^6.1.3"
 myst-parser = "^1.0.0"
 sphinx-autoapi = "^2.0.1"
 sphinx-rtd-theme = "^1.2.0"
+coverage = "^7.2.5"
 
 [tool.poetry.group.examples]
 optional = true

{space_packet_parser-4.0.2 → space_packet_parser-4.1.0}/space_packet_parser/parser.py

@@ -401,6 +401,7 @@ class PacketParser:
         ccsds_headers_only : bool, Optional
             If True, only parses the packet headers (does not use the provided packet definition).
         yield_unrecognized_packet_errors : bool, Optional
+            Default False.
             If False, UnrecognizedPacketTypeErrors are caught silently and parsing continues to the next packet.
             If True, the generator will yield an UnrecognizedPacketTypeError in the event of an unrecognized
             packet. Note: These exceptions are not raised by default but are instead returned so that the generator
@@ -445,24 +446,29 @@ class PacketParser:
                 Number of bits added to the buffer. Note that the buffer may still have nonzero length from previous
                 data even when this returns zero.
             """
+            curser_pos = buffer.pos  # Keep track of the original buffer cursor location
             if isinstance(source, io.BufferedIOBase):
                 new_bytes = source.read(read_size_bytes)
                 buffer += new_bytes
-                return len(new_bytes)*8
-
-            if isinstance(source, socket.socket):
+                n_new_bits = len(new_bytes)*8
+            elif isinstance(source, socket.socket):
                 new_bytes = source.recv(read_size_bytes)
                 buffer += new_bytes  # Append BitStream with newly read bytes
-                return len(new_bytes)*8
-
-            if isinstance(source, bitstring.ConstBitStream):
+                n_new_bits = len(new_bytes)*8
+            elif isinstance(source, bitstring.ConstBitStream):
+                # This either reads read_size_bytes bytes or it just reads to the end of the data
                 new_bits = source[source.pos:source.pos + read_size_bytes * 8]
-                assert isinstance(new_bits, bitstring.ConstBitStream)
-                source.pos += len(new_bits)  # This way we never overshoot the end of the data
+                source.pos += len(new_bits)  # Set the source.pos to exactly where we read to
                 buffer += new_bits
-                return len(new_bits)
-
-            raise ValueError(f"Unrecognized data source: {source}")
+                n_new_bits = len(new_bits)
+            elif isinstance(source, io.TextIOWrapper):
+                raise IOError(f"Packet data file opened in TextIO mode. You must open packet data in binary mode.")
+            else:
+                raise IOError(f"Unrecognized data source: {source}")
+
+            # Reset buffer.pos to the original position before we extended it
+            buffer.pos = curser_pos
+            return n_new_bits
 
         # ========
         # Start of generator

space_packet_parser-4.0.2/setup.py

@@ -1,30 +0,0 @@
-# -*- coding: utf-8 -*-
-from setuptools import setup
-
-packages = \
-['space_packet_parser']
-
-package_data = \
-{'': ['*']}
-
-install_requires = \
-['bitstring>=3.0.0,<5']
-
-setup_kwargs = {
-    'name': 'space-packet-parser',
-    'version': '4.0.2',
-    'description': 'A CCSDS telemetry packet decoding library based on the XTCE packet format description standard.',
-    'long_description': '# Space Packet Parser - a configurable parser for CCSDS telemetry packets\nThis is a package for decoding CCSDS telemetry packets according to an XTCE or CSV packet structure definition. \nIt is based on the UML model of the XTCE spec and aims to support all but the most esoteric elements of the \nXTCE telemetry packet specification.\n\nResources:\n- [XTCE (Green Book - Informational Report)](https://public.ccsds.org/Pubs/660x2g2.pdf)\n- [XTCE Element Description (Green Book - Informational Report)](https://public.ccsds.org/Pubs/660x1g2.pdf)\n- [XTCE (Blue Book - Recommended Standard)](https://public.ccsds.org/Pubs/660x0b2.pdf)\n\n## Installation\n```bash\npip install space_packet_parser\n```\n',
-    'author': 'Gavin Medley',
-    'author_email': 'gavin.medley@lasp.colorado.edu',
-    'maintainer': 'Gavin Medley',
-    'maintainer_email': 'gavin.medley@lasp.colorado.edu',
-    'url': 'https://github.com/medley56/space_packet_parser',
-    'packages': packages,
-    'package_data': package_data,
-    'install_requires': install_requires,
-    'python_requires': '>=3.8,<3.12',
-}
-
-
-setup(**setup_kwargs)