Rename load_xml to load_xtce for consistency (#159)

Author: medley56

docs/source/changelog.md

@@ -7,7 +7,7 @@ Release notes for the `space_packet_parser` library
 
 ### v6.0.0 (unreleased)
 - *BREAKING*: `XtcePacketDefinition` no longer accepts a file object as input.
-  Use `spp.xtce.definitions.XtcePacketDefinition.from_document()` or `spp.load_xml()` instead.
+  Use `spp.xtce.definitions.XtcePacketDefinition.from_xtce()` or `spp.load_xtce()` instead.
 - *BREAKING*: Reorganization of the project into different submodules for more explicit handling
   of imports. There is now an `space_packet_parser.xtce` module with xtce representations separated
   into modules underneath that.

docs/source/users.md

@@ -19,7 +19,7 @@ import space_packet_parser as spp
 
 packet_file = Path('my_packets.pkts')
 xtce_document = Path('my_xtce_document.xml')
-packet_definition = spp.load_xml(xtce_document)
+packet_definition = spp.load_xtce(xtce_document)
 packets = list(packet_definition.packet_generator(packet_file.open('rb')))
 
 # You can introspect the packet definition to learn about what was parsed

space_packet_parser/__init__.py

@@ -5,7 +5,7 @@
 from space_packet_parser.xtce.definitions import XtcePacketDefinition
 
 
-def load_xml(filename: Union[str, Path]) -> XtcePacketDefinition:
+def load_xtce(filename: Union[str, Path]) -> XtcePacketDefinition:
     """Create an XtcePacketDefinition object from an XTCE XML file
 
     Parameters

space_packet_parser/definitions.py

@@ -11,7 +11,7 @@
 class XtcePacketDefinition(definitions.XtcePacketDefinition):
     def __init__(self, xtce_document, **kwargs):
         warnings.warn("This class is deprecated. To load a packet definition from a file "
-                      "use space_packet_parser.load_xml() or "
+                      "use space_packet_parser.load_xtce() or "
                       "space_packet_parser.xtce.definitions.XtcePacketDefinition.from_xtce() instead.")
         other = definitions.XtcePacketDefinition.from_xtce(xtce_document)
         self.__dict__.update(other.__dict__)

tests/unit/test_space_packet_parser.py

@@ -3,12 +3,13 @@
 from space_packet_parser.xtce import definitions
 
 
-def test_load_xml(jpss_test_data_dir, tmp_path):
-    xtcedef = space_packet_parser.load_xml(jpss_test_data_dir / "jpss1_geolocation_xtce_v1.xml")
+def test_load_xtce(jpss_test_data_dir, tmp_path):
+    """Test high level function for loading an XTCE definition file"""
+    xtcedef = space_packet_parser.load_xtce(jpss_test_data_dir / "jpss1_geolocation_xtce_v1.xml")
     assert isinstance(xtcedef, definitions.XtcePacketDefinition)
 
     outpath = tmp_path / "test_output.xml"
     xtcedef.write_xml(outpath)
     assert outpath.exists()
 
-    assert space_packet_parser.load_xml(outpath) == xtcedef
+    assert space_packet_parser.load_xtce(outpath) == xtcedef