bindings: (fixes #796) Gracefully exit when bindings are unavailable

examples/realtime/realtime-udp-echo.py

@@ -23,7 +23,14 @@
 # - DropTail queues
 # - Tracing of queues and packet receptions to file "udp-echo.tr"
 
+try:
     from ns import ns
+except ModuleNotFoundError:
+    raise SystemExit(
+        "Error: ns3 Python module not found;"
+        " Python bindings may not be enabled"
+        " or your PYTHONPATH might not be properly configured"
+    )
 
 def main(argv):
   #

examples/routing/simple-routing-ping6.py

@@ -27,7 +27,14 @@
 #                router
 #
 
+try:
     from ns import ns
+except ModuleNotFoundError:
+    raise SystemExit(
+        "Error: ns3 Python module not found;"
+        " Python bindings may not be enabled"
+        " or your PYTHONPATH might not be properly configured"
+    )
 
 
 def main(argv):

examples/tutorial/first.py

@@ -13,7 +13,14 @@
 #  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 #  */
 
+try:
     from ns import ns
+except ModuleNotFoundError:
+    raise SystemExit(
+        "Error: ns3 Python module not found;"
+        " Python bindings may not be enabled"
+        " or your PYTHONPATH might not be properly configured"
+    )
 
 # // Default Network Topology
 # //

examples/tutorial/second.py

@@ -16,7 +16,14 @@
 #  * Ported to Python by Mohit P. Tahiliani
 #  */
 
+try:
     from ns import ns
+except ModuleNotFoundError:
+    raise SystemExit(
+        "Error: ns3 Python module not found;"
+        " Python bindings may not be enabled"
+        " or your PYTHONPATH might not be properly configured"
+    )
 import sys
 
 # // Default Network Topology

examples/tutorial/third.py

@@ -16,7 +16,14 @@
 #  * Ported to Python by Mohit P. Tahiliani
 #  */
 
+try:
     from ns import ns
+except ModuleNotFoundError:
+    raise SystemExit(
+        "Error: ns3 Python module not found;"
+        " Python bindings may not be enabled"
+        " or your PYTHONPATH might not be properly configured"
+    )
 import sys
 
 # // Default Network Topology

examples/wireless/mixed-wired-wireless.py

@@ -51,7 +51,14 @@
 #           +----------------+                       +----------------+
 #
 
+try:
     from ns import ns
+except ModuleNotFoundError:
+    raise SystemExit(
+        "Error: ns3 Python module not found;"
+        " Python bindings may not be enabled"
+        " or your PYTHONPATH might not be properly configured"
+    )
 
 # #
 # #  This function will be used below as a trace sink

examples/wireless/wifi-ap.py

@@ -22,7 +22,14 @@
 
 import sys
 
+try:
     from ns import ns
+except ModuleNotFoundError:
+    raise SystemExit(
+        "Error: ns3 Python module not found;"
+        " Python bindings may not be enabled"
+        " or your PYTHONPATH might not be properly configured"
+    )
 
 # void
 # DevTxTrace (std::string context, Ptr<const Packet> p, Mac48Address address)

src/bridge/examples/csma-bridge.py

@@ -1,17 +1,17 @@
-# /*
-#  * This program is free software; you can redistribute it and/or modify
-#  * it under the terms of the GNU General Public License version 2 as
-#  * published by the Free Software Foundation
-#  *
-#  * This program is distributed in the hope that it will be useful,
-#  * but WITHOUT ANY WARRANTY; without even the implied warranty of
-#  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-#  * GNU General Public License for more details.
-#  *
-#  * You should have received a copy of the GNU General Public License
-#  * along with this program; if not, write to the Free Software
-#  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
-#  */
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 2 as
+# published by the Free Software Foundation
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+#
 
 # Network topology
 #
@@ -32,8 +32,15 @@
 #  \ingroup bridge
 #  Bridge example connecting two broadcast domains.
 
-
+## Import ns-3
+try:
     from ns import ns
+except ModuleNotFoundError:
+    raise SystemExit(
+        "Error: ns3 Python module not found;"
+        " Python bindings may not be enabled"
+        " or your PYTHONPATH might not be properly configured"
+    )
 
 
 def main(argv):

src/brite/examples/brite-generic-example.py

@@ -18,7 +18,14 @@
 # Modified by: Gabriel Ferreira <gabrielcarvfer@gmail.com>
 #
 
+try:
     from ns import ns
+except ModuleNotFoundError:
+    raise SystemExit(
+        "Error: ns3 Python module not found;"
+        " Python bindings may not be enabled"
+        " or your PYTHONPATH might not be properly configured"
+    )
 
 ns.LogComponentEnable("BriteTopologyHelper", ns.LOG_LEVEL_ALL)
 

src/click/examples/nsclick-simple-lan.py

@@ -18,7 +18,14 @@
 
 import os.path
 
+try:
     from ns import ns
+except ModuleNotFoundError:
+    raise SystemExit(
+        "Error: ns3 Python module not found;"
+        " Python bindings may not be enabled"
+        " or your PYTHONPATH might not be properly configured"
+    )
 
 ns.LogComponentEnable("Ipv4ClickRouting", ns.LOG_LEVEL_ALL)
 ns.LogComponentEnable("Ipv4L3ClickProtocol", ns.LOG_LEVEL_ALL)

src/core/examples/sample-rng-plot.py

@@ -1,18 +1,17 @@
-# -*- Mode:Python; -*-
-# /*
-#  * This program is free software; you can redistribute it and/or modify
-#  * it under the terms of the GNU General Public License version 2 as
-#  * published by the Free Software Foundation
-#  *
-#  * This program is distributed in the hope that it will be useful,
-#  * but WITHOUT ANY WARRANTY; without even the implied warranty of
-#  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-#  * GNU General Public License for more details.
-#  *
-#  * You should have received a copy of the GNU General Public License
-#  * along with this program; if not, write to the Free Software
-#  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
-#  */
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 2 as
+# published by the Free Software Foundation
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+#
 
 ## @file
 #  @ingroup core-examples
@@ -27,7 +26,15 @@ import numpy as np
 import matplotlib.pyplot as plt
 import sys
 import argparse
+## Import ns-3
+try:
     from ns import ns
+except ModuleNotFoundError:
+    raise SystemExit(
+        "Error: ns3 Python module not found;"
+        " Python bindings may not be enabled"
+        " or your PYTHONPATH might not be properly configured"
+    )
 
 
 def main():

src/core/examples/sample-simulator.py

@@ -1,22 +1,21 @@
-# -*- Mode:Python; -*-
-# /*
-#  * Copyright (c) 2010 INRIA
-#  *
-#  * This program is free software; you can redistribute it and/or modify
-#  * it under the terms of the GNU General Public License version 2 as
-#  * published by the Free Software Foundation;
-#  *
-#  * This program is distributed in the hope that it will be useful,
-#  * but WITHOUT ANY WARRANTY; without even the implied warranty of
-#  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-#  * GNU General Public License for more details.
-#  *
-#  * You should have received a copy of the GNU General Public License
-#  * along with this program; if not, write to the Free Software
-#  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
-#  *
-#  * Authors: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
-#  */
+#
+# Copyright (c) 2010 INRIA
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 2 as
+# published by the Free Software Foundation;
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+#
+# Authors: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
+#
 #
 # Python version of sample-simulator.cc
 
@@ -25,8 +24,15 @@
 #  \ingroup simulator
 #  Python example program demonstrating use of various Schedule functions.
 
-
+## Import ns-3
+try:
     from ns import ns
+except ModuleNotFoundError:
+    raise SystemExit(
+        "Error: ns3 Python module not found;"
+        " Python bindings may not be enabled"
+        " or your PYTHONPATH might not be properly configured"
+    )
 
 ## Example function - triggered at a random time.
 ## \return None.

src/energy/examples/generic-battery-discharge-example.py

@@ -20,7 +20,14 @@
 #  Demonstrates the discharge behavior of a NIMH battery discharged with a
 #  constant current of 6.5 A (1C)
 
+try:
     from ns import ns
+except ModuleNotFoundError:
+    raise SystemExit(
+        "Error: ns3 Python module not found;"
+        " Python bindings may not be enabled"
+        " or your PYTHONPATH might not be properly configured"
+    )
 
 def main(argv):
     """The main function in this Battery discharge example

src/flow-monitor/examples/wifi-olsr-flowmon.py

@@ -19,7 +19,14 @@
 from __future__ import print_function
 import sys
 
+try:
     from ns import ns
+except ModuleNotFoundError:
+    raise SystemExit(
+        "Error: ns3 Python module not found;"
+        " Python bindings may not be enabled"
+        " or your PYTHONPATH might not be properly configured"
+    )
 
 DISTANCE = 20 # (m)
 NUM_NODES_SIDE = 3

src/openflow/examples/openflow-switch.py

@@ -18,7 +18,14 @@
 #              Gabriel Ferreira <gabrielcarvfer@gmail.com>
 #
 
+try:
     from ns import ns
+except ModuleNotFoundError:
+    raise SystemExit(
+        "Error: ns3 Python module not found;"
+        " Python bindings may not be enabled"
+        " or your PYTHONPATH might not be properly configured"
+    )
 
 ns.LogComponentEnable("OpenFlowInterface", ns.LOG_LEVEL_ALL)
 ns.LogComponentEnable("OpenFlowSwitchNetDevice", ns.LOG_LEVEL_ALL)

src/tap-bridge/examples/tap-csma-virtual-machine.py

@@ -18,7 +18,14 @@
 
 import sys
 
+try:
     from ns import ns
+except ModuleNotFoundError:
+    raise SystemExit(
+        "Error: ns3 Python module not found;"
+        " Python bindings may not be enabled"
+        " or your PYTHONPATH might not be properly configured"
+    )
 
 def main(argv):
 

src/tap-bridge/examples/tap-wifi-virtual-machine.py

@@ -17,7 +17,14 @@
 #
 
 import sys
+try:
     from ns import ns
+except ModuleNotFoundError:
+    raise SystemExit(
+        "Error: ns3 Python module not found;"
+        " Python bindings may not be enabled"
+        " or your PYTHONPATH might not be properly configured"
+    )
 
 def main(argv):
 

src/visualizer/visualizer/plugins/show_last_packets.py

@@ -1,7 +1,14 @@
 from gi.repository import GObject
 from gi.repository import Gtk
 
+try:
     from ns import ns
+except ModuleNotFoundError:
+    raise SystemExit(
+        "Error: ns3 Python module not found;"
+        " Python bindings may not be enabled"
+        " or your PYTHONPATH might not be properly configured"
+    )
 
 try:
     from ns3.visualizer.base import InformationWindow

src/visualizer/visualizer/plugins/wifi_intrastructure_link.py

@@ -1,5 +1,12 @@
 import math
+try:
     from ns import ns
+except ModuleNotFoundError:
+    raise SystemExit(
+        "Error: ns3 Python module not found;"
+        " Python bindings may not be enabled"
+        " or your PYTHONPATH might not be properly configured"
+    )
 from gi.repository import GooCanvas
 
 try:

utils/python-unit-tests.py

@@ -19,7 +19,14 @@
 # Author: Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
 
 import unittest
+try:
     from ns import ns
+except ModuleNotFoundError:
+    raise SystemExit(
+        "Error: ns3 Python module not found;"
+        " Python bindings may not be enabled"
+        " or your PYTHONPATH might not be properly configured"
+    )
 import sys
 
 UINT32_MAX = 0xFFFFFFFF