feat: improve logging (#235)

* feat: improve logging * fix: add missing header * fix: replace `init_logging` with `try_init_log_from_env` `init_logging` code is kept unused waiting for eclipse-zenoh/zenoh#1165
eclipse-zenoh · Jun 18, 2024 · 664e9c9 · 664e9c9
1 parent c3ce7ef
commit 664e9c9
Show file tree

Hide file tree

Showing 20 changed files with 393 additions and 72 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/examples/z_delete.py b/examples/z_delete.py
@@ -78,7 +78,7 @@
 # Zenoh code  --- --- --- --- --- --- --- --- --- --- ---
 def main():
     # initiate logging
-    zenoh.init_logging()
+    zenoh.try_init_log_from_env()
 
     print("Opening session...")
     with zenoh.open(conf) as session:

diff --git a/examples/z_get.py b/examples/z_get.py
@@ -99,7 +99,7 @@
 # Zenoh code  --- --- --- --- --- --- --- --- --- --- ---
 def main():
     # initiate logging
-    zenoh.init_logging()
+    zenoh.try_init_log_from_env()
 
     print("Opening session...")
     with zenoh.open(conf) as session:

diff --git a/examples/z_info.py b/examples/z_info.py
@@ -69,7 +69,7 @@
 # Zenoh code  --- --- --- --- --- --- --- --- --- --- ---
 def main():
     # initiate logging
-    zenoh.init_logging()
+    zenoh.try_init_log_from_env()
 
     print("Opening session...")
     with zenoh.open(conf) as session:

diff --git a/examples/z_ping.py b/examples/z_ping.py
@@ -94,7 +94,7 @@
 # Zenoh code  --- --- --- --- --- --- --- --- --- --- ---
 def main():
     # initiate logging
-    zenoh.init_logging()
+    zenoh.try_init_log_from_env()
 
     print("Opening session...")
     with zenoh.open(conf) as session:

diff --git a/examples/z_pong.py b/examples/z_pong.py
@@ -78,7 +78,7 @@
 # Zenoh code  --- --- --- --- --- --- --- --- --- --- ---
 def main():
     # initiate logging
-    zenoh.init_logging()
+    zenoh.try_init_log_from_env()
 
     print("Opening session...")
     with zenoh.open(conf) as session:

diff --git a/examples/z_pub.py b/examples/z_pub.py
@@ -96,7 +96,7 @@
 
 def main():
     # initiate logging
-    zenoh.init_logging()
+    zenoh.try_init_log_from_env()
 
     print("Opening session...")
     with zenoh.open(conf) as session:

diff --git a/examples/z_pub_thr.py b/examples/z_pub_thr.py
@@ -75,7 +75,7 @@
 # Zenoh code  --- --- --- --- --- --- --- --- --- --- ---
 def main():
     # initiate logging
-    zenoh.init_logging()
+    zenoh.try_init_log_from_env()
 
     data = bytearray()
     for i in range(0, size):
@@ -89,13 +89,7 @@ def main():
 
         print("Press CTRL-C to quit...")
         while True:
-            try:
-                pub.put(bytes(data))
-            except BaseException:
-                print("Ctrl+C")
-                pub.undeclare()
-                print("Ctrl+C")
-                raise
+            pub.put(bytes(data))
 
 
 if __name__ == "__main__":

diff --git a/examples/z_pull.py b/examples/z_pull.py
@@ -90,7 +90,7 @@
 
 def main():
     # initiate logging
-    zenoh.init_logging()
+    zenoh.try_init_log_from_env()
 
     print("Opening session...")
     with zenoh.open(conf) as session:

diff --git a/examples/z_put.py b/examples/z_put.py
@@ -87,7 +87,7 @@
 # Zenoh code  --- --- --- --- --- --- --- --- --- --- ---
 def main():
     # initiate logging
-    zenoh.init_logging()
+    zenoh.try_init_log_from_env()
 
     print("Opening session...")
     with zenoh.open(conf) as session:

diff --git a/examples/z_queryable.py b/examples/z_queryable.py
@@ -111,7 +111,7 @@ def queryable_callback(query):
 
 def main():
     # initiate logging
-    zenoh.init_logging()
+    zenoh.try_init_log_from_env()
 
     print("Opening session...")
     with zenoh.open(conf) as session:

diff --git a/examples/z_scout.py b/examples/z_scout.py
@@ -18,7 +18,7 @@
 
 def main():
     # initiate logging
-    zenoh.init_logging()
+    zenoh.try_init_log_from_env()
 
     print("Scouting...")
     scout = zenoh.scout(what="peer|router")

diff --git a/examples/z_storage.py b/examples/z_storage.py
@@ -117,7 +117,7 @@ def query_handler(query: zenoh.Query):
 
 def main():
     # initiate logging
-    zenoh.init_logging()
+    zenoh.try_init_log_from_env()
 
     print("Opening session...")
     with zenoh.open(conf) as session:

diff --git a/examples/z_sub.py b/examples/z_sub.py
@@ -79,7 +79,7 @@
 # Zenoh code  --- --- --- --- --- --- --- --- --- --- ---
 def main():
     # initiate logging
-    zenoh.init_logging()
+    zenoh.try_init_log_from_env()
 
     print("Opening session...")
     with zenoh.open(conf) as session:

diff --git a/examples/z_sub_queued.py b/examples/z_sub_queued.py
@@ -81,7 +81,7 @@
 
 def main():
     # initiate logging
-    zenoh.init_logging()
+    zenoh.try_init_log_from_env()
 
     print("Opening session...")
     with zenoh.open(conf) as session:

diff --git a/examples/z_sub_thr.py b/examples/z_sub_thr.py
@@ -113,7 +113,7 @@ def report():
 
 def main():
     # initiate logging
-    zenoh.init_logging()
+    zenoh.try_init_log_from_env()
 
     with zenoh.open(conf) as session:
         session.declare_subscriber(

diff --git a/src/lib.rs b/src/lib.rs
@@ -17,7 +17,8 @@ mod encoding;
 mod handlers;
 mod info;
 mod key_expr;
-mod logging;
+#[allow(unused)]
+mod logging; // https://github.com/eclipse-zenoh/zenoh-python/pull/235#discussion_r1644498390
 mod macros;
 mod publisher;
 mod query;
@@ -44,6 +45,11 @@ pub(crate) mod zenoh {
         use crate::handlers::{Callback, DefaultHandler, FifoChannel, Handler, RingChannel};
     }
 
+    #[pyfunction]
+    fn try_init_log_from_env() {
+        zenoh::try_init_log_from_env();
+    }
+
     #[pymodule_export]
     use crate::{
         bytes::{deserializer, serializer, ZBytes},
@@ -53,7 +59,6 @@ pub(crate) mod zenoh {
         info::SessionInfo,
         key_expr::KeyExpr,
         key_expr::SetIntersectionLevel,
-        logging::init_logging,
         publisher::{CongestionControl, Priority, Publisher},
         query::{ConsolidationMode, Query, QueryTarget, Reply, ReplyError},
         queryable::Queryable,