targetcli 3.0.0.dev0__tar.gz → 3.0.2__tar.gz

{targetcli-3.0.0.dev0 → targetcli-3.0.2}/.pre-commit-config.yaml

@@ -1,12 +1,12 @@
 repos:
-  - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: v0.4.2
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.14.10
     hooks:
       - id: ruff
         args: [--fix]
 
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.6.0
+    rev: v6.0.0
     hooks:
       - id: check-case-conflict
       - id: check-ast
@@ -20,3 +20,15 @@ repos:
       - id: debug-statements
       - id: end-of-file-fixer
       - id: trailing-whitespace
+        args: [--markdown-linebreak-ext=md]
+
+  - repo: https://github.com/packit/pre-commit-hooks
+    rev: v1.3.0
+    hooks:
+      - id: validate-config
+
+ci:
+  autofix_commit_msg: |
+    Auto fixes from pre-commit.com hooks
+  autofix_prs: false
+  autoupdate_schedule: monthly

{targetcli-3.0.0.dev0 → targetcli-3.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: targetcli
-Version: 3.0.0.dev0
+Version: 3.0.2
 Summary: A command shell for managing the Linux LIO kernel target
 Project-URL: Homepage, http://github.com/open-iscsi/targetcli-fb
 Author-email: Andy Grover <agrover@redhat.com>
@@ -50,10 +50,10 @@ Contribute
 ----------
 targetcli complies with PEP 621 and as such can be built and installed with tools like `build` and `pip`.
 
-For development, consider using [Hatch](https://hatch.pypa.io):
-`hatch shell` to create and enter a Python virtualenv with the project installed in editable mode
-`pre-commit install` to enable pre-commit hooks
-`hatch build` to create tarball and wheel
+For development, consider using [Hatch](https://hatch.pypa.io):  
+`hatch shell` to create and enter a Python virtualenv with the project installed in editable mode  
+`pre-commit install` to enable pre-commit hooks  
+`hatch build` to create tarball and wheel  
 
 "fb" -- "free branch"
 ---------------------

{targetcli-3.0.0.dev0 → targetcli-3.0.2}/README.md

@@ -31,10 +31,10 @@ Contribute
 ----------
 targetcli complies with PEP 621 and as such can be built and installed with tools like `build` and `pip`.
 
-For development, consider using [Hatch](https://hatch.pypa.io):
-`hatch shell` to create and enter a Python virtualenv with the project installed in editable mode
-`pre-commit install` to enable pre-commit hooks
-`hatch build` to create tarball and wheel
+For development, consider using [Hatch](https://hatch.pypa.io):  
+`hatch shell` to create and enter a Python virtualenv with the project installed in editable mode  
+`pre-commit install` to enable pre-commit hooks  
+`hatch build` to create tarball and wheel  
 
 "fb" -- "free branch"
 ---------------------

{targetcli-3.0.0.dev0 → targetcli-3.0.2}/pyproject.toml

@@ -96,6 +96,7 @@ ignore = [
     "ARG002", "PLR6301",  # TODO Unused self, parameter in methods definitions
     "PLR09",  # Too many branches/statements/arguments
     "PLW1514", # TODO `open` in text mode without explicit `encoding` argument
+    "UP031",  # Use format specifiers instead of percent format
 ]
 [tool.ruff.lint.flake8-quotes]
 # Single quotes are currently prevalent in the codebase. Not being checked.

{targetcli-3.0.0.dev0 → targetcli-3.0.2}/src/targetcli/targetcli_shell.py

@@ -26,8 +26,8 @@ import struct
 import sys
 from os import getenv, getuid
 
-from configshell_fb import ConfigShell, ExecutionError
-from rtslib_fb import RTSLibError
+from configshell import ConfigShell, ExecutionError
+from rtslib import RTSLibError
 
 from targetcli import __version__ as targetcli_version
 from targetcli.ui_root import UIRoot
@@ -308,11 +308,11 @@ def main():
     if not is_root:
         shell.con.display("You are not root, disabling privileged commands.\n")
 
-    try:
-        while not shell._exit:
+    while not shell._exit:
+        try:
             shell.run_interactive()
-    except (RTSLibError, ExecutionError) as msg:
-        shell.log.error(str(msg))
+        except (RTSLibError, ExecutionError) as msg:  # noqa: PERF203 - would otherwise exit shell
+            shell.log.error(str(msg))
 
     if shell.prefs['auto_save_on_exit'] and is_root:
         shell.log.info("Global pref auto_save_on_exit=true")

{targetcli-3.0.0.dev0 → targetcli-3.0.2}/src/targetcli/targetclid.py

@@ -31,7 +31,7 @@ from os import getenv, getuid
 from pathlib import Path
 from threading import Thread
 
-from configshell_fb import ConfigShell
+from configshell import ConfigShell
 
 from targetcli import __version__ as targetcli_version
 from targetcli.ui_root import UIRoot
@@ -153,7 +153,7 @@ class TargetCLI:
                 connection.close()
                 still_listen = False
             else:
-                self.con._stdout = self.con._stderr = f = tempfile.NamedTemporaryFile(mode='w', delete=False)
+                self.con._stdout = self.con._stderr = f = tempfile.NamedTemporaryFile(mode='w', delete=False)  # noqa: SIM115
                 try:
                     # extract multiple commands delimited with '%'
                     list_data = data.decode().split('%')

{targetcli-3.0.0.dev0 → targetcli-3.0.2}/src/targetcli/ui_backstore.py

@@ -26,9 +26,9 @@ import stat
 import struct
 from pathlib import Path
 
-from configshell_fb import ExecutionError
+from configshell import ExecutionError
 from gi.repository import Gio
-from rtslib_fb import (
+from rtslib import (
     ALUATargetPortGroup,
     BlockStorageObject,
     FileIOStorageObject,
@@ -38,7 +38,7 @@ from rtslib_fb import (
     RTSRoot,
     UserBackedStorageObject,
 )
-from rtslib_fb.utils import get_block_type
+from rtslib.utils import get_block_type
 
 from .ui_node import UINode, UIRTSLibNode
 
@@ -516,7 +516,9 @@ class UIFileIOBackstore(UIBackstore):
         '''
         if current_param != 'file_or_dev':
             return []
-        completions = complete_path(text, lambda x: stat.S_ISREG(x) or stat.S_ISBLK(x))
+        completions = complete_path(
+            text, lambda x: stat.S_ISREG(x) or stat.S_ISBLK(x),
+        ) if text else []
         if len(completions) == 1 and not completions[0].endswith('/'):
             completions = [completions[0] + ' ']
         return completions
@@ -545,11 +547,10 @@ class UIBlockBackstore(UIBackstore):
             return False
 
         os.close(f)
-        if struct.unpack('I', buf)[0] == 0:
-            return False
-        return True
+        return struct.unpack('I', buf)[0] != 0
 
-    def ui_command_create(self, name, dev, readonly=None, wwn=None):
+    def ui_command_create(self, name, dev, readonly=None, wwn=None,
+                          exclusive=None):
         '''
         Creates an Block Storage object. "dev" is the path to the TYPE_DISK
         block device to use.
@@ -561,7 +562,11 @@ class UIBlockBackstore(UIBackstore):
 
         wwn = self.ui_eval_param(wwn, 'string', None)
 
-        so = BlockStorageObject(name, dev, readonly=readonly, wwn=wwn)
+        excl_string = self.ui_eval_param(exclusive, 'string', None)
+        exclusive = True if excl_string is None else self.ui_eval_param(exclusive, "bool", True)
+
+        so = BlockStorageObject(name, dev, readonly=readonly, wwn=wwn,
+                                exclusive=exclusive)
         ui_so = UIBlockStorageObject(so, self)
         self.setup_model_alias(so)
         self.shell.log.info(f"Created block storage object {name} using {dev}.")
@@ -573,7 +578,7 @@ class UIBlockBackstore(UIBackstore):
         '''
         if current_param != 'dev':
             return []
-        completions = complete_path(text, stat.S_ISBLK)
+        completions = complete_path(text, stat.S_ISBLK) if text else []
         if len(completions) == 1 and not completions[0].endswith('/'):
             completions = [completions[0] + ' ']
         return completions

{targetcli-3.0.0.dev0 → targetcli-3.0.2}/src/targetcli/ui_node.py

@@ -18,7 +18,7 @@ under the License.
 '''
 
 
-from configshell_fb import ConfigNode, ExecutionError
+from configshell import ConfigNode, ExecutionError
 
 
 class UINode(ConfigNode):

{targetcli-3.0.0.dev0 → targetcli-3.0.2}/src/targetcli/ui_root.py

@@ -26,9 +26,9 @@ from datetime import datetime
 from glob import glob
 from pathlib import Path, PurePosixPath
 
-from configshell_fb import ExecutionError
-from rtslib_fb import RTSRoot
-from rtslib_fb.utils import ignored
+from configshell import ExecutionError
+from rtslib import RTSRoot
+from rtslib.utils import ignored
 
 from targetcli import __version__
 
@@ -155,8 +155,7 @@ class UIRoot(UINode):
                     prefs = Path(universal_prefs_file).read_text()
                     backups = [line for line in prefs.splitlines() if re.match(
                         r'^max_backup_files\s*=', line)]
-                    if max_backup_files < int(backups[0].split('=')[1].strip()):
-                        max_backup_files = int(backups[0].split('=')[1].strip())
+                    max_backup_files = max(max_backup_files, int(backups[0].split('=')[1].strip()))
                 except:
                     self.shell.log.debug(f"No universal prefs file '{universal_prefs_file}'.")
 
@@ -200,8 +199,7 @@ class UIRoot(UINode):
         savefile = os.path.expanduser(savefile)
 
         if not os.path.isfile(savefile):
-            self.shell.log.info(f"Restore file {savefile} not found")
-            return
+            raise ExecutionError(f"Restore file {savefile} not found")
 
         target = self.ui_eval_param(target, 'string', None)
         storage_object = self.ui_eval_param(storage_object, 'string', None)
@@ -320,7 +318,7 @@ class UIRoot(UINode):
         else:
             printed_sessions = list(self.rtsroot.sessions)
 
-        if len(printed_sessions):
+        if printed_sessions:
             for session in printed_sessions:
                 print_session(session)
         elif sid is None:

{targetcli-3.0.0.dev0 → targetcli-3.0.2}/src/targetcli/ui_target.py

@@ -24,8 +24,8 @@ except ImportError:
     ethtool = None
 import stat
 
-from configshell_fb import ExecutionError
-from rtslib_fb import (
+from configshell import ExecutionError
+from rtslib import (
     LUN,
     TPG,
     MappedLUN,
@@ -43,6 +43,7 @@ from .ui_node import UINode, UIRTSLibNode
 auth_params = ('userid', 'password', 'mutual_userid', 'mutual_password')
 int_params = ('enable',)
 discovery_params = auth_params + int_params
+default_portal_listen = "::0"
 
 class UIFabricModule(UIRTSLibNode):
     '''
@@ -340,10 +341,10 @@ class UIMultiTPGTarget(UIRTSLibNode):
 
         if tpg.has_feature("nps") and self.shell.prefs['auto_add_default_portal']:
             try:
-                NetworkPortal(tpg, "0.0.0.0")
+                NetworkPortal(tpg, f"[{default_portal_listen}]")
                 self.shell.log.info("Global pref auto_add_default_portal=true")
                 self.shell.log.info("Created default portal listening on all IPs"
-                                    " (0.0.0.0), port 3260.")
+                                    f" ({default_portal_listen}), port 3260.")
             except RTSLibError:
                 self.shell.log.info("Default portal not created, TPGs within a target cannot share ip:port.")
 
@@ -938,11 +939,15 @@ class UINodeACL(UIRTSLibNode):
         if current_param == 'tpg_lun_or_backstore':
             completions = []
             for backstore in self.get_node('/backstores').children:
-                completions = [storage_object.path for storage_object in backstore.children]
+                completions.extend(storage_object.path
+                                   for storage_object in backstore.children)
 
-            completions.extend(lun.name for lun in self.parent.parent.get_node("luns").children)
+            completions.extend(lun.name
+                               for lun in self.parent.parent.get_node("luns").children)
 
-            completions.extend(complete_path(text, lambda x: stat.S_ISREG(x) or stat.S_ISBLK(x)))
+            if text:
+                completions.extend(complete_path(text,
+                                                 lambda x: stat.S_ISREG(x) or stat.S_ISBLK(x)))
 
             completions = [c for c in completions if c.startswith(text)]
         else:
@@ -1150,10 +1155,13 @@ class UILUNs(UINode):
         if current_param == 'storage_object':
             storage_objects = []
             for backstore in self.get_node('/backstores').children:
-                storage_objects = [storage_object.path for storage_object in backstore.children]
+                storage_objects.extend(storage_object.path
+                                       for storage_object in backstore.children)
             completions = [so for so in storage_objects if so.startswith(text)]
 
-            completions.extend(complete_path(text, lambda x: stat.S_ISREG(x) or stat.S_ISBLK(x)))
+            if text:
+                completions.extend(complete_path(text,
+                                                 lambda x: stat.S_ISREG(x) or stat.S_ISBLK(x)))
         else:
             completions = []
 
@@ -1280,9 +1288,9 @@ class UIPortals(UINode):
         Creates a Network Portal with the specified IP address and
         port.  If the port is omitted, the default port for
         the target fabric will be used. If the IP address is omitted,
-        INADDR_ANY (0.0.0.0) will be used.
+        IN6ADDR_ANY (::0) will be used.
 
-        Choosing IN6ADDR_ANY (::0) will listen on all IPv6 interfaces
+        The default IN6ADDR_ANY (::0) will listen on all IPv6 interfaces
         as well as IPv4, assuming IPV6_V6ONLY sockopt has not been
         set.
 
@@ -1298,12 +1306,12 @@ class UIPortals(UINode):
         # FIXME: Add a specfile parameter to determine default port
         default_port = 3260
         ip_port = self.ui_eval_param(ip_port, 'number', default_port)
-        ip_address = self.ui_eval_param(ip_address, 'string', "0.0.0.0")
+        ip_address = self.ui_eval_param(ip_address, 'string', default_portal_listen)
 
         if ip_port == default_port:
             self.shell.log.info("Using default IP port %d" % ip_port)
-        if ip_address == "0.0.0.0":
-            self.shell.log.info("Binding to INADDR_ANY (0.0.0.0)")
+        if ip_address == default_portal_listen:
+            self.shell.log.info(f"Binding to INADDR_ANY ({default_portal_listen})")
 
         portal = NetworkPortal(self.tpg, self._canonicalize_ip(ip_address),
                                ip_port, mode='create')

{targetcli-3.0.0.dev0 → targetcli-3.0.2}/targetcli.8

@@ -159,9 +159,10 @@ ports. These addr:port pairs are called
 Both IPv4 and IPv6 addresses are supported.
 .P
 When a target is created, targetcli automatically creates a default
-portal listening on all IPv4 addresses (shown as 0.0.0.0) on port 3260.
-If a different configuration is needed, the default portal can be
-removed and portals configured as desired.
+portal listening on all IPv4 and IPv6 addresses (shown as ::0) on port
+3260. If IPV6_V6ONLY is set, the default will only listen on all IPv6
+addresses. If a different configuration is needed, the default portal can
+be removed and portals configured as desired.
 .P
 If the hardware supports it,
 .B iSER
@@ -299,7 +300,7 @@ target.)
 .B portals/ create
 .br
 Add a portal, i.e. an IP address and TCP port via which the target can
-be contacted by initiators. Only required if the default 0.0.0.0:3260
+be contacted by initiators. Only required if the default [::0]:3260
 portal is not present.
 .P
 .B luns/ create /backstores/fileio/disk1