Formatting,lint and pre-commit fixes

Author: Alan Fleming

.pre-commit-config.yaml

@@ -38,14 +38,14 @@ repos:
     rev: 'v0.8.1'
     hooks:
       - id: taplo
-  - repo: local
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.1.9
     hooks:
-      - id: ruff-format-hatch-settings
-        name: hatch-ruff
-        language: system
-        entry: hatch fmt
-        pass_filenames: false
-        verbose: true
+      - id: ruff
+        types_or: [python, jupyter]
+        args: ['--fix', '--show-fixes']
+      - id: ruff-format
+        types_or: [python, jupyter]
   - repo: https://github.com/codespell-project/codespell
     rev: 'v2.2.6'
     hooks:

docs/conf.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 extensions = ["myst_parser", "jupyterlite_sphinx"]
 
 jupyterlite_config = "jupyter_lite_config.json"

examples/generic.ipynb

@@ -114,7 +114,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "t = app.shell.expandLeft()"
+    "t = app.shell.expandLeft()  # Built in"
    ]
   },
   {
@@ -123,7 +123,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "t = app.execute_method(\"shell.expandLeft\")"
+    "t = app.execute_method(\"shell.collapseLeft\")  # Generic"
    ]
   },
   {
@@ -253,7 +253,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.12.1"
+   "version": "3.10.13"
   }
  },
  "nbformat": 4,

ipylab/__main__.py

@@ -1,6 +1,6 @@
 # Copyright (c) ipylab contributors.
 # Distributed under the terms of the Modified BSD License.
-
+from __future__ import annotations
 
 import sys
 

ipylab/_frontend.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import json
 import pathlib
 

ipylab/commands.py

@@ -1,5 +1,6 @@
 # Copyright (c) ipylab contributors.
 # Distributed under the terms of the Modified BSD License.
+from __future__ import annotations
 
 import asyncio
 from collections.abc import Callable

ipylab/jupyterfrontend_subsection.py

@@ -1,5 +1,6 @@
 # Copyright (c) ipylab contributors.
 # Distributed under the terms of the Modified BSD License.
+from __future__ import annotations
 
 import asyncio
 from collections.abc import Callable, Coroutine

pyproject.toml

@@ -103,3 +103,30 @@ extend-include = ["*.ipynb"]
 skip = 'yarn.lock,node_modules*,lib,.yarn*,./ipylab*'
 ignore-words-list = 'statics'
 write = true
+
+[tool.ruff.lint]
+extend-select = [
+  "B",    # flake8-bugbear
+  "I",    # isort
+  "ARG",  # flake8-unused-arguments
+  "C4",   # flake8-comprehensions
+  "EM",   # flake8-errmsg
+  "ICN",  # flake8-import-conventions
+  "G",    # flake8-logging-format
+  "PGH",  # pygrep-hooks
+  "PIE",  # flake8-pie
+  "PL",   # pylint
+  "PT",   # flake8-pytest-style
+  "PTH",  # flake8-use-pathlib
+  "RET",  # flake8-return
+  "RUF",  # Ruff-specific
+  "SIM",  # flake8-simplify
+  "T20",  # flake8-print
+  "UP",   # pyupgrade
+  "YTT",  # flake8-2020
+  "EXE",  # flake8-executable
+  "NPY",  # NumPy specific rules
+  "PD",   # pandas-vet
+  "FURB", # refurb
+  "PYI",  # flake8-pyi
+]

setup.py

@@ -1 +1,3 @@
+from __future__ import annotations
+
 __import__("setuptools").setup()

src/widgets/commands.ts

@@ -63,14 +63,16 @@ export class CommandRegistryModel extends IpylabModel {
   }
 
   async operation(op: string, payload: any): Promise<JSONValue> {
+    let id, args, result, commands;
     switch (op) {
       case 'execute':
-        const { id, args } = payload;
+        id = payload.id;
+        args = payload.args;
         return await this._commands.execute(id, args);
       case 'addPythonCommand': {
-        const result = await this._addCommand(payload);
+        result = await this._addCommand(payload);
         // keep track of the commands
-        const commands = this.get('_commands');
+        commands = this.get('_commands');
         this.set('_commands', commands.concat(payload));
         this.save_changes();
         return result;

src/widgets/ipylab.ts

@@ -175,7 +175,7 @@ export class IpylabModel extends DOMWidgetModel {
           obj,
           kwgs.method.split('.').slice(0, -1).join('.')
         );
-        let func = getNestedObject(this, kwgs.method) as Function;
+        let func = getNestedObject(this, kwgs.method);
         func = func.bind(owner, ...(payload as any).args);
         return await func();
       }
@@ -261,10 +261,7 @@ export class IpylabModel extends DOMWidgetModel {
     ...WidgetModel.serializers
   };
 
-  private _pending_backend_operation_callbacks: Map<
-    string,
-    [Function, Function]
-  >;
+  private _pending_backend_operation_callbacks: Map<string, [any, any]>;
   private _kernelId: string;
   static python_backend = new PythonBackendModel();
   static model_name: string;

src/widgets/utils.ts

@@ -231,6 +231,9 @@ export function transformObject(
   thisArg: object = null
 ): JSONValue {
   const mode = typeof options === 'string' ? options : options.mode;
+
+  let path: string, transform: string, result, part: string, func;
+
   switch (mode) {
     case 'done':
       return IpylabModel.OPERATION_DONE;
@@ -243,20 +246,21 @@ export function transformObject(
     case 'attribute':
       // expects simple: {parts:['dotted.attribute']}
       // or advanced: {parts:[{path:'dotted.attribute', transform:'...' }]
-      const result: { [key: string]: any } = new Object();
+      result = new Object();
       for (let i = 0; i < options.parts.length; i++) {
         if (typeof options.parts[i] === 'string') {
-          var path = options.parts[i];
-          var transform: any = 'raw';
+          path = options.parts[i];
+          transform = 'raw';
         } else {
-          var { path, transform } = options.parts[i];
+          path = options.parts[i].path;
+          transform = options.parts[i].transform;
         }
-        const part = getNestedObject(obj, path);
-        result[path] = transformObject(part, transform);
+        part = getNestedObject(obj, path);
+        (result as any)[path] = transformObject(part, transform);
       }
-      return result;
+      return result as any;
     case 'function':
-      var func = toFunction(options.code).bind(thisArg);
+      func = toFunction(options.code).bind(thisArg);
       return func(obj);
     default:
       throw new Error(`Invalid return mode: '${options.mode}'`);