flake8

Author: themylogin

.github/workflows/lint.yml

@@ -0,0 +1,23 @@
+name: flake8
+
+on:
+  pull_request:
+    types:
+      - 'synchronize'
+      - 'opened'
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python 3.11
+      uses: actions/setup-python@v3
+      with:
+        python-version: 3.11
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install flake8
+    - name: Analyze the code with flake8
+      run: flake8 .

tox.ini

@@ -0,0 +1,3 @@
+[flake8]
+ignore = F403,F405,W504
+max-line-length = 120

truenas_api_client/__init__.py

@@ -55,7 +55,7 @@
 
 from . import ejson as json
 from .config import CALL_TIMEOUT
-from .exc import ReserveFDException, ClientException, ErrnoMixin, ValidationErrors, CallTimeout
+from .exc import ReserveFDException, ClientException, ErrnoMixin, ValidationErrors, CallTimeout  # noqa
 from .legacy import LegacyClient
 from .jsonrpc import CollectionUpdateParams, ErrorObj, JobFields, JSONRPCError, JSONRPCMessage, TruenasError
 from .utils import MIDDLEWARE_RUN_DIR, ProgressBar, undefined, UndefinedType, set_socket_options
@@ -76,9 +76,8 @@ def uri_check(self, uri: str | None, py_exceptions: bool):
         if uri and py_exceptions and not uri.startswith(UNIX_SOCKET_PREFIX):
             raise ClientException('py_exceptions are only allowed for connections to unix domain socket')
 
-
-    def __init__(self, uri: str | None=None, reserved_ports=False, private_methods=False, py_exceptions=False,
-                 log_py_exceptions=False, call_timeout: float | UndefinedType=undefined, verify_ssl=True):
+    def __init__(self, uri: str | None = None, reserved_ports=False, private_methods=False, py_exceptions=False,
+                 log_py_exceptions=False, call_timeout: float | UndefinedType = undefined, verify_ssl=True):
         """Initialize either a `JSONRPCClient` or a `LegacyClient`.
 
         Use `JSONRPCClient` unless `uri` ends with '/websocket'.
@@ -124,7 +123,7 @@ class WSClient:
     The object used by `JSONRPCClient` to send and receive data.
 
     """
-    def __init__(self, url: str, *, client: 'JSONRPCClient', reserved_ports: bool=False, verify_ssl: bool=True):
+    def __init__(self, url: str, *, client: 'JSONRPCClient', reserved_ports: bool = False, verify_ssl: bool = True):
         """Initialize a `WSClient`.
 
         Args:
@@ -303,7 +302,7 @@ class Job:
     Every `Job` is responsible for a corresponding `_JobDict` in the client's list of jobs.
 
     """
-    def __init__(self, client: 'JSONRPCClient', job_id: str, callback: _JobCallback | None=None):
+    def __init__(self, client: 'JSONRPCClient', job_id: str, callback: _JobCallback | None = None):
         """Initialize `Job`.
 
         Args:
@@ -705,9 +704,9 @@ def _jobs_subscribe(self):
         self._jobs_watching = True
         self.subscribe('core.get_jobs', self._jobs_callback, sync=True)
 
-    def call(self, method: str, *params, background=False, callback: _JobCallback | None=None,
-             job: Literal['RETURN'] | bool=False, register_call: bool | None=None,
-             timeout: float | UndefinedType=undefined) -> Any:
+    def call(self, method: str, *params, background=False, callback: _JobCallback | None = None,
+             job: Literal['RETURN'] | bool = False, register_call: bool | None = None,
+             timeout: float | UndefinedType = undefined) -> Any:
         """The primary way to send call requests to the API.
 
         Send a JSON-RPC v2.0 Request to the server.
@@ -761,8 +760,8 @@ def call(self, method: str, *params, background=False, callback: _JobCallback |
             if not background:
                 self._unregister_call(c)
 
-    def wait(self, c: Call, *, callback: _JobCallback | None=None, job: Literal['RETURN'] | bool=False,
-             timeout: float | UndefinedType=undefined) -> Any:
+    def wait(self, c: Call, *, callback: _JobCallback | None = None, job: Literal['RETURN'] | bool = False,
+             timeout: float | UndefinedType = undefined) -> Any:
         """Wait for an API call to return and return its result.
 
         Args:
@@ -820,8 +819,8 @@ def event_payload() -> _Payload:
             'event': Event(),
         }
 
-    def subscribe(self, name: str, callback: _EventCallbackProtocol, payload: _Payload | None=None,
-                  sync: bool=False) -> str:
+    def subscribe(self, name: str, callback: _EventCallbackProtocol, payload: _Payload | None = None,
+                  sync: bool = False) -> str:
         """Subscribe to an event by calling `core.subscribe`.
 
         Args:
@@ -859,7 +858,7 @@ def unsubscribe(self, id_: str):
             else:
                 self._event_callbacks.pop(k)
 
-    def ping(self, timeout: float=10) -> Literal['pong']:
+    def ping(self, timeout: float = 10) -> Literal['pong']:
         """Call `core.ping` to verify connection to the server.
 
         Args:

truenas_api_client/ejson.py

@@ -73,7 +73,10 @@ def object_hook(obj: dict):
         if obj_len == 1:
             error_key = list(obj.keys())[0]
             if '$date' in obj:
-                return datetime.fromtimestamp(obj['$date'] / 1000, tz=timezone.utc) + timedelta(milliseconds=obj['$date'] % 1000)
+                return (
+                    datetime.fromtimestamp(obj['$date'] / 1000, tz=timezone.utc) +
+                    timedelta(milliseconds=obj['$date'] % 1000)
+                )
             if '$time' in obj:
                 return time(*[int(i) for i in obj['$time'].split(':')[:4]])  # type: ignore
             if '$set' in obj:

truenas_api_client/exc.py

@@ -60,8 +60,8 @@ def _get_errname(cls, code: int) -> str | None:
 class ClientException(ErrnoMixin, Exception):
     """Represents any exception that might arise from a `Client`."""
 
-    def __init__(self, error: str, errno: int | None=None, trace: TruenasTraceback | None=None,
-                 extra: list[ErrorExtra] | None=None):
+    def __init__(self, error: str, errno: int | None = None, trace: TruenasTraceback | None = None,
+                 extra: list[ErrorExtra] | None = None):
         """Initialize `ClientException`.
 
         Args:

truenas_api_client/legacy.py

@@ -26,6 +26,7 @@
 
 logger = logging.getLogger(__name__)
 
+
 class WSClient:
     def __init__(self, url, *, client, reserved_ports=False, verify_ssl=True):
         self.url = url
@@ -178,7 +179,7 @@ def result(self):
 
 class LegacyClient:
     def __init__(self, uri=None, reserved_ports=False, private_methods=False, py_exceptions=False,
-                 log_py_exceptions=False, call_timeout: float | UndefinedType=undefined, verify_ssl=True):
+                 log_py_exceptions=False, call_timeout: float | UndefinedType = undefined, verify_ssl=True):
         """
         Arguments:
            :reserved_ports(bool): should the local socket used a reserved port

truenas_api_client/utils.py

@@ -16,12 +16,15 @@
 
 MIDDLEWARE_RUN_DIR = '/var/run/middleware'
 
+
 @final
 class UndefinedType:
     def __new__(cls):
         if not hasattr(cls, '_instance'):
             cls._instance = super().__new__(cls)
         return cls._instance
+
+
 undefined = UndefinedType()
 
 
@@ -107,7 +110,7 @@ def draw(self):
         )
         self.write_stream.flush()
 
-    def update(self, percentage: float | None=None, message: str | None=None):
+    def update(self, percentage: float | None = None, message: str | None = None):
         """Update the progress bar with a new percentage and/or message, redrawing it.
 
         Args: