Use normal strings instead of f-strings (Sonar).

[simgrid.git] / examples / python / synchro-mutex / synchro-mutex.py

diff --git a/examples/python/synchro-mutex/synchro-mutex.py b/examples/python/synchro-mutex/synchro-mutex.py
index ab46961..1a202ba 100644 (file)
--- a/examples/python/synchro-mutex/synchro-mutex.py
+++ b/examples/python/synchro-mutex/synchro-mutex.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2010-2022. The SimGrid Team. All rights reserved.
+# Copyright (c) 2010-2023. The SimGrid Team. All rights reserved.
 #
 # This program is free software; you can redistribute it and/or modify it
 # under the terms of the license (GNU LGPL) which comes with this package.
@@ -33,13 +33,16 @@ class ResultHolder:
 
 
 def worker_context_manager(mutex: Mutex, result: ResultHolder):
+    # When using a context manager, the lock and the unlock are automatic. This is the easiest approach
     with mutex:
-        this_actor.info(f"Hello simgrid, I'm ready to compute after acquiring the mutex from a context manager")
+        this_actor.info("Hello simgrid, I'm ready to compute after acquiring the mutex from a context manager")
         result.value += 1
-    this_actor.info(f"I'm done, good bye")
+    this_actor.info("I'm done, good bye")
 
 
 def worker(mutex: Mutex, result: ResultHolder):
+    # If you lock your mutex manually, you also have to unlock it.
+    # Beware of exceptions preventing your unlock() from being executed!
     mutex.lock()
     this_actor.info("Hello simgrid, I'm ready to compute after a regular lock")
     result.value += 1
@@ -47,25 +50,24 @@ def worker(mutex: Mutex, result: ResultHolder):
     this_actor.info("I'm done, good bye")
 
 
-def master(settings):
+
+def main():
+    settings = create_parser().parse_known_args()[0]
+    e = Engine(sys.argv)
+    e.load_platform(settings.platform)
+
+    # Create the requested amount of actors pairs. Each pair has a specific mutex and cell in `result`
     results = [ResultHolder(value=0) for _ in range(settings.actors)]
     for i in range(settings.actors):
         mutex = Mutex()
         Actor.create(f"worker-{i}(mgr)", Host.by_name("Jupiter"), worker_context_manager, mutex, results[i])
         Actor.create(f"worker-{i}", Host.by_name("Tremblay"), worker, mutex, results[i])
-    this_actor.sleep_for(10)
-    for i in range(settings.actors):
-        this_actor.info(f"Result[{i}] -> {results[i].value}")
-    this_actor.info("I'm done, good bye")
-
 
-def main():
-    settings = create_parser().parse_known_args()[0]
-    e = Engine(sys.argv)
-    e.load_platform(settings.platform)
-    Actor.create("master", Host.by_name("Tremblay"), master, settings)
     e.run()
 
+    for i in range(settings.actors):
+        this_actor.info(f"Result[{i}] -> {results[i].value}")
+
 
 if __name__ == "__main__":
     main()