Merge pull request #497 from laixintao/fix-xgroup

add xgroup help command support.

Author: laixintao

.github/workflows/release.yaml

@@ -21,7 +21,7 @@ jobs:
 
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-python@v1
+      - uses: actions/setup-python@v5
         with:
           python-version: 3.8
           architecture: 'x64'
@@ -75,7 +75,7 @@ jobs:
 
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-python@v1
+      - uses: actions/setup-python@v5
         with:
           python-version: 3.8
           architecture: 'x64'

.github/workflows/test-binary-build.yaml

@@ -21,13 +21,13 @@ jobs:
         options: --entrypoint redis-server
 
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-python@v1
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
         with:
           python-version: 3.8
           architecture: 'x64'
       - name: Cache venv
-        uses: actions/cache@v1
+        uses: actions/cache@v4
         with:
           path: venv
           # Look to see if there is a cache hit for the corresponding requirements file
@@ -71,7 +71,7 @@ jobs:
           ./build/x86*/release/install/iredis help GET
 
       - name: Upload Release Asset to Github Artifact
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v4
         with:
           name: iredis-${{github.sha}}.tar.gz
           path: ./build/iredis.tar.gz

.github/workflows/test.yaml

@@ -12,7 +12,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: ["ubuntu-20.04"]
+        os: ["ubuntu-24.04"]
         python: ["3.8", "3.9", "3.10", "3.11.1", "3.12"]
         redis: [5, 6, 7, 7.2]
     runs-on: ${{ matrix.os }}
@@ -26,12 +26,12 @@ jobs:
 
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-python@v4
+      - uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python }}
           architecture: "x64"
       - name: Cache venv
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         with:
           path: venv
           # Look to see if there is a cache hit for the corresponding requirements file
@@ -62,13 +62,13 @@ jobs:
       - uses: codespell-project/actions-codespell@master
         with:
           ignore_words_list: fo,ists,oll,optin,ot,smove,tre,whe,EXAT,exat
-          skip: ./docs/assets/demo.svg,./iredis/data/commands.json,./iredis/data/commands/*,./tests/unittests/*
-      - uses: actions/setup-python@v4
+          skip: ./docs/assets/demo.svg,./iredis/data/commands.json,./iredis/data/commands/*,./tests/unittests/*,./docs/assets/*
+      - uses: actions/setup-python@v5
         with:
           python-version: 3.8
           architecture: "x64"
       - name: Cache venv
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         with:
           path: venv
           # Look to see if there is a cache hit for the corresponding requirements file

iredis/commands.py

@@ -111,8 +111,6 @@ def split_command_args(command):
 
     :param command: redis command string, with args
     """
-    global all_commands
-
     command = command.strip()
     for command_name in all_commands:
         # for command that is partially input, like `command in`, we should

iredis/config.py

@@ -102,8 +102,6 @@ def read_config_file(f):
 
 
 def load_config_files(iredisrc):
-    global config
-
     with path(project_data, "iredisrc") as p:
         config_obj = ConfigObj(str(p))
 

iredis/data/command_syntax.csv

@@ -231,7 +231,7 @@ stream,XACK,command_key_group_ids,render_int
 stream,XADD,command_xadd,render_bulk_string
 stream,XCLAIM,command_xclaim,render_list
 stream,XDEL,command_key_ids,render_int
-stream,XGROUP,command_xgroup,render_string_or_int
+stream,XGROUP,command_xgroup,render_list_or_int_or_string
 stream,XINFO,command_xinfo,render_list
 stream,XLEN,command_key,render_int
 stream,XPENDING,command_xpending,render_list

iredis/entry.py

@@ -30,7 +30,7 @@
 
 
 class SkipAuthFileHistory(FileHistory):
-    """Exactlly like FileHistory, but won't save `AUTH` command into history
+    """Exactly like FileHistory, but won't save `AUTH` command into history
     file."""
 
     def append_string(self, string: str) -> None:
@@ -142,19 +142,19 @@ class Rainbow:
 
     def __init__(self):
         self.current = -1
-        self.forword = 1
+        self.forward = 1
 
     def __iter__(self):
         return self
 
     def __next__(self):
-        self.current += self.forword
+        self.current += self.forward
         if 0 <= self.current < len(self.color):
             # not to the end
             return self.color[self.current]
         else:
-            self.forword = -self.forword
-            self.current += 2 * self.forword
+            self.forward = -self.forward
+            self.current += 2 * self.forward
             return self.color[self.current]
 
 

iredis/redis_grammar.py

@@ -531,7 +531,8 @@ def c(const_name):
             (\s+ {STREAM_CREATE} \s+ {KEY} \s+ {GROUP} \s+ {STREAM_ID})|
             (\s+ {STREAM_SETID} \s+ {KEY} \s+ {GROUP} \s+ {STREAM_ID})|
             (\s+ {STREAM_DESTROY} \s+ {KEY} \s+ {GROUP})|
-            (\s+ {STREAM_DELCONSUMER} \s+ {KEY} \s+ {GROUP} \s+ {CONSUMER})
+            (\s+ {STREAM_DELCONSUMER} \s+ {KEY} \s+ {GROUP} \s+ {CONSUMER})|
+            (\s+ {HELP})
         )
         \s*""",
     "command_key_group_ids": rf"""

iredis/renders.py

@@ -149,6 +149,14 @@ def render_list_or_string(text):
             return OutputRender.render_list(text)
         return OutputRender.render_bulk_string(text)
 
+    @staticmethod
+    def render_list_or_int_or_string(text):
+        if isinstance(text, list):
+            return OutputRender.render_list(text)
+        if isinstance(text, int):
+            return OutputRender.render_int(text)
+        return OutputRender.render_bulk_string(text)
+
     @staticmethod
     def render_string_or_int(text):
         if isinstance(text, int):