fastgpx 0.3.0__tar.gz → 0.4.0__tar.gz

{fastgpx-0.3.0 → fastgpx-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastgpx
-Version: 0.3.0
+Version: 0.4.0
 Summary: An experimental Python library for parsing GPX files fast.
 Keywords: gpx,parser,fast
 Author: Thomas Thomassen

{fastgpx-0.3.0 → fastgpx-0.4.0}/docs/source/conf.py

@@ -3,9 +3,12 @@
 # For the full list of built-in configuration values, see the documentation:
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
 
+import re
 import os
 import sys
 import tomllib
+import logging as std_logging
+from sphinx.util import logging
 
 PROJECT_ROOT = os.path.abspath('../../')
 
@@ -49,3 +52,43 @@ autosummary_generate = True
 
 html_theme = 'sphinx_rtd_theme'
 html_static_path = ['_static']
+
+
+# -- Adjust formatting for overloaded methods --------------------------------
+
+logger = logging.getLogger(__name__)
+
+
+def format_overloaded_docstring(app, what, name, obj, options, lines):
+    logger.info(f"[fastgpx-doc] Processing docstring for {name}")
+    if not lines:
+        return
+
+    logger.info(f"[fastgpx-doc] First line: {lines[0]}")
+    if lines[0].strip().startswith("Overloaded function"):
+        logger.info(f"[fastgpx-doc] Detected overloaded function in {name}")
+
+        new_lines = [".. rubric:: Overloads", ""]
+
+        for line in lines[1:]:
+            match = re.match(r"^\d+\.\s+(.*)", line.strip())
+            if match:
+                new_lines.extend([
+                    ".. code-block:: python",
+                    "",
+                    f"    {match.group(1)}",
+                    ""
+                ])
+
+        lines.clear()
+        lines.extend(new_lines)
+
+
+def setup(app):
+    if app.verbosity >= 1:
+        logger.setLevel(std_logging.INFO)
+    else:
+        logger.setLevel(std_logging.WARNING)
+
+    logger.info("[fastgpx-doc] Setting up overloaded docstring formatting")
+    app.connect("autodoc-process-docstring", format_overloaded_docstring)

{fastgpx-0.3.0 → fastgpx-0.4.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "scikit_build_core.build"
 
 [project]
 name = "fastgpx"
-version = "0.3.0"
+version = "0.4.0"
 requires-python = ">=3.11"
 
 description = "An experimental Python library for parsing GPX files fast."

{fastgpx-0.3.0 → fastgpx-0.4.0}/src/cpp/fastgpx/fastgpx.cpp

@@ -384,6 +384,16 @@ Gpx ParseGpx(const std::filesystem::path& path)
   pugi::xml_node root = doc.child("gpx");
   Gpx gpx;
 
+  const auto metadata = root.child("metadata");
+  if (metadata)
+  {
+    const auto name = metadata.child("name");
+    if (name)
+    {
+      gpx.name.emplace(name.text().as_string());
+    }
+  }
+
   // Iterate over each <trk> element
   for (pugi::xml_node track = root.child("trk"); track; track = track.next_sibling("trk"))
   {

{fastgpx-0.3.0 → fastgpx-0.4.0}/src/cpp/fastgpx/fastgpx.hpp

@@ -112,6 +112,8 @@ private:
 struct Gpx
 {
   // <metadata>
+  std::optional<std::string> name; // <name>
+
   // <wpt>
   // <tre>
   std::vector<Track> tracks; // <trk>

{fastgpx-0.3.0 → fastgpx-0.4.0}/src/cpp/fastgpx/fastgpx_test.cpp

@@ -33,6 +33,8 @@ TEST_CASE("Parse two-point single segment track", "[parse][simple]")
   REQUIRE(gpx.tracks.size() == 1);
   REQUIRE(gpx.tracks[0].segments.size() == 1);
 
+  CHECK(!gpx.name.has_value());
+
   CHECK_THAT(gpx.tracks[0].segments[0].GetLength2D(), WithinAbs(1.3839, kMETERS_TOL));
   CHECK_THAT(gpx.tracks[0].GetLength2D(), WithinAbs(1.3839, kMETERS_TOL));
   CHECK_THAT(gpx.GetLength2D(), WithinAbs(1.3839, kMETERS_TOL));
@@ -74,6 +76,8 @@ TEST_CASE("Parse time bounds of real world GPX file", "[parse][simple]")
       "gpx/2024 TopCamp/Connected_20240529_091916_Harald_Bothners_Veg_36_7052_Trondheim.gpx";
   const auto gpx = fastgpx::ParseGpx(path);
 
+  CHECK(gpx.name.value() == "Harald Bothners Veg 36, 7052 Trondheim");
+
   REQUIRE(gpx.tracks.size() == 1);
 
   // TimeBounds
@@ -97,6 +101,8 @@ TEST_CASE("Parse bounds of real world GPX file", "[parse][simple]")
       "gpx/2024 TopCamp/Connected_20240529_091916_Harald_Bothners_Veg_36_7052_Trondheim.gpx";
   const auto gpx = fastgpx::ParseGpx(path);
 
+  CHECK(gpx.name.value() == "Harald Bothners Veg 36, 7052 Trondheim");
+
   REQUIRE(gpx.tracks.size() == 1);
 
   const fastgpx::LatLong expected_min(61.841507, 9.090457);

{fastgpx-0.3.0 → fastgpx-0.4.0}/src/cpp/python_fastgpx.cpp

@@ -203,6 +203,7 @@ PYBIND11_MODULE(fastgpx, m)
   py::class_<fastgpx::Gpx>(m, "Gpx")
       .def(py::init<>()) // Default constructor
       .def_readwrite("tracks", &fastgpx::Gpx::tracks)
+      .def_readwrite("name", &fastgpx::Gpx::name)
       .def("bounds", &fastgpx::Gpx::GetBounds)
       .def("get_bounds", &fastgpx::Gpx::GetBounds) // gpxpy compatiblity
       .def("time_bounds", &fastgpx::Gpx::GetTimeBounds)

{fastgpx-0.3.0 → fastgpx-0.4.0}/src/fastgpx/fastgpx/__init__.pyi

@@ -51,6 +51,7 @@ class Bounds:
     def min_longitude(self, arg1: float) -> None:
         ...
 class Gpx:
+    name: str | None
     tracks: list[Track]
     def __init__(self) -> None:
         ...

{fastgpx-0.3.0 → fastgpx-0.4.0}/tests/test_fastgpx.py

@@ -52,6 +52,25 @@ def test_segment_length2d(gpx_path: str):
     distance = gpx.tracks[0].segments[0].length_2d()
     assert distance == pytest.approx(17809.2701, abs=METERS_TOL)
 
+# fastgpx.Gpx.name
+
+
+def test_gpx_name_missing():
+    path = 'gpx/test/debug-segment.gpx'
+    gpx = fastgpx.parse(path)
+    assert gpx.name is None
+
+
+def test_gpx_name_empty_string(gpx_path: str):
+    gpx = fastgpx.parse(gpx_path)
+    assert gpx.name == ''
+
+
+def test_gpx_name():
+    path = 'gpx/test/two-points.gpx'
+    gpx = fastgpx.parse(path)
+    assert gpx.name == 'Two Point Segment'
+
 # fastgpx.Gpx.bounds
 
 

{fastgpx-0.3.0 → fastgpx-0.4.0}/uv.lock

@@ -97,7 +97,7 @@ wheels = [
 
 [[package]]
 name = "fastgpx"
-version = "0.3.0"
+version = "0.4.0"
 source = { editable = "." }
 
 [package.dev-dependencies]