fix logging

Author: gsakkis

pdal/libpdalpython.pyx

@@ -102,8 +102,7 @@ cdef extern from "pdal/PipelineExecutor.hpp" namespace "pdal":
         string getMetadata() except +
         string getSchema() except +
         string getLog() except +
-        int getLogLevel()
-        void setLogLevel(int)
+        void setLogLevel(int) except +
 
 
 cdef extern from "PyArray.hpp" namespace "pdal::python":
@@ -121,6 +120,7 @@ cdef extern from "PyPipeline.hpp" namespace "pdal::python":
 cdef class Pipeline:
     cdef PipelineExecutor* _executor
     cdef vector[shared_ptr[Array]] _inputs
+    cdef int _loglevel
 
     def __dealloc__(self):
         self.inputs = []
@@ -151,11 +151,12 @@ cdef class Pipeline:
 
     @property
     def loglevel(self):
-        return self._get_executor().getLogLevel()
+        return self._loglevel
 
     @loglevel.setter
-    def loglevel(self, level):
-        self._get_executor().setLogLevel(level)
+    def loglevel(self, value):
+        self._loglevel = value
+        self._delete_executor()
 
     @property
     def log(self):
@@ -226,6 +227,7 @@ cdef class Pipeline:
         if not self._executor:
             json_bytes = self._json.encode("UTF-8")
             self._executor = new PipelineExecutor(json_bytes)
+            self._executor.setLogLevel(self._loglevel)
             readPipeline(self._executor, json_bytes)
             addArrayReaders(self._executor, self._inputs)
         return self._executor

pdal/pipeline.py

@@ -2,18 +2,29 @@
 
 import glob
 import json
+import logging
 from typing import Any, Container, Dict, Iterator, List, Optional, Sequence, Union, cast
 
 import numpy as np
 
 from . import libpdalpython
 
 
+LogLevelToPDAL = {
+    logging.ERROR: 0,
+    logging.WARNING: 1,
+    logging.INFO: 2,
+    logging.DEBUG: 8,  # pdal::LogLevel::Debug5
+}
+LogLevelFromPDAL = {v: k for k, v in LogLevelToPDAL.items()}
+
+
 class Pipeline(libpdalpython.Pipeline):
     def __init__(
         self,
         spec: Union[None, str, Sequence[Stage]] = None,
         arrays: Sequence[np.ndarray] = (),
+        loglevel: int = logging.ERROR,
     ):
         self._stages: List[Stage] = []
         if spec:
@@ -22,11 +33,25 @@ def __init__(
                 self |= stage
         if arrays:
             self.inputs = arrays
+        self.loglevel = loglevel
 
     @property
     def stages(self) -> List[Stage]:
         return list(self._stages)
 
+    @property
+    def loglevel(self) -> int:
+        return LogLevelFromPDAL[super().loglevel]
+
+    @loglevel.setter
+    def loglevel(self, value: int) -> None:
+        try:
+            loglevel = LogLevelToPDAL[value]
+        except KeyError:
+            raise ValueError(f"Invalid level {value!r}")
+        # super() property setter is not supported
+        libpdalpython.Pipeline.loglevel.__set__(self, loglevel)
+
     def __ior__(self, other: Union[Stage, Pipeline]) -> Pipeline:
         if isinstance(other, Stage):
             self._stages.append(other)

test/data/reproject.json

@@ -7,7 +7,7 @@
     {
       "type":"filters.python",
       "function":"filter",
-      "source":"import numpy as np\n\ndef filter(ins,outs):\n\tcls = ins['Classification']\n\n\tkeep_classes = [1]\n\n\t# Use the first test for our base array.\n\tkeep = np.equal(cls, keep_classes[0])\n\n\t# For 1:n, test each predicate and join back\n\t# to our existing predicate array\n\tfor k in range(1,len(keep_classes)):\n\t\tt = np.equal(cls, keep_classes[k])\n\t\tkeep = keep + t\n\n\touts['Mask'] = keep\n\treturn True",
+      "source":"import numpy as np\n\ndef filter(ins,outs):\n\tprint('entered filter()')\n\tcls = ins['Classification']\n\n\tkeep_classes = [1]\n\n\t# Use the first test for our base array.\n\tkeep = np.equal(cls, keep_classes[0])\n\n\t# For 1:n, test each predicate and join back\n\t# to our existing predicate array\n\tfor k in range(1,len(keep_classes)):\n\t\tt = np.equal(cls, keep_classes[k])\n\t\tkeep = keep + t\n\n\touts['Mask'] = keep\n\tprint('exiting filter()')\n\treturn True",
       "module":"anything"
     },
     "out2.las"

test/data/reproject.py

@@ -6,6 +6,7 @@
 
 
 def filter(ins, outs):
+    print("entered filter()")
     cls = ins["Classification"]
     keep_classes = [1]
 
@@ -19,6 +20,7 @@ def filter(ins, outs):
         keep = keep + t
 
     outs["Mask"] = keep
+    print("exiting filter()")
     return True
 """)
     |

test/test_pipeline.py

@@ -1,4 +1,5 @@
 import json
+import logging
 import os
 import sys
 
@@ -197,13 +198,32 @@ def test_infer_stage_type(self):
         assert pdal.Reader().type == ""
         assert pdal.Writer().type == ""
 
+    # fails against PDAL master; see https://github.com/PDAL/PDAL/issues/3566
+    @pytest.mark.xfail
     @pytest.mark.parametrize("filename", ["reproject.json", "reproject.py"])
     def test_logging(self, filename):
         """Can we fetch log output"""
         r = get_pipeline(filename)
+        assert r.loglevel == logging.ERROR
+        assert r.log == ""
+
+        for loglevel in logging.CRITICAL, -1:
+            with pytest.raises(ValueError):
+                r.loglevel = loglevel
+
+        count = r.execute()
+        assert count == 789
+        assert r.log == "entered filter()\n" + "exiting filter()\n"
+
+        r.loglevel = logging.DEBUG
+        assert r.loglevel == logging.DEBUG
         count = r.execute()
         assert count == 789
-        # assert r.log.split()[0] == "(pypipeline"
+        assert "(pypipeline readers.las Debug)" in r.log
+        assert "(pypipeline filters.python Debug)" in r.log
+        assert "\nentered filter()\n" in r.log
+        assert "\nexiting filter()\n" in r.log
+        assert "(pypipeline writers.las Debug)" in r.log
 
 
 class TestArrayLoad: