refactor: Fix boolean traps in signatures (#287)

Author: pederhan

docs/scripts/utils/markup.py

@@ -62,7 +62,7 @@ def symbol(self) -> str:
         return s
 
     @classmethod
-    def from_span(cls, span: MarkdownSpan, end: bool = False) -> MarkdownSymbol:
+    def from_span(cls, span: MarkdownSpan, *, end: bool = False) -> MarkdownSymbol:
         return cls(
             position=span.end if end else span.start,
             italic=span.italic,

pyproject.toml

@@ -171,6 +171,7 @@ extend-select = [
   "C4",      # flake8-comprehensions
   "B",       # flake8-bugbear
   "UP",      # pyupgrade
+  "FBT002",  # flake8-boolean-trap (Positional bool values with defaults)
 ]
 ignore = [
   "E501", # Avoid enforcing line-length violations

tests/pyzabbix/test_client.py

@@ -240,7 +240,12 @@ def test_client_logout(httpserver: HTTPServer, auth_type: AuthType, auth: str) -
 
     # We only expect a logout request if we are using a sessionid and have an auth token
     if auth_type == "sessionid" and auth:
-        add_zabbix_endpoint(httpserver, "user.logout", {}, True)
+        add_zabbix_endpoint(
+            httpserver,
+            "user.logout",
+            params={},
+            response=True,  # the value `True` as the response
+        )
     zabbix_client = ZabbixAPI(server=httpserver.url_for("/api_jsonrpc.php"))
     zabbix_client.auth = auth
     if auth_type == "token":

tests/utils.py

@@ -13,6 +13,7 @@
 def add_zabbix_endpoint(
     httpserver: HTTPServer,
     method: str,  # method is zabbix API method, not HTTP method
+    *,
     params: dict[str, Any],
     response: Json,
     auth: Optional[str] = None,

zabbix_cli/_patches/typer.py

@@ -294,7 +294,7 @@ def patch__get_rich_console() -> None:
     )
     TYPER_THEME = Theme(styles)
 
-    def _get_rich_console(stderr: bool = False) -> Console:
+    def _get_rich_console(stderr: bool = False) -> Console:  # noqa: FBT002
         return Console(
             theme=TYPER_THEME,
             highlighter=highlighter,

zabbix_cli/auth.py

@@ -126,7 +126,7 @@ def set_user_session(self, url: str, username: str, session_id: str) -> None:
         self.set_sessions(url, session)
 
     @classmethod
-    def load(cls, file: Path, allow_insecure: bool = False) -> SessionFile:
+    def load(cls, file: Path, *, allow_insecure: bool = False) -> SessionFile:
         """Load the contents of a session file."""
         if not file.exists():
             raise SessionFileNotFoundError("Session file does not exist: %s", file)
@@ -143,7 +143,9 @@ def load(cls, file: Path, allow_insecure: bool = False) -> SessionFile:
         except Exception as e:
             raise SessionFileError(f"Unable to load session file {file}: {e}") from e
 
-    def save(self, path: Optional[Path] = None, allow_insecure: bool = False) -> None:
+    def save(
+        self, path: Optional[Path] = None, *, allow_insecure: bool = False
+    ) -> None:
         path = path or self._path
         if not path:
             raise SessionFileError("Cannot save session file without a path.")
@@ -264,13 +266,13 @@ def login_with_any(self) -> tuple[ZabbixAPI, LoginInfo]:
         )
 
     def _iter_all_credentials(
-        self, prompt_password: bool = True
+        self, *, prompt_password: bool = True
     ) -> Generator[Credentials, None, None]:
-        """Generator that yields credentials from all possible sources.
+        """Generator of credentials from all possible sources.
 
         Only yields non-empty credentials, but does not check if they are valid.
 
-        Finally yields a prompt for username and password if `prompt_password` is True.
+        Finally yields a prompt for username and password if `prompt_password=True`.
         """
         for func in [
             self._get_auth_token_env,
@@ -455,7 +457,7 @@ def _update_config(self, credentials: Credentials) -> None:
         ):
             self.config.api.auth_token = SecretStr(credentials.auth_token)
 
-    def get_zabbix_url(self, prompt: bool = True) -> str:
+    def get_zabbix_url(self, *, prompt: bool = True) -> str:
         """Get the URL of the Zabbix server from env, config, then finally prompt for it.."""
         for source in [self._get_zabbix_url_env, self._get_zabbix_url_config]:
             url = source()
@@ -697,6 +699,7 @@ def write_auth_token_file(
     username: str,
     auth_token: str,
     file: Path = AUTH_TOKEN_FILE,
+    *,
     allow_insecure: bool = False,
 ) -> Path:
     """Write a username/auth token pair to the auth token file."""

zabbix_cli/commands/results/cli.py

@@ -61,7 +61,7 @@ def config_path_str(self) -> str:
         )
 
     @classmethod
-    def from_debug_data(cls, state: State, with_auth: bool = False) -> DebugInfo:
+    def from_debug_data(cls, state: State, *, with_auth: bool = False) -> DebugInfo:
         # So far we only use state, but we can expand this in the future
         from zabbix_cli.exceptions import ZabbixCLIError
 

zabbix_cli/commands/results/proxy.py

@@ -136,7 +136,7 @@ class ShowProxiesResult(TableRenderable):
     show_hosts: bool = Field(default=False, exclude=True)
 
     @classmethod
-    def from_result(cls, proxy: Proxy, show_hosts: bool = False) -> Self:
+    def from_result(cls, proxy: Proxy, *, show_hosts: bool = False) -> Self:
         return cls(proxy=proxy, show_hosts=show_hosts)
 
     @property

zabbix_cli/commands/template.py

@@ -66,9 +66,9 @@ def link_template_to_host(
     from zabbix_cli.models import AggregateResult
 
     templates = parse_templates_arg(
-        app, template_names_or_ids, strict, select_hosts=True
+        app, template_names_or_ids, strict=strict, select_hosts=True
     )
-    hosts = parse_hosts_arg(app, hostnames_or_ids, strict)
+    hosts = parse_hosts_arg(app, hostnames_or_ids, strict=strict)
     if not dryrun:
         with app.state.console.status("Linking templates..."):
             app.state.client.link_templates_to_hosts(templates, hosts)
@@ -280,9 +280,9 @@ def unlink_template_from_host(
     from zabbix_cli.models import AggregateResult
 
     templates = parse_templates_arg(
-        app, template_names_or_ids, strict, select_hosts=True
+        app, template_names_or_ids, strict=strict, select_hosts=True
     )
-    hosts = parse_hosts_arg(app, hostnames_or_ids, strict)
+    hosts = parse_hosts_arg(app, hostnames_or_ids, strict=strict)
 
     action = "Unlink and clear" if clear else "Unlink"
     if not dryrun:
@@ -362,8 +362,8 @@ def unlink_template_from_template(
     """
     from zabbix_cli.commands.results.template import LinkTemplateResult
 
-    source_templates = parse_templates_arg(app, source, strict)
-    dest_templates = parse_templates_arg(app, dest, strict)
+    source_templates = parse_templates_arg(app, source, strict=strict)
+    dest_templates = parse_templates_arg(app, dest, strict=strict)
     if not dryrun:
         with app.state.console.status("Unlinking templates..."):
             app.state.client.unlink_templates(

zabbix_cli/commands/templategroup.py

@@ -60,11 +60,11 @@ def add_template_to_group(
 
     groups: Union[list[HostGroup], list[TemplateGroup]]
     if app.state.client.version.release >= (6, 2, 0):
-        groups = parse_templategroups_arg(app, group_names_or_ids, strict)
+        groups = parse_templategroups_arg(app, group_names_or_ids, strict=strict)
     else:
-        groups = parse_hostgroups_arg(app, group_names_or_ids, strict)
+        groups = parse_hostgroups_arg(app, group_names_or_ids, strict=strict)
 
-    templates = parse_templates_arg(app, template_names_or_ids, strict)
+    templates = parse_templates_arg(app, template_names_or_ids, strict=strict)
 
     with app.state.console.status("Adding templates..."):
         app.state.client.link_templates_to_groups(templates, groups)