Merge pull request #3241 from c-po/spring-cleaning-sagitta

T6199: spring cleaning - drop unused Python imports (backport #3240)

.github/workflows/unused-imports.yml

@@ -0,0 +1,29 @@
+name: Check for unused imports using Pylint
+on:
+  pull_request_target:
+    types: [opened, reopened, ready_for_review, locked]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11"]
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install pylint
+    - name: Analysing the code with pylint
+      run: |
+        tmp=$(git ls-files *.py | xargs pylint | grep W0611 | wc -l)
+        if [[ $tmp -gt 0 ]]; then
+            echo "Found $tmp occurrence of unused Python import statements!"
+            exit 1
+        fi
+        exit 0

Makefile

@@ -112,12 +112,9 @@ endif
 sonar:
 	sonar-scanner -X -Dsonar.login=${SONAR_TOKEN}
 
-.PHONY: docs
-.ONESHELL:
-docs:
-	sphinx-apidoc -o sphinx/source/  python/
-	cd sphinx/
-	PYTHONPATH=../python make html
+.PHONY: unused-imports
+unused-imports:
+	git ls-files *.py | xargs pylint | grep W0611
 
 deb:
 	dpkg-buildpackage -uc -us -tc -b

debian/control

@@ -18,7 +18,6 @@ Build-Depends:
   python3-jinja2,
   python3-psutil,
   python3-setuptools,
-  python3-sphinx,
   python3-xmltodict,
   quilt,
   whois

python/vyos/accel_ppp.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 #
-# Copyright (C) 2022 VyOS maintainers and contributors
+# Copyright (C) 2022-2024 VyOS maintainers and contributors
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License version 2 or later as
@@ -13,14 +13,9 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
-#
-
-import sys
 
-import vyos.opmode
 from vyos.utils.process import rc_cmd
 
-
 def get_server_statistics(accel_statistics, pattern, sep=':') -> dict:
     import re
 

python/vyos/config.py

@@ -1,4 +1,4 @@
-# Copyright 2017, 2019-2023 VyOS maintainers and contributors <maintainers@vyos.io>
+# Copyright 2017-2024 VyOS maintainers and contributors <maintainers@vyos.io>
 #
 # This library is free software; you can redistribute it and/or
 # modify it under the terms of the GNU Lesser General Public
@@ -60,12 +60,10 @@
 while functions prefixed "effective" return values from the running config.
 
 In operational mode, all functions return values from the running config.
-
 """
 
 import re
 import json
-from copy import deepcopy
 from typing import Union
 
 import vyos.configtree

python/vyos/config_mgmt.py

@@ -1,4 +1,4 @@
-# Copyright 2023 VyOS maintainers and contributors <maintainers@vyos.io>
+# Copyright 2023-2024 VyOS maintainers and contributors <maintainers@vyos.io>
 #
 # This library is free software; you can redistribute it and/or
 # modify it under the terms of the GNU Lesser General Public
@@ -19,18 +19,23 @@
 import gzip
 import logging
 
-from typing import Optional, Tuple, Union
+from typing import Optional
+from typing import Tuple
 from filecmp import cmp
 from datetime import datetime
-from textwrap import dedent, indent
+from textwrap import dedent
 from pathlib import Path
 from tabulate import tabulate
 from shutil import copy, chown
-from urllib.parse import urlsplit, urlunsplit
+from urllib.parse import urlsplit
+from urllib.parse import urlunsplit
 
 from vyos.config import Config
-from vyos.configtree import ConfigTree, ConfigTreeError, show_diff
-from vyos.load_config import load, LoadConfigError
+from vyos.configtree import ConfigTree
+from vyos.configtree import ConfigTreeError
+from vyos.configtree import show_diff
+from vyos.load_config import load
+from vyos.load_config import LoadConfigError
 from vyos.defaults import directories
 from vyos.version import get_full_version_data
 from vyos.utils.io import ask_yes_no

python/vyos/configdict.py

@@ -1,4 +1,4 @@
-# Copyright 2019-2022 VyOS maintainers and contributors <maintainers@vyos.io>
+# Copyright 2019-2024 VyOS maintainers and contributors <maintainers@vyos.io>
 #
 # This library is free software; you can redistribute it and/or
 # modify it under the terms of the GNU Lesser General Public
@@ -203,8 +203,6 @@ def is_member(conf, interface, intftype=None):
     empty -> Interface is not a member
     key -> Interface is a member of this interface
     """
-    from vyos.ifconfig import Section
-
     ret_val = {}
     intftypes = ['bonding', 'bridge']
 

python/vyos/configdiff.py

@@ -1,4 +1,4 @@
-# Copyright 2020 VyOS maintainers and contributors <maintainers@vyos.io>
+# Copyright 2020-2024 VyOS maintainers and contributors <maintainers@vyos.io>
 #
 # This library is free software; you can redistribute it and/or
 # modify it under the terms of the GNU Lesser General Public
@@ -13,12 +13,12 @@
 # You should have received a copy of the GNU Lesser General Public License
 # along with this library.  If not, see <http://www.gnu.org/licenses/>.
 
-from enum import IntFlag, auto
+from enum import IntFlag
+from enum import auto
 
 from vyos.config import Config
 from vyos.configtree import DiffTree
 from vyos.configdict import dict_merge
-from vyos.configdict import list_diff
 from vyos.utils.dict import get_sub_dict
 from vyos.utils.dict import mangle_dict_keys
 from vyos.utils.dict import dict_search_args

python/vyos/configverify.py

@@ -23,8 +23,6 @@
 
 from vyos import ConfigError
 from vyos.utils.dict import dict_search
-from vyos.utils.dict import dict_search_recursive
-
 # pattern re-used in ipsec migration script
 dynamic_interface_pattern = r'(ppp|pppoe|sstpc|l2tp|ipoe)[0-9]+'
 
@@ -246,7 +244,6 @@ def verify_interface_exists(ifname, warning_only=False):
     if the interface is defined on the CLI, if it's not found we try if
     it exists at the OS level.
     """
-    import os
     from vyos.base import Warning
     from vyos.configquery import ConfigTreeQuery
     from vyos.utils.dict import dict_search_recursive
@@ -275,7 +272,7 @@ def verify_source_interface(config):
     required by e.g. peth/MACvlan, MACsec ...
     """
     import re
-    from netifaces import interfaces
+    from vyos.utils.network import interface_exists
 
     ifname = config['ifname']
     if 'source_interface' not in config:
@@ -287,7 +284,7 @@ def verify_source_interface(config):
     if tmp.match(src_ifname):
         raise ConfigError(f'Can not source "{ifname}" from dynamic interface "{src_ifname}"!')
 
-    if src_ifname not in interfaces():
+    if not interface_exists(src_ifname):
         raise ConfigError(f'Specified source-interface {src_ifname} does not exist')
 
     if 'source_interface_is_bridge_member' in config:

python/vyos/ethtool.py

@@ -13,7 +13,6 @@
 # You should have received a copy of the GNU Lesser General Public
 # License along with this library.  If not, see <http://www.gnu.org/licenses/>.
 
-import os
 import re
 
 from json import loads

python/vyos/firewall.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 #
-# Copyright (C) 2021-2023 VyOS maintainers and contributors
+# Copyright (C) 2021-2024 VyOS maintainers and contributors
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License version 2 or later as
@@ -30,7 +30,6 @@
 from vyos.template import render
 from vyos.utils.dict import dict_search_args
 from vyos.utils.dict import dict_search_recursive
-from vyos.utils.process import call
 from vyos.utils.process import cmd
 from vyos.utils.process import run
 

python/vyos/frr.py

@@ -1,4 +1,4 @@
-# Copyright 2020 VyOS maintainers and contributors <maintainers@vyos.io>
+# Copyright 2020-2024 VyOS maintainers and contributors <maintainers@vyos.io>
 #
 # This library is free software; you can redistribute it and/or
 # modify it under the terms of the GNU Lesser General Public
@@ -69,7 +69,6 @@
 import re
 
 from vyos import ConfigError
-from vyos.utils.permission import chown
 from vyos.utils.process import cmd
 from vyos.utils.process import popen
 from vyos.utils.process import STDOUT

python/vyos/ifconfig/bond.py

@@ -1,4 +1,4 @@
-# Copyright 2019-2022 VyOS maintainers and contributors <maintainers@vyos.io>
+# Copyright 2019-2024 VyOS maintainers and contributors <maintainers@vyos.io>
 #
 # This library is free software; you can redistribute it and/or
 # modify it under the terms of the GNU Lesser General Public
@@ -16,7 +16,6 @@
 import os
 
 from vyos.ifconfig.interface import Interface
-from vyos.utils.process import cmd
 from vyos.utils.dict import dict_search
 from vyos.utils.assertion import assert_list
 from vyos.utils.assertion import assert_positive

python/vyos/ifconfig/bridge.py

@@ -13,13 +13,12 @@
 # You should have received a copy of the GNU Lesser General Public
 # License along with this library.  If not, see <http://www.gnu.org/licenses/>.
 
-from netifaces import interfaces
-
 from vyos.ifconfig.interface import Interface
 from vyos.utils.assertion import assert_boolean
 from vyos.utils.assertion import assert_list
 from vyos.utils.assertion import assert_positive
 from vyos.utils.dict import dict_search
+from vyos.utils.network import interface_exists
 from vyos.configdict import get_vlan_ids
 from vyos.configdict import list_diff
 
@@ -314,7 +313,7 @@ def update(self, config):
         # remove interface from bridge
         tmp = dict_search('member.interface_remove', config)
         for member in (tmp or []):
-            if member in interfaces():
+            if interface_exists(member):
                 self.del_port(member)
 
         # enable/disable VLAN Filter
@@ -345,7 +344,7 @@ def update(self, config):
             for interface, interface_config in tmp.items():
                 # if interface does yet not exist bail out early and
                 # add it later
-                if interface not in interfaces():
+                if not interface_exists(interface):
                     continue
 
                 # Bridge lower "physical" interface

python/vyos/ifconfig/interface.py

@@ -35,7 +35,6 @@
 from vyos.template import render
 from vyos.utils.network import mac2eui64
 from vyos.utils.dict import dict_search
-from vyos.utils.file import read_file
 from vyos.utils.network import get_interface_config
 from vyos.utils.network import get_interface_namespace
 from vyos.utils.process import is_systemd_service_active

python/vyos/ifconfig/vrrp.py

@@ -1,4 +1,4 @@
-# Copyright 2019-2023 VyOS maintainers and contributors <maintainers@vyos.io>
+# Copyright 2019-2024 VyOS maintainers and contributors <maintainers@vyos.io>
 #
 # This library is free software; you can redistribute it and/or
 # modify it under the terms of the GNU Lesser General Public
@@ -18,7 +18,6 @@
 import signal
 
 from time import time
-from time import sleep
 from tabulate import tabulate
 
 from vyos.configquery import ConfigTreeQuery
@@ -155,4 +154,3 @@ def format(cls, data):
         # add to the active list disabled instances
         groups.extend(cls.disabled())
         return(tabulate(groups, headers))
-

python/vyos/ifconfig/vxlan.py

@@ -1,4 +1,4 @@
-# Copyright 2019-2023 VyOS maintainers and contributors <maintainers@vyos.io>
+# Copyright 2019-2024 VyOS maintainers and contributors <maintainers@vyos.io>
 #
 # This library is free software; you can redistribute it and/or
 # modify it under the terms of the GNU Lesser General Public
@@ -13,9 +13,6 @@
 # You should have received a copy of the GNU Lesser General Public
 # License along with this library.  If not, see <http://www.gnu.org/licenses/>.
 
-from json import loads
-
-from vyos import ConfigError
 from vyos.configdict import list_diff
 from vyos.ifconfig import Interface
 from vyos.utils.assertion import assert_list

python/vyos/ifconfig/wireguard.py

@@ -1,4 +1,4 @@
-# Copyright 2019-2023 VyOS maintainers and contributors <maintainers@vyos.io>
+# Copyright 2019-2024 VyOS maintainers and contributors <maintainers@vyos.io>
 #
 # This library is free software; you can redistribute it and/or
 # modify it under the terms of the GNU Lesser General Public
@@ -25,7 +25,6 @@
 from vyos.ifconfig import Interface
 from vyos.ifconfig import Operational
 from vyos.template import is_ipv6
-from vyos.base import Warning
 
 class WireGuardOperational(Operational):
     def _dump(self):

python/vyos/iflag.py

@@ -1,4 +1,4 @@
-# Copyright 2019 VyOS maintainers and contributors <maintainers@vyos.io>
+# Copyright 2019-2024 VyOS maintainers and contributors <maintainers@vyos.io>
 #
 # This library is free software; you can redistribute it and/or
 # modify it under the terms of the GNU Lesser General Public
@@ -13,26 +13,24 @@
 # You should have received a copy of the GNU Lesser General Public
 # License along with this library.  If not, see <http://www.gnu.org/licenses/>.
 
-from enum import Enum, unique, IntEnum
-
+from enum import IntEnum
 
 class IFlag(IntEnum):
     """ net/if.h interface flags """
 
-    IFF_UP = 0x1	        #: Interface up/down status
-    IFF_BROADCAST = 0x2	    #: Broadcast address valid
-    IFF_DEBUG = 0x4,		#: Debugging
-    IFF_LOOPBACK = 0x8		#: Is loopback network
-    IFF_POINTOPOINT = 0x10	#: Is point-to-point link
-    IFF_NOTRAILERS = 0x20	#: Avoid use of trailers 
-    IFF_RUNNING = 0x40		#: Resources allocated 
-    IFF_NOARP = 0x80		#: No address resolution protocol
-    IFF_PROMISC = 0x100	    #: Promiscuous mode
-    IFF_ALLMULTI = 0x200	#: Receive all multicast 
-    IFF_MASTER = 0x400		#: Load balancer master
-    IFF_SLAVE = 0x800		#: Load balancer slave
-    IFF_MULTICAST = 0x1000	#: Supports multicast
-    IFF_PORTSEL = 0x2000	#: Media type adjustable
-    IFF_AUTOMEDIA = 0x4000  #: Automatic media type enabled	
-    IFF_DYNAMIC = 0x8000	#: Is a dial-up device with dynamic address
-
+    IFF_UP = 0x1            #: Interface up/down status
+    IFF_BROADCAST = 0x2     #: Broadcast address valid
+    IFF_DEBUG = 0x4,        #: Debugging
+    IFF_LOOPBACK = 0x8      #: Is loopback network
+    IFF_POINTOPOINT = 0x10  #: Is point-to-point link
+    IFF_NOTRAILERS = 0x20   #: Avoid use of trailers
+    IFF_RUNNING = 0x40      #: Resources allocated
+    IFF_NOARP = 0x80        #: No address resolution protocol
+    IFF_PROMISC = 0x100     #: Promiscuous mode
+    IFF_ALLMULTI = 0x200    #: Receive all multicast
+    IFF_MASTER = 0x400      #: Load balancer master
+    IFF_SLAVE = 0x800       #: Load balancer slave
+    IFF_MULTICAST = 0x1000  #: Supports multicast
+    IFF_PORTSEL = 0x2000    #: Media type adjustable
+    IFF_AUTOMEDIA = 0x4000  #: Automatic media type enabled
+    IFF_DYNAMIC = 0x8000    #: Is a dial-up device with dynamic address