Merge pull request #54 from ushiboy/release/1.1.0

Release 1.1.0

Author: ushiboy

.github/workflows/action.yml

@@ -7,7 +7,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ['3.7', '3.8', '3.9']
+        python-version: ['3.7', '3.8', '3.9', '3.10']
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-python@v2

README.md

@@ -189,16 +189,20 @@ nmcli.device.status() -> List[Device]
 
 Show details of device.
 
+The `fields` argument applies the same effect to the command as the `-f | --fields` option. If it is omitted, the default behavior is followed.
+
 ```
-nmcli.device.show(ifname: str) -> DeviceDetails
+nmcli.device.show(ifname: str, fields: str = None) -> DeviceDetails
 ```
 
 #### nmcli.device.show_all
 
 Show details of devices.
 
+The `fields` argument applies the same effect to the command as the `-f | --fields` option. If it is omitted, the default behavior is followed.
+
 ```
-nmcli.device.show_all() -> List[DeviceDetails]
+nmcli.device.show_all(fields: str = None) -> List[DeviceDetails]
 ```
 
 #### nmcli.device.connect
@@ -455,6 +459,10 @@ nmcli.set_lang(lang: str) -> None
 
 ## Change Log
 
+### 1.1.0
+
+- Added fields option to `nmcli.device.show` and `nmcli.device.show_all`
+
 ### 1.0.0
 
 - Handle connection failure exceptions with `nmcli.device.wifi_connect`.

nmcli/_device.py

@@ -2,7 +2,7 @@
 from typing import List, Tuple
 
 from ._exception import ConnectionActivateFailedException
-from ._helper import add_wait_option_if_needed, add_fields_option_if_needed
+from ._helper import add_fields_option_if_needed, add_wait_option_if_needed
 from ._system import SystemCommand, SystemCommandInterface
 from .data.device import Device, DeviceDetails, DeviceWifi
 from .data.hotspot import Hotspot
@@ -42,10 +42,10 @@ def __call__(self) -> List[Device]:
     def status(self) -> List[Device]:
         raise NotImplementedError
 
-    def show(self, ifname: str, fields: str) -> DeviceDetails:
+    def show(self, ifname: str, fields: str = None) -> DeviceDetails:
         raise NotImplementedError
 
-    def show_all(self, fields: str) -> List[DeviceDetails]:
+    def show_all(self, fields: str = None) -> List[DeviceDetails]:
         raise NotImplementedError
 
     def connect(self, ifname: str, wait: int = None) -> None:

nmcli/_helper.py

@@ -4,5 +4,6 @@
 def add_wait_option_if_needed(wait: int = None) -> List[str]:
     return [] if wait is None else ['--wait', str(wait)]
 
+
 def add_fields_option_if_needed(fields: str = None) -> List[str]:
     return [] if fields is None else ['-f', fields]

nmcli/dummy/_device.py

@@ -56,7 +56,7 @@ def __init__(self,
         self._result_show = result_show
         self._result_show_all = result_show_all or []
         self._result_wifi_hotspot = result_wifi_hotspot
-        self._show_args: List[str] = []
+        self._show_args: List[Tuple] = []
         self._connect_args: List[Tuple] = []
         self._disconnect_args: List[Tuple] = []
         self._reapply_args: List[str] = []
@@ -74,14 +74,14 @@ def status(self) -> List[Device]:
         self._raise_error_if_needed()
         return self._result_call
 
-    def show(self, ifname: str) -> DeviceDetails:
+    def show(self, ifname: str, fields: str = None) -> DeviceDetails:
         self._raise_error_if_needed()
-        self._show_args.append(ifname)
+        self._show_args.append((ifname, fields))
         if not self._result_show is None:
             return self._result_show
         raise ValueError("'result_show' is not properly initialized")
 
-    def show_all(self) -> List[DeviceDetails]:
+    def show_all(self, fields: str = None) -> List[DeviceDetails]:
         self._raise_error_if_needed()
         return self._result_show_all
 

setup.py

@@ -13,7 +13,7 @@ def run_tests(self):
 
 setup(
     name='nmcli',
-    version='1.0.0',
+    version='1.1.0',
     author='ushiboy',
     license='MIT',
     description='A python wrapper library for the network-manager cli client',

tests/dummy/test_device.py

@@ -33,7 +33,11 @@ def test_show():
     c = DummyDeviceControl(result_show=result_show)
     ifname = 'eth0'
     assert c.show(ifname) == result_show
-    assert c.show_args == [ifname]
+    assert c.show_args == [(ifname, None)]
+
+    fields = 'all'
+    assert c.show(ifname, fields) == result_show
+    assert c.show_args == [(ifname, None), (ifname, fields)]
 
 
 def test_show_when_raise_error():

tests/test_device.py

@@ -60,8 +60,8 @@ def test_show():
 IP6.ADDRESS[1]:                         ::1/128
 IP6.GATEWAY:                            --
 IP6.ROUTE[1]:                           dst = ::1/128, nh = ::, mt = 256'''
-    s = DummySystemCommand(d)
-    device = DeviceControl(s)
+    s1 = DummySystemCommand(d)
+    device = DeviceControl(s1)
     assert device.show('lo') == {
         'GENERAL.DEVICE': 'lo',
         'GENERAL.TYPE': 'loopback',
@@ -76,7 +76,25 @@ def test_show():
         'IP6.GATEWAY': None,
         'IP6.ROUTE[1]': 'dst = ::1/128, nh = ::, mt = 256'
     }
-    assert s.passed_parameters == ['device', 'show', 'lo']
+    assert s1.passed_parameters == ['device', 'show', 'lo']
+
+    s2 = DummySystemCommand(d)
+    device = DeviceControl(s2)
+    assert device.show('lo', 'all') == {
+        'GENERAL.DEVICE': 'lo',
+        'GENERAL.TYPE': 'loopback',
+        'GENERAL.HWADDR': '00:00:00:00:00:00',
+        'GENERAL.MTU': '65536',
+        'GENERAL.STATE': '10 (unmanaged)',
+        'GENERAL.CONNECTION': None,
+        'GENERAL.CON-PATH': None,
+        'IP4.ADDRESS[1]': '127.0.0.1/8',
+        'IP4.GATEWAY': None,
+        'IP6.ADDRESS[1]': '::1/128',
+        'IP6.GATEWAY': None,
+        'IP6.ROUTE[1]': 'dst = ::1/128, nh = ::, mt = 256'
+    }
+    assert s2.passed_parameters == ['-f', 'all', 'device', 'show', 'lo']
 
 
 def test_show_all():
@@ -100,8 +118,8 @@ def test_show_all():
 IP6.ADDRESS[1]:                         ::1/128
 IP6.GATEWAY:                            --
 IP6.ROUTE[1]:                           dst = ::1/128, nh = ::, mt = 256'''
-    s = DummySystemCommand(d)
-    device = DeviceControl(s)
+    s1 = DummySystemCommand(d)
+    device = DeviceControl(s1)
     assert device.show_all() == [{
         'GENERAL.DEVICE': 'wlan0',
         'GENERAL.TYPE': 'wifi',
@@ -124,7 +142,33 @@ def test_show_all():
         'IP6.GATEWAY': None,
         'IP6.ROUTE[1]': 'dst = ::1/128, nh = ::, mt = 256'
     }]
-    assert s.passed_parameters == ['device', 'show']
+    assert s1.passed_parameters == ['device', 'show']
+
+    s2 = DummySystemCommand(d)
+    device = DeviceControl(s2)
+    assert device.show_all('all') == [{
+        'GENERAL.DEVICE': 'wlan0',
+        'GENERAL.TYPE': 'wifi',
+        'GENERAL.HWADDR': '46:7B:1F:32:36:E2',
+        'GENERAL.MTU': '1500',
+        'GENERAL.STATE': '30 (disconnected)',
+        'GENERAL.CONNECTION': None,
+        'GENERAL.CON-PATH': None
+    }, {
+        'GENERAL.DEVICE': 'lo',
+        'GENERAL.TYPE': 'loopback',
+        'GENERAL.HWADDR': '00:00:00:00:00:00',
+        'GENERAL.MTU': '65536',
+        'GENERAL.STATE': '10 (unmanaged)',
+        'GENERAL.CONNECTION': None,
+        'GENERAL.CON-PATH': None,
+        'IP4.ADDRESS[1]': '127.0.0.1/8',
+        'IP4.GATEWAY': None,
+        'IP6.ADDRESS[1]': '::1/128',
+        'IP6.GATEWAY': None,
+        'IP6.ROUTE[1]': 'dst = ::1/128, nh = ::, mt = 256'
+    }]
+    assert s2.passed_parameters == ['-f', 'all', 'device', 'show']
 
 
 def test_connect():

tests/test_helper.py

@@ -1,8 +1,16 @@
-from nmcli._helper import add_wait_option_if_needed
+from nmcli._helper import (add_fields_option_if_needed,
+                           add_wait_option_if_needed)
 
 
 def test_add_wait_option_if_needed():
     assert add_wait_option_if_needed(10) == ['--wait', '10']
     assert add_wait_option_if_needed(11) == ['--wait', '11']
     assert not add_wait_option_if_needed()
     assert not add_wait_option_if_needed(None)
+
+
+def test_add_fields_option_if_needed():
+    assert add_fields_option_if_needed('all') == ['-f', 'all']
+    assert add_fields_option_if_needed('common') == ['-f', 'common']
+    assert not add_fields_option_if_needed()
+    assert not add_fields_option_if_needed(None)