Fix datalog implementation

- Removed MemoryBuffer, and only provide two ways of creating a reader instead
- TODO: example needs to be better
- TODO: need to provide a 'get' function for a record which figures out the right type for you
- TODO: py::make_iterator isn't handled by pybind11-stubgen, which is annoying

Author: virtuald

examples/printlog.py

@@ -0,0 +1,18 @@
+#!/usr/bin/env python3
+
+import argparse
+import pathlib
+
+from wpiutil.log import DataLogReader
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser()
+    parser.add_argument("infile")
+    args = parser.parse_args()
+
+    reader = DataLogReader(args.infile)
+    for record in reader:
+        if record.isStart():
+            print(record.getStartData())
+        else:
+            print(record.getBoolean())

examples/writelog.py

@@ -0,0 +1,22 @@
+#!/usr/bin/env python3
+
+import argparse
+import pathlib
+
+from wpiutil.log import DataLog, BooleanLogEntry
+
+
+if __name__ == "__main__":
+
+    parser = argparse.ArgumentParser()
+    parser.add_argument("out", type=pathlib.Path)
+    args = parser.parse_args()
+
+    if args.out.is_dir():
+        datalog = DataLog(str(args.out))
+    else:
+        datalog = DataLog(str(args.out.parent), args.out.name)
+
+    bools = BooleanLogEntry(datalog, "/bools")
+    bools.append(True)
+    bools.append(False)

gen/DataLogReader.yml

@@ -30,58 +30,125 @@ classes:
       IsFinish:
       IsSetMetadata:
       GetStartData:
+        param_override:
+          out:
+            force_out: true
+            default:
       GetFinishEntry:
+        param_override:
+          out:
+            force_out: true
+            default:
       GetSetMetadataData:
+        param_override:
+          out:
+            force_out: true
+            default:
       GetBoolean:
       GetInteger:
       GetFloat:
       GetDouble:
       GetString:
+        param_override:
+          value:
+            force_out: true
+            default:
       GetBooleanArray:
+        param_override:
+          arr:
+            force_out: true
+            default:
       GetIntegerArray:
+        param_override:
+          arr:
+            force_out: true
+            default:
       GetFloatArray:
+        param_override:
+          arr:
+            force_out: true
+            default:
       GetDoubleArray:
+        param_override:
+          arr:
+            force_out: true
+            default:
       GetStringArray:
+        param_override:
+          arr:
+            force_out: true
+            default:
   DataLogIterator:
-    subpackage: log
-    methods:
-      DataLogIterator:
-      # TODO: https://github.com/robotpy/robotpy-build/issues/160
-      operator==:
-        ignore: true
-      operator!=:
-        ignore: true
-      operator<:
-        ignore: true
-      operator>:
-        ignore: true
-      operator<=:
-        ignore: true
-      operator>=:
-        ignore: true
-      operator*:
-        ignore: true  # XXX: https://github.com/robotpy/robotpy-build/issues/159
-        rename: get
+    ignore: true
   DataLogReader:
     subpackage: log
     typealias:
       - wpi::MemoryBuffer
     methods:
       DataLogReader:
+        ignore: true
       IsValid:
       GetVersion:
       GetExtraHeader:
       GetBufferIdentifier:
       begin:
-        rename: __iter__
+        ignore: true
       end:
+        ignore: true
 
 inline_code: |
-  cls_DataLogIterator
-    .def("__iter__", [](DataLogIterator &self) { return self; })
-    .def("__next__", [](DataLogIterator &self) {
-      auto& record = *self;
-      ++self;
-      return record;
-    })
-  ;
+  cls_StartRecordData
+    .def("__repr__", [](const wpi::log::StartRecordData &data) -> std::string {
+      return "StartRecordData(entry=" + std::to_string(data.entry) + ", "
+                             "name=\"" + std::string(data.name) + "\", "
+                             "type=\"" + std::string(data.type) + "\", "
+                             "metadata=\"" + std::string(data.metadata) + "\")";
+    });
+  
+  cls_MetadataRecordData
+    .def("__repr__", [](const wpi::log::MetadataRecordData &data) -> std::string {
+      return "MetadataRecordData(entry=" + std::to_string(data.entry) + ", "
+                                "metadata=\"" + std::string(data.metadata) + "\")";
+    });
+
+
+  cls_DataLogReader
+    .def(py::init([](const std::string &filename) {
+      std::error_code ec;
+      auto mbuf = wpi::MemoryBuffer::GetFile(filename, ec);
+      if (ec) {
+        py::gil_scoped_acquire gil;
+        #ifdef _WIN32
+          PyErr_SetFromWindowsErr(ec.value());
+        #else
+          errno = ec.value();
+          PyErr_SetFromErrno(PyExc_OSError);
+        #endif
+        throw py::error_already_set();
+      }
+
+      return std::make_shared<wpi::log::DataLogReader>(std::move(mbuf));
+    }),
+      release_gil(), py::arg("filename"))
+
+    .def(py::init([](const py::buffer &buffer, const std::string &name) {
+      auto req = buffer.request();
+      if (req.itemsize != 1) {
+        throw py::value_error("buffer must only contain bytes");
+      } else if (req.ndim != 1) {
+        throw py::value_error("buffer must only have a single dimension");
+      }
+
+      auto mbuf = wpi::MemoryBuffer::GetMemBuffer(wpi::span((uint8_t*)req.ptr, req.size), name);
+
+      {
+        py::gil_scoped_release gil;
+        return std::make_shared<wpi::log::DataLogReader>(std::move(mbuf));
+      }
+    }),
+      py::arg("buffer"), py::arg("name") = "",
+      py::keep_alive<1, 2>())
+    .def("__iter__", [](wpi::log::DataLogReader * that) {
+      return py::make_iterator(that->begin(), that->end());
+    }, py::keep_alive<0,1>());
+

gen/MemoryBuffer.yml

@@ -1,5 +1,5 @@
 [build-system]
-requires = ["robotpy-build<2023.0.0,>=2022.2.0"]
+requires = ["robotpy-build<2023.0.0,>=2022.2.2"]
 
 [tool.robotpy-build]
 base_package = "wpiutil"
@@ -26,7 +26,6 @@ libs = ["wpiutil"]
 # wpi
 DataLog = "wpi/DataLog.h"
 DataLogReader = "wpi/DataLogReader.h"
-MemoryBuffer = "wpi/MemoryBuffer.h"
 PortForwarder = "wpi/PortForwarder.h"
 StackTrace = "wpi/StackTrace.h"
 

pyproject.toml

@@ -1,9 +1,27 @@
 from . import _init_wpiutil
 
 # autogenerated by 'robotpy-build create-imports wpiutil wpiutil._wpiutil'
-from ._wpiutil import PortForwarder
+from ._wpiutil import (
+    ControlRecordType,
+    PortForwarder,
+    Sendable,
+    SendableBuilder,
+    SendableRegistry,
+    getStackTrace,
+    getStackTraceDefault,
+    # log,
+)
 
-__all__ = ["PortForwarder"]
+__all__ = [
+    "ControlRecordType",
+    "PortForwarder",
+    "Sendable",
+    "SendableBuilder",
+    "SendableRegistry",
+    "getStackTrace",
+    "getStackTraceDefault",
+    # "log",
+]
 
 # Imported for side effects only
 from . import _stacktrace