Bug fix: declare log.fatal as typing.NoReturn

netsim/cli/__init__.py

@@ -146,7 +146,6 @@ def get_message(topology: Box, action: str, default_message: bool = False) -> ty
 
   if not isinstance(topology.message,Box):                  # Otherwise we should be dealing with a dict
     common.fatal('topology message should be a string or a dict')
-    return None
 
   return topology.message.get(action,None)                  # Return action-specific message if it exists
 

netsim/cli/ansible.py

@@ -34,7 +34,6 @@ def inventory(name: str) -> typing.Optional[dict]:
       return json.loads(result.stdout)
     except:
       common.fatal('Cannot parse JSON data returned by ansible-inventory','inventory')
-    return None
 
   except:
     try:
@@ -44,13 +43,10 @@ def inventory(name: str) -> typing.Optional[dict]:
 
     common.fatal('Cannot get Ansible inventory data for %s with ansible-inventory. Is the host name correct?' % name,'inventory')
 
-  return None
-
 def playbook(name: str, args: typing.List[str]) -> None:
   pbname = find_playbook(name)
   if not pbname:
     common.fatal("Cannot find Ansible playbook %s, aborting" % name)
-    return
 
   if common.VERBOSE:
     print("Running Ansible playbook %s" % pbname)

netsim/cli/clab.py

@@ -68,7 +68,6 @@ def clab_config_adjust(infile: str, outfile: str, configs: str) -> None:
   clab = read_topology.read_yaml(infile)
   if not clab:
     common.fatal("Cannot read clab.yml configuration file, aborting")
-    return
 
   clab_yml = common.get_yaml_string(clab)
   if not ('topology' in clab and 'nodes' in clab.topology):
@@ -129,7 +128,6 @@ def run(cli_args: typing.List[str]) -> None:
 
   if not settings:
     common.fatal("Cannot read the system defaults","clab")
-    return
 
   if cli_args[0] == 'tarball':
     clab_tarball(cli_args[1:],settings)

netsim/cli/connect.py

@@ -184,4 +184,3 @@ def run(cli_args: typing.List[str]) -> None:
     connect_to_tool(host,rest,topology,log_level)
   else:
     common.fatal(f'Unknown host or external tool {host}')
-    return

netsim/cli/install.py

@@ -51,7 +51,6 @@ def install_parse(args: typing.List[str]) -> argparse.Namespace:
 def run(cli_args: typing.List[str]) -> None:
   if not cli_args:
     common.fatal("Specify an installation script to run or use -h to get help","install")
-    return
 
   args = install_parse(cli_args)
 

netsim/cli/libvirt.py

@@ -311,7 +311,6 @@ def run(cli_args: typing.List[str]) -> None:
   topology = read_topology.load("package:cli/empty.yml","","package:topology-defaults.yml")
   if not topology:
     common.fatal("Cannot read the system defaults","libvirt")
-    return
 
   if not cli_args:
     libvirt_usage()

netsim/cli/show.py

@@ -107,7 +107,6 @@ def get_modlist(settings: Box, args: argparse.Namespace) -> list:
       return [ args.module ]
     else:
       common.fatal(f'Unknown module: {args.module}')
-      return []
 
   return sorted([ m for m in settings.keys() if 'supported_on' in settings[m]])
 

netsim/cli/status.py

@@ -157,4 +157,3 @@ def run(cli_args: typing.List[str]) -> None:
     action_map[args.action](topology,args,lab_states)
   else:
     common.fatal(f'Unknown action {args.action}')
-    return

netsim/cli/test.py

@@ -88,11 +88,9 @@ def run(cli_args: typing.List[str]) -> None:
   settings = read_topology.read_yaml('package:topology-defaults.yml')
   if not cli_args:
     common.fatal("Specify the virtualization environment to test or use -h to get help","test")
-    return
 
   if not settings:
     common.fatal("Cannot read the global defaults","test")
-    return
 
   args = test_parse(cli_args,settings)
   if os.path.exists(args.workdir):

netsim/cli/up.py

@@ -72,7 +72,6 @@ def get_topology(args: argparse.Namespace, cli_args: typing.List[str]) -> Box:
     topology = read_topology.read_yaml(filename=args.snapshot)
     if topology is None:
       common.fatal(f'Cannot read snapshot file {args.snapshot}, aborting...')
-      return Box({})                                          # pragma: no-cover
 
     print(f"Using transformed lab topology from snapshot file {args.snapshot}")
   else:                                                       # No snapshot file, use 'netlab create' parser
@@ -281,7 +280,6 @@ def run(cli_args: typing.List[str]) -> None:
   status_start_lab(topology)
   if 'err_conflict' in topology.defaults:
     common.fatal(f'race condition, lab instance already running in {topology.defaults.err_conflict}')
-    return
 
   if not is_dry_run():
     status.lock_directory()

netsim/utils/log.py

@@ -39,7 +39,7 @@ class FatalError(Warning):
 class ErrorAbort(Exception):
   pass
 
-def fatal(text: str, module: str = 'netlab') -> None:
+def fatal(text: str, module: str = 'netlab') -> typing.NoReturn:
   global err_count
   err_count = err_count + 1
   if RAISE_ON_ERROR: