Add warnings hook_process_url and hook_process_hashtable_url

Author: flashcode

CHANGELOG.md

@@ -6,6 +6,10 @@
 
 - Remove warnings on deprecated infos `irc_nick_color` and `irc_nick_color_name` (used again with WeeChat >= 4.1.0)
 
+### Added
+
+- Add warnings `hook_process_url` and `hook_process_hashtable_url`
+
 ### Changed
 
 - Improve regex to detect e-mails

README.md

@@ -116,6 +116,26 @@ which may not be UTF-8 valid. This is a problem in some languages like Python.
 
 **How to fix**: use the signal `irc_out1_xxx`.
 
+### Warning: hook_process_url
+
+**Issue**: the function `hook_process` used with `url:` should be
+replaced by the new function `hook_url` added in WeeChat 4.1.0, which uses
+a thread instead of a new process, making it more lightweight and thus
+recommended for this usage.
+
+**How to fix**: call the function `hook_url` and make necessary changes
+in code, as the function is different from `hook_process`.
+
+### Warning: hook_process_hashtable_url
+
+**Issue**: the function `hook_process_hashtable` used with `url:` should be
+replaced by the new function `hook_url` added in WeeChat 4.1.0, which uses
+a thread instead of a new process, making it more lightweight and thus
+recommended for this usage.
+
+**How to fix**: call the function `hook_url` and make necessary changes
+in code, as the function is different from `hook_process_hashtable`.
+
 ### Info: unneeded_shebang
 
 **Issue**: the shebang is not needed, except if the script can be called

tests/scripts/script_all_errors.py

@@ -22,4 +22,6 @@
         weechat.hook_modifier("irc_in_privmsg", "callback", "")
         weechat.hook_signal("*,irc_out_privmsg", "callback", "")
         weechat.hook_signal("*,irc_outtags_privmsg", "callback", "")
+        weechat.hook_process("url:http://localhost:1234", 1000, "callback", "")
+        weechat.hook_process_hashtable("url:http://localhost:1234", {}, 1000, "callback", "")
         sys.exit(1)

tests/scripts/script_hook_process.py

@@ -0,0 +1,11 @@
+#
+# Author: Sébastien Helleu <[email protected]>
+#
+
+"""A WeeChat script."""
+
+import weechat
+
+if __name__ == "__main__":
+    if weechat.register("script", "author", "0.1", "GPL3", "desc", "", ""):
+        weechat.hook_process("url:http://localhost:1234", 1000, "callback", "")

tests/scripts/script_hook_process_hashtable.py

@@ -0,0 +1,11 @@
+#
+# Author: Sébastien Helleu <[email protected]>
+#
+
+"""A WeeChat script."""
+
+import weechat
+
+if __name__ == "__main__":
+    if weechat.register("script", "author", "0.1", "GPL3", "desc", "", ""):
+        weechat.hook_process_hashtable("url:http://localhost:1234", {}, 1000, "callback", "")

tests/test_main.py

@@ -104,7 +104,7 @@ def test_main_dir() -> None:
         with mock.patch.object(sys, "argv", args):
             weechat_script_lint.main()
     assert exc.type == SystemExit
-    assert exc.value.code == 22
+    assert exc.value.code == 26
 
     # check directory with scripts, display scripts by score
     args = [

tests/test_script.py

@@ -33,12 +33,14 @@
     ("error", 17, "missing_infolist_free"),
     ("error", 18, "python2_bin"),
     ("error", 1, "mixed_tabs_spaces"),
-    ("warning", 25, "sys_exit"),
+    ("warning", 27, "sys_exit"),
     ("warning", 19, "deprecated_hook_completion_get_string"),
     ("warning", 20, "deprecated_hook_completion_list_add"),
     ("warning", 22, "modifier_irc_in"),
     ("warning", 23, "signal_irc_out"),
     ("warning", 24, "signal_irc_outtags"),
+    ("warning", 25, "hook_process_url"),
+    ("warning", 26, "hook_process_hashtable_url"),
     ("info", 1, "unneeded_shebang"),
     ("info", 13, "url_weechat"),
 ]
@@ -79,12 +81,12 @@ def test_script_all_errors() -> None:
     assert script.script
     script.check()
     assert str(script)
-    assert len(str(script).split("\n")) == 12
+    assert len(str(script).split("\n")) == len(ALL_ERRORS)
     print(script.count)
-    assert script.count == {"error": 4, "warning": 6, "info": 2}
+    assert script.count == {"error": 4, "warning": 8, "info": 2}
     errors = [(msg.level, msg.line, msg.msg_name) for msg in script.messages]
     assert errors == ALL_ERRORS
-    assert len(script.get_report(False).split("\n")) == 12
+    assert len(script.get_report(False).split("\n")) == len(ALL_ERRORS)
     assert script.get_report(True) == "script_all_errors.py"
 
     # ignore 2 messages: "missing_email" and "sys_exit"
@@ -99,9 +101,9 @@ def test_script_all_errors() -> None:
     assert script.script
     script.check()
     assert str(script)
-    assert len(str(script).split("\n")) == 10
-    assert script.count == {"error": 3, "warning": 5, "info": 2}
-    assert len(script.get_report(False).split("\n")) == 10
+    assert len(str(script).split("\n")) == len(ALL_ERRORS) - 2
+    assert script.count == {"error": 3, "warning": 7, "info": 2}
+    assert len(script.get_report(False).split("\n")) == len(ALL_ERRORS) - 2
     assert script.get_report(True) == "script_all_errors.py"
 
 

weechat_script_lint/script.py

@@ -90,6 +90,16 @@
             "signal irc_outtags_{message} should be replaced by "
             "irc_out1_{message} which sends only valid UTF-8 data",
         ),
+        "hook_process_url": (
+            -5,
+            "function hook_process with \"url:\" should be replaced "
+            "by hook_url (WeeChat ≥ 4.1.0)",
+        ),
+        "hook_process_hashtable_url": (
+            -5,
+            "function hook_process_hashtable with \"url:\" should be replaced "
+            "by hook_url (WeeChat ≥ 4.1.0)",
+        ),
     },
     "info": {
         "unneeded_shebang": (
@@ -347,6 +357,32 @@ def _check_signals_irc_out(self) -> None:
                 message=m.group(1),
             )
 
+    def _check_hook_process_url(self) -> None:
+        """Check if hook_process(_hashtable) with "url:" is used."""
+        func_url = self.search_regex("hook_url")
+        if func_url:
+            return
+        func_process = self.search_func(
+            "hook_process", r"[\"']url:"
+        )
+        func_process_hashtable = self.search_func(
+            "hook_process_hashtable", r"[\"']url:"
+        )
+        if func_process:
+            for line_no, m in func_process:
+                self.message(
+                    "warning",
+                    "hook_process_url",
+                    line=line_no,
+                )
+        if func_process_hashtable:
+            for line_no, m in func_process_hashtable:
+                self.message(
+                    "warning",
+                    "hook_process_hashtable_url",
+                    line=line_no,
+                )
+
     # === info ===
 
     def _check_shebang(self) -> None: