naming improvements

Author: robamu

src/cfdppy/exceptions.py

@@ -7,7 +7,7 @@
 from spacepackets.util import UnsignedByteField
 
 
-class NoRemoteEntityCfgFound(Exception):
+class NoRemoteEntityConfigFound(Exception):
     def __init__(self, entity_id: UnsignedByteField):
         super().__init__()
         self.remote_entity_id = entity_id
@@ -122,8 +122,10 @@ def __init__(self, packet: GenericPduPacket):
 class PduIgnoredForDestReason(enum.IntEnum):
     FIRST_PACKET_NOT_METADATA_PDU = 0
     """First packet received was not a metadata PDU for the unacknowledged mode."""
+
     INVALID_MODE_FOR_ACKED_MODE_PACKET = 1
     """The received PDU can only be handled in acknowledged mode."""
+
     FIRST_PACKET_IN_ACKED_MODE_NOT_METADATA_NOT_EOF_NOT_FD = 2
     """For the acknowledged mode, the first packet that was received with
     no metadata received previously was not a File Data PDU or EOF PDU."""

src/cfdppy/handler/dest.py

@@ -40,7 +40,7 @@
     InvalidDestinationId,
     InvalidPduDirection,
     InvalidPduForDestHandler,
-    NoRemoteEntityCfgFound,
+    NoRemoteEntityConfigFound,
     PduIgnoredForDest,
     PduIgnoredForDestReason,
     UnretrievedPdusToBeSent,
@@ -441,7 +441,7 @@ def _check_inserted_packet(self, packet: GenericPduPacket) -> None:
         if packet.dest_entity_id.value != self.cfg.local_entity_id.value:
             raise InvalidDestinationId(self.cfg.local_entity_id, packet.dest_entity_id)
         if self.remote_cfg_table.get_cfg(packet.source_entity_id) is None:
-            raise NoRemoteEntityCfgFound(entity_id=packet.dest_entity_id)
+            raise NoRemoteEntityConfigFound(entity_id=packet.dest_entity_id)
         if get_packet_destination(packet) == PacketDestination.SOURCE_HANDLER:
             raise InvalidPduForDestHandler(packet)
         if (self.states.state == CfdpState.IDLE) and (
@@ -514,12 +514,12 @@ def __idle_fsm(self, packet: GenericPduPacket | None) -> None:
         pdu_holder = PduHolder(packet)
         if pdu_holder.pdu_type == PduType.FILE_DATA:
             file_data_pdu = pdu_holder.to_file_data_pdu()
-            self._start_transaction_missing_metadata_recv_fd(file_data_pdu)
+            self._start_transaction_first_packet_file_data(file_data_pdu)
         else:
             assert pdu_holder.pdu_directive_type is not None
             if pdu_holder.pdu_directive_type == DirectiveType.EOF_PDU:
                 eof_pdu = pdu_holder.to_eof_pdu()
-                self._start_transaction_missing_metadata_recv_eof(eof_pdu)
+                self._start_transaction_first_packet_eof(eof_pdu)
             elif pdu_holder.pdu_directive_type == DirectiveType.METADATA_PDU:
                 metadata_pdu = pdu_holder.to_metadata_pdu()
                 self._start_transaction(metadata_pdu)
@@ -584,7 +584,7 @@ def _handle_first_packet_not_metadata_pdu(self, packet: GenericPduPacket) -> Non
                 packet,
             )
 
-    def _start_transaction_missing_metadata_recv_eof(self, eof_pdu: EofPdu) -> None:
+    def _start_transaction_first_packet_eof(self, eof_pdu: EofPdu) -> None:
         self._common_first_packet_not_metadata_pdu_handler(eof_pdu)
         self._handle_eof_without_previous_metadata(eof_pdu)
 
@@ -596,10 +596,7 @@ def _handle_eof_without_previous_metadata(self, eof_pdu: EofPdu) -> None:
         if self._params.fp.progress > 0:
             # Clear old list, deferred procedure for the whole file is now active.
             self._params.acked_params.lost_seg_tracker.reset()
-            # I will just wait until the metadata has been received with re-requesting the file
-            # data PDU. How does the standard expect me to process file data PDUs where I do not
-            # even know the filenames? How would I even generically do this? I will add the whole
-            # file to the lost segments map for now.
+            # Add the whole file to the lost segments map for now.
             self._params.acked_params.lost_seg_tracker.add_lost_segment((0, eof_pdu.file_size))
         if self.cfg.indication_cfg.eof_recv_indication_required:
             assert self._params.transaction_id is not None
@@ -622,9 +619,9 @@ def _eof_ack_pdu_done(self) -> None:
         self._checksum_verify()
         self.states.step = TransactionStep.TRANSFER_COMPLETION
 
-    def _start_transaction_missing_metadata_recv_fd(self, fd_pdu: FileDataPdu) -> None:
+    def _start_transaction_first_packet_file_data(self, fd_pdu: FileDataPdu) -> None:
         self._common_first_packet_not_metadata_pdu_handler(fd_pdu)
-        self._handle_fd_without_previous_metadata(fd_pdu)
+        self._handle_file_data_without_previous_metadata(fd_pdu)
 
     def _handle_finished_pdu_sent(self) -> None:
         if (
@@ -636,13 +633,10 @@ def _handle_finished_pdu_sent(self) -> None:
             return
         self._reset_internal(False)
 
-    def _handle_fd_without_previous_metadata(self, fd_pdu: FileDataPdu) -> None:
+    def _handle_file_data_without_previous_metadata(self, fd_pdu: FileDataPdu) -> None:
         self._params.fp.progress = fd_pdu.offset + len(fd_pdu.file_data)
         if len(fd_pdu.file_data) > 0:
-            # I will just wait until the metadata has been received with re-requesting the file
-            # data PDU. How does the standard expect me to process file data PDUs where I do not
-            # even know the filenames? How would I even generically do this?
-            # I will add this file segment (and all others which came before and might be missing
+            # Add this file segment (and all others which came before and might be missing
             # as well) to the lost segment list.
             self._params.acked_params.lost_seg_tracker.add_lost_segment(
                 (0, self._params.fp.progress)
@@ -707,7 +701,7 @@ def _handle_metadata_packet(self, metadata_pdu: MetadataPdu) -> None:
             _LOGGER.warning(
                 f"No remote configuration found for remote ID {metadata_pdu.dest_entity_id}"
             )
-            raise NoRemoteEntityCfgFound(metadata_pdu.dest_entity_id)
+            raise NoRemoteEntityConfigFound(metadata_pdu.dest_entity_id)
         if not self._params.fp.metadata_only:
             self.states.step = TransactionStep.RECEIVING_FILE_DATA
             self._init_vfs_handling(Path(metadata_pdu.source_file_name).name)  # type: ignore
@@ -760,7 +754,7 @@ def _handle_waiting_for_missing_metadata(self, packet_holder: PduHolder) -> None
         if packet_holder.pdu is None:
             return
         if packet_holder.pdu_type == PduType.FILE_DATA:
-            self._handle_fd_without_previous_metadata(packet_holder.to_file_data_pdu())
+            self._handle_file_data_without_previous_metadata(packet_holder.to_file_data_pdu())
         elif packet_holder.pdu_directive_type == DirectiveType.METADATA_PDU:
             self._handle_metadata_packet(packet_holder.to_metadata_pdu())
             if self._params.acked_params.deferred_lost_segment_detection_active:

src/cfdppy/handler/source.py

@@ -50,7 +50,7 @@
     InvalidPduForSourceHandler,
     InvalidSourceId,
     InvalidTransactionSeqNum,
-    NoRemoteEntityCfgFound,
+    NoRemoteEntityConfigFound,
     PduIgnoredForSource,
     PduIgnoredForSourceReason,
     SourceFileDoesNotExist,
@@ -345,7 +345,7 @@ def put_request(self, request: PutRequest) -> bool:
             assert isinstance(self._put_req.dest_file, Path)
         self._params.remote_cfg = self.remote_cfg_table.get_cfg(request.destination_id)
         if self._params.remote_cfg is None:
-            raise NoRemoteEntityCfgFound(entity_id=request.destination_id)
+            raise NoRemoteEntityConfigFound(entity_id=request.destination_id)
         self._params.dest_id = request.destination_id
         self.states._num_packets_ready = 0
         self.states.state = CfdpState.BUSY
@@ -391,7 +391,7 @@ def _check_inserted_packet(self, packet: AbstractFileDirectiveBase) -> None:
         # TODO: This can happen if a packet is received for which no transaction was started..
         #       A better exception might be worth a thought..
         if self._params.remote_cfg is None:
-            raise NoRemoteEntityCfgFound(entity_id=packet.dest_entity_id)
+            raise NoRemoteEntityConfigFound(entity_id=packet.dest_entity_id)
         if packet.dest_entity_id.value != self._params.remote_cfg.entity_id.value:
             raise InvalidDestinationId(self._params.remote_cfg.entity_id, packet.dest_entity_id)
 

tests/test_dest_handler_naked.py

@@ -26,7 +26,7 @@
     RemoteEntityCfgTable,
 )
 from cfdppy.defs import CfdpState
-from cfdppy.exceptions import NoRemoteEntityCfgFound
+from cfdppy.exceptions import NoRemoteEntityConfigFound
 from cfdppy.handler.dest import (
     DestHandler,
     PduIgnoredForDest,
@@ -122,7 +122,7 @@ def test_remote_cfg_does_not_exist(self):
         )
         file_transfer_init = MetadataPdu(params=metadata_params, pdu_conf=self.src_pdu_conf)
         self._state_checker(None, False, CfdpState.IDLE, TransactionStep.IDLE)
-        with self.assertRaises(NoRemoteEntityCfgFound):
+        with self.assertRaises(NoRemoteEntityConfigFound):
             self.dest_handler.state_machine(file_transfer_init)
 
     def test_check_timer_mechanism(self):