Merge pull request #44 from us-irs/avoid-cfg-abbreviation

avoid cfg abbreviation

Author: robamu

CHANGELOG.md

@@ -15,6 +15,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 - `TransactionStep.SENDING_ACK_OF_FINISHED` for source handler which is not required anymore.
 
+## Changed
+
+- Replaced `*Cfg*` abbreviation with `*Config*`
+
 # [v0.5.1] 2025-02-10
 
 - Bump allowed `spacepackets` to v0.28.0

examples/cfdp-cli-udp/common.py

@@ -37,8 +37,8 @@
     CheckTimerProvider,
     DefaultFaultHandlerBase,
     EntityType,
-    IndicationCfg,
-    RemoteEntityCfg,
+    IndicationConfig,
+    RemoteEntityConfig,
 )
 from cfdppy.user import (
     CfdpUserBase,
@@ -58,13 +58,13 @@
 LOCAL_ENTITY_ID = ByteFieldU16(1)
 REMOTE_ENTITY_ID = ByteFieldU16(2)
 # Enable all indications for both local and remote entity.
-INDICATION_CFG = IndicationCfg()
+INDICATION_CFG = IndicationConfig()
 
 FILE_CONTENT = "Hello World!\n"
 FILE_SEGMENT_SIZE = 256
 MAX_PACKET_LEN = 512
 
-REMOTE_CFG_OF_LOCAL_ENTITY = RemoteEntityCfg(
+REMOTE_CFG_OF_LOCAL_ENTITY = RemoteEntityConfig(
     entity_id=LOCAL_ENTITY_ID,
     max_packet_len=MAX_PACKET_LEN,
     max_file_segment_len=FILE_SEGMENT_SIZE,

examples/cfdp-cli-udp/local.py

@@ -36,8 +36,8 @@
 from cfdppy.handler.dest import DestHandler
 from cfdppy.handler.source import SourceHandler
 from cfdppy.mib import (
-    LocalEntityCfg,
-    RemoteEntityCfgTable,
+    LocalEntityConfig,
+    RemoteEntityConfigTable,
 )
 
 _LOGGER = logging.getLogger(__name__)
@@ -80,7 +80,7 @@ def main() -> None:
 
     basicConfig(level=logging_level)
 
-    remote_cfg_table = RemoteEntityCfgTable()
+    remote_cfg_table = RemoteEntityConfigTable()
     remote_cfg_table.add_config(REMOTE_CFG_OF_REMOTE_ENTITY)
 
     src_fault_handler = CfdpFaultHandler(BASE_STR_SRC)
@@ -89,7 +89,7 @@ def main() -> None:
     src_user = CfdpUser(BASE_STR_SRC, PUT_REQ_QUEUE)
     check_timer_provider = CustomCheckTimerProvider()
     source_handler = SourceHandler(
-        cfg=LocalEntityCfg(LOCAL_ENTITY_ID, INDICATION_CFG, src_fault_handler),
+        cfg=LocalEntityConfig(LOCAL_ENTITY_ID, INDICATION_CFG, src_fault_handler),
         seq_num_provider=src_seq_count_provider,
         remote_cfg_table=remote_cfg_table,
         user=src_user,
@@ -109,7 +109,7 @@ def main() -> None:
     dest_fault_handler = CfdpFaultHandler(BASE_STR_DEST)
     dest_user = CfdpUser(BASE_STR_DEST, PUT_REQ_QUEUE)
     dest_handler = DestHandler(
-        cfg=LocalEntityCfg(LOCAL_ENTITY_ID, INDICATION_CFG, dest_fault_handler),
+        cfg=LocalEntityConfig(LOCAL_ENTITY_ID, INDICATION_CFG, dest_fault_handler),
         user=dest_user,
         remote_cfg_table=remote_cfg_table,
         check_timer_provider=check_timer_provider,

examples/cfdp-cli-udp/remote.py

@@ -25,8 +25,8 @@
 from cfdppy.handler.dest import DestHandler
 from cfdppy.handler.source import SourceHandler
 from cfdppy.mib import (
-    LocalEntityCfg,
-    RemoteEntityCfgTable,
+    LocalEntityConfig,
+    RemoteEntityConfigTable,
 )
 
 _LOGGER = logging.getLogger(__name__)
@@ -62,11 +62,11 @@ def main() -> None:
     # 16 bit sequence count for transactions.
     src_seq_count_provider = SeqCountProvider(16)
     src_user = CfdpUser(BASE_STR_SRC, PUT_REQ_QUEUE)
-    remote_cfg_table = RemoteEntityCfgTable()
+    remote_cfg_table = RemoteEntityConfigTable()
     remote_cfg_table.add_config(REMOTE_CFG_OF_LOCAL_ENTITY)
     check_timer_provider = CustomCheckTimerProvider()
     source_handler = SourceHandler(
-        cfg=LocalEntityCfg(REMOTE_ENTITY_ID, INDICATION_CFG, src_fault_handler),
+        cfg=LocalEntityConfig(REMOTE_ENTITY_ID, INDICATION_CFG, src_fault_handler),
         user=src_user,
         remote_cfg_table=remote_cfg_table,
         check_timer_provider=check_timer_provider,
@@ -86,7 +86,7 @@ def main() -> None:
     dest_fault_handler = CfdpFaultHandler(BASE_STR_DEST)
     dest_user = CfdpUser(BASE_STR_DEST, PUT_REQ_QUEUE)
     dest_handler = DestHandler(
-        cfg=LocalEntityCfg(REMOTE_ENTITY_ID, INDICATION_CFG, dest_fault_handler),
+        cfg=LocalEntityConfig(REMOTE_ENTITY_ID, INDICATION_CFG, dest_fault_handler),
         user=dest_user,
         remote_cfg_table=remote_cfg_table,
         check_timer_provider=check_timer_provider,

examples/cfdp-libre-cube-crosstest/common.py

@@ -1,7 +1,7 @@
 from spacepackets.cfdp import ChecksumType, TransmissionMode
 from spacepackets.util import ByteFieldU16
 
-from cfdppy.mib import RemoteEntityCfg
+from cfdppy.mib import RemoteEntityConfig
 
 SOURCE_ENTITY_ID = 2
 REMOTE_ENTITY_ID = 3
@@ -12,7 +12,7 @@
 FILE_SEGMENT_SIZE = 128
 MAX_PACKET_LEN = 512
 
-REMOTE_CFG_FOR_DEST_ENTITY = RemoteEntityCfg(
+REMOTE_CFG_FOR_DEST_ENTITY = RemoteEntityConfig(
     entity_id=ByteFieldU16(REMOTE_ENTITY_ID),
     max_packet_len=MAX_PACKET_LEN,
     max_file_segment_len=FILE_SEGMENT_SIZE,

examples/cfdp-libre-cube-crosstest/tmtccmd-client.py

@@ -36,9 +36,9 @@
     CheckTimerProvider,
     DefaultFaultHandlerBase,
     EntityType,
-    IndicationCfg,
-    LocalEntityCfg,
-    RemoteEntityCfgTable,
+    IndicationConfig,
+    LocalEntityConfig,
+    RemoteEntityConfigTable,
 )
 from cfdppy.request import PutRequest
 from cfdppy.user import (
@@ -217,12 +217,12 @@ def main() -> None:
     with open(SOURCE_FILE, "w") as file:
         file.write(FILE_CONTENT)
 
-    remote_cfg_table = RemoteEntityCfgTable([REMOTE_CFG_FOR_DEST_ENTITY])
+    remote_cfg_table = RemoteEntityConfigTable([REMOTE_CFG_FOR_DEST_ENTITY])
 
     # Enable all indications.
-    src_indication_cfg = IndicationCfg()
+    src_indication_cfg = IndicationConfig()
     src_fault_handler = CfdpFaultHandler()
-    src_entity_cfg = LocalEntityCfg(SOURCE_ENTITY_ID, src_indication_cfg, src_fault_handler)
+    src_entity_cfg = LocalEntityConfig(SOURCE_ENTITY_ID, src_indication_cfg, src_fault_handler)
     # 16 bit sequence count for transactions.
     src_seq_count_provider = SeqCountProvider(16)
     src_user = CfdpUser("SRC ENTITY")

examples/cfdp-simple/file-copy-example.py

@@ -33,10 +33,10 @@
     CheckTimerProvider,
     DefaultFaultHandlerBase,
     EntityType,
-    IndicationCfg,
-    LocalEntityCfg,
-    RemoteEntityCfg,
-    RemoteEntityCfgTable,
+    IndicationConfig,
+    LocalEntityConfig,
+    RemoteEntityConfig,
+    RemoteEntityConfigTable,
 )
 from cfdppy.request import PutRequest
 from cfdppy.user import (
@@ -67,7 +67,7 @@ class TransferParams:
 _LOGGER = logging.getLogger()
 
 
-REMOTE_CFG_FOR_SOURCE_ENTITY = RemoteEntityCfg(
+REMOTE_CFG_FOR_SOURCE_ENTITY = RemoteEntityConfig(
     entity_id=SOURCE_ENTITY_ID,
     max_packet_len=MAX_PACKET_LEN,
     max_file_segment_len=FILE_SEGMENT_SIZE,
@@ -235,14 +235,14 @@ def main() -> None:
     with open(SOURCE_FILE, "w") as file:
         file.write(FILE_CONTENT)
 
-    remote_cfg_table = RemoteEntityCfgTable()
+    remote_cfg_table = RemoteEntityConfigTable()
     remote_cfg_table.add_config(REMOTE_CFG_FOR_SOURCE_ENTITY)
     remote_cfg_table.add_config(REMOTE_CFG_FOR_DEST_ENTITY)
 
     # Enable all indications.
-    src_indication_cfg = IndicationCfg()
+    src_indication_cfg = IndicationConfig()
     src_fault_handler = CfdpFaultHandler()
-    src_entity_cfg = LocalEntityCfg(SOURCE_ENTITY_ID, src_indication_cfg, src_fault_handler)
+    src_entity_cfg = LocalEntityConfig(SOURCE_ENTITY_ID, src_indication_cfg, src_fault_handler)
     # 16 bit sequence count for transactions.
     src_seq_count_provider = SeqCountProvider(16)
     src_user = CfdpUser("SRC ENTITY")
@@ -262,9 +262,9 @@ def main() -> None:
     )
 
     # Enable all indications.
-    dest_indication_cfg = IndicationCfg()
+    dest_indication_cfg = IndicationConfig()
     dest_fault_handler = CfdpFaultHandler()
-    dest_entity_cfg = LocalEntityCfg(DEST_ENTITY_ID, dest_indication_cfg, dest_fault_handler)
+    dest_entity_cfg = LocalEntityConfig(DEST_ENTITY_ID, dest_indication_cfg, dest_fault_handler)
     dest_user = CfdpUser("DEST ENTITY")
     dest_handler = DestHandler(
         cfg=dest_entity_cfg,

src/cfdppy/__init__.py

@@ -8,10 +8,10 @@
 from .filestore import HostFilestore, VirtualFilestore
 from .handler.common import PacketDestination, get_packet_destination
 from .mib import (
-    IndicationCfg,
-    LocalEntityCfg,
-    RemoteEntityCfg,
-    RemoteEntityCfgTable,
+    IndicationConfig,
+    LocalEntityConfig,
+    RemoteEntityConfig,
+    RemoteEntityConfigTable,
 )
 from .request import PutRequest
 from .restricted_filestore import RestrictedFilestore
@@ -22,12 +22,12 @@
     "CfdpState",
     "CfdpUserBase",
     "HostFilestore",
-    "IndicationCfg",
-    "LocalEntityCfg",
+    "IndicationConfig",
+    "LocalEntityConfig",
     "PacketDestination",
     "PutRequest",
-    "RemoteEntityCfg",
-    "RemoteEntityCfgTable",
+    "RemoteEntityConfig",
+    "RemoteEntityConfigTable",
     "RestrictedFilestore",
     "TransactionId",
     "VirtualFilestore",

src/cfdppy/handler/__init__.py

@@ -1,9 +1,9 @@
 from spacepackets.seqcount import ProvidesSeqCount
 
 from cfdppy.mib import (
-    LocalEntityCfg,
-    RemoteEntityCfg,
-    RemoteEntityCfgTable,
+    LocalEntityConfig,
+    RemoteEntityConfig,
+    RemoteEntityConfigTable,
 )
 
 from .common import PacketDestination, get_packet_destination
@@ -17,11 +17,11 @@
     "DestStateWrapper",
     "DestTransactionStep",
     "FsmResult",
-    "LocalEntityCfg",
+    "LocalEntityConfig",
     "PacketDestination",
     "ProvidesSeqCount",
-    "RemoteEntityCfg",
-    "RemoteEntityCfgTable",
+    "RemoteEntityConfig",
+    "RemoteEntityConfigTable",
     "SourceHandler",
     "SourceStateWrapper",
     "SourceTransactionStep",

src/cfdppy/handler/dest.py

@@ -56,9 +56,9 @@
 from cfdppy.mib import (
     CheckTimerProvider,
     EntityType,
-    LocalEntityCfg,
-    RemoteEntityCfg,
-    RemoteEntityCfgTable,
+    LocalEntityConfig,
+    RemoteEntityConfig,
+    RemoteEntityConfigTable,
 )
 from cfdppy.user import (
     CfdpUserBase,
@@ -238,7 +238,7 @@ class _DestFieldWrapper:
 
     def __init__(self):
         self.transaction_id: TransactionId | None = None
-        self.remote_cfg: RemoteEntityCfg | None = None
+        self.remote_cfg: RemoteEntityConfig | None = None
         self.check_timer: Countdown | None = None
         self.current_check_count: int = 0
         self.closure_requested: bool = False
@@ -319,9 +319,9 @@ class DestHandler:
 
     def __init__(
         self,
-        cfg: LocalEntityCfg,
+        cfg: LocalEntityConfig,
         user: CfdpUserBase,
-        remote_cfg_table: RemoteEntityCfgTable,
+        remote_cfg_table: RemoteEntityConfigTable,
         check_timer_provider: CheckTimerProvider,
     ) -> None:
         self.cfg = cfg