Add "ruff check" to GH actions, clean up the imports (#2627)

Author: Muddyblack

.github/workflows/ruff.yml

@@ -0,0 +1,38 @@
+name: Ruff Python Linting and Formatting
+on:
+  push:
+    branches-ignore: [ devc ]
+    paths:
+    - '**.py'
+    - 'ruff.toml'
+    - '.github/workflows/ruff.yml'
+
+  pull_request:
+    paths:
+    - '**.py'
+    - 'ruff.toml'
+    - '.github/workflows/ruff.yml'
+
+jobs:
+  ruff:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.x'
+    
+    - name: Install ruff
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install ruff
+    
+    - name: Run ruff linter
+      run: |
+        ruff check --output-format=github .
+    
+    #- name: Run ruff formatter (check only)
+    #  run: |
+    #    ruff format --check --diff .

.pre-commit-config.yaml

@@ -1,5 +1,16 @@
 ---
 repos:
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.8.4
+  hooks:
+  - id: ruff
+    name: ruff check
+    description: This runs ruff check. If errors occur use ruff check --fix.
+    entry: ruff
+    args: [ check ]
+    language: python
+    types: [python]
+
 - repo: local
   hooks:
   - id: yamllint

docs/conf.py

@@ -12,8 +12,8 @@
 #
 import os
 import sys
+
 # sys.path.insert(0, os.path.abspath('.'))
-import recommonmark
 from recommonmark.transform import AutoStructify
 
 # -- Project information -----------------------------------------------------
@@ -77,7 +77,6 @@
 on_rtd = os.environ.get("READTHEDOCS", None) == "True"
 
 if not on_rtd:  # only import and set the theme if we're building docs locally
-    import sphinx_rtd_theme
 
     html_theme = "sphinx_rtd_theme"
 ##    html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

netlab

@@ -7,8 +7,9 @@ import sys
 try:
   import netsim
   import netsim.cli
-except:
+except Exception as ex:
   print("Cannot import netsim Python module, netlab installation is broken")
+  print(ex)
   sys.exit(1)
 
 netsim.cli.lab_commands(__file__)

netsim/api/__init__.py

@@ -5,9 +5,9 @@
 
 from box import Box
 
-from ..data.validate import must_be_list
-from ..utils import log,strings
-from ..data import append_to_list,global_vars
+from ..data import append_to_list, global_vars
+from ..data.types import must_be_list
+from ..utils import log, strings
 
 '''
 get_config_name: get the name of configuration to be added to node.config attribute

netsim/augment/__init__.py

@@ -1,13 +1,3 @@
 # Import the whole augmentation tree
 
-from . import devices
-from . import nodes
-from . import groups
-from . import links
-from . import plugin
-from . import topology
-from . import config
-from . import components
-from . import tools
-from . import validate
-from . import main
+from . import components, config, devices, groups, links, main, nodes, plugin, tools, topology, validate

netsim/augment/addressing.py

@@ -48,18 +48,19 @@
 * _p2p_ and _p2p_subnet_ defaults are used to create _p2p_ pool
 '''
 
+import ipaddress
 import sys
-import typing
 import types
+import typing
 
-import ipaddress
 import netaddr
 from box import Box
 
 # Related modules
-from ..data import get_empty_box,get_box,null_to_string,global_vars
+from ..data import get_box, get_empty_box, global_vars, null_to_string
 from ..data.validate import validate_attributes
-from ..utils import log,strings
+from ..utils import log, strings
+
 
 def normalize_prefix(pfx: typing.Union[str,Box]) -> Box:
 

netsim/augment/components.py

@@ -5,16 +5,14 @@
 * Expands included components into groups, nodes and links
 '''
 
-import typing
-import re
 
 from box import Box
 
-from ..utils import log
 from .. import data
-from . import nodes,links
-from ..data.types import must_be_dict,must_be_list,must_be_string,must_be_id
 from ..data import global_vars
+from ..data.types import must_be_dict, must_be_id, must_be_string
+from ..utils import log
+from . import links, nodes
 
 '''
 Validate topology components:

netsim/augment/config.py

@@ -3,8 +3,11 @@
 #
 
 import typing
-from box import Box,BoxList
-from ..utils import log,files as _files
+
+from box import Box, BoxList
+
+from ..utils import files as _files
+from ..utils import log
 
 """
 Augment module attributes

netsim/augment/devices.py

@@ -8,7 +8,7 @@
 from box import Box
 
 from .. import data
-from ..utils import log,strings
+from ..utils import log, strings
 
 """
 Get generic device attribute:
@@ -103,7 +103,6 @@ def check_optional_features(
         category: typing.Optional[typing.Union[typing.Type[Warning],typing.Type[Exception]]] = None,
         features: typing.Optional[Box] = None) -> FC_MODE:
 
-  error = False
   module = attribute.split('.')[0]
   if features is None:              # Fetch the initial device features (we'll set the value in recursive calls)
     d_features = get_device_features(node,topology.defaults)