From 7281fb9a8f7cd9093df5d151189893931f61511a Mon Sep 17 00:00:00 2001
From: klemek <klemek@outlook.fr>
Date: Mon, 11 Jan 2021 16:47:29 +0100
Subject: [PATCH] factorize common help

---
 src/scanners/composition_scanner.py | 4 ++--
 src/scanners/emotes_scanner.py      | 5 ++---
 src/scanners/frequency_scanner.py   | 4 ++--
 src/scanners/full_scanner.py        | 6 +++---
 src/scanners/presence_scanner.py    | 4 ++--
 src/utils/utils.py                  | 7 +++++++
 6 files changed, 18 insertions(+), 12 deletions(-)

diff --git a/src/scanners/composition_scanner.py b/src/scanners/composition_scanner.py
index 8dae6ef..df5ec69 100644
--- a/src/scanners/composition_scanner.py
+++ b/src/scanners/composition_scanner.py
@@ -9,6 +9,7 @@ from .scanner import Scanner
 from . import EmotesScanner
 from data_types import Composition, Emote, get_emote_dict
 from logs import ChannelLogs, MessageLog
+from utils import COMMON_HELP_ARGS
 
 
 class CompositionScanner(Scanner):
@@ -17,8 +18,7 @@ class CompositionScanner(Scanner):
         return "```\n"
         +"%comp : Show composition statistics\n"
         +"arguments:\n"
-        +"* @member/me : filter for one or more member\n"
-        +"* #channel/here : filter for one or more channel\n"
+        +COMMON_HELP_ARGS
         +"Example: %comp #mychannel1 @user\n"
         +"```"
 
diff --git a/src/scanners/emotes_scanner.py b/src/scanners/emotes_scanner.py
index 80a2b98..19aec2f 100644
--- a/src/scanners/emotes_scanner.py
+++ b/src/scanners/emotes_scanner.py
@@ -8,7 +8,7 @@ import discord
 from logs import ChannelLogs, MessageLog
 from data_types import Emote, get_emote_dict
 from .scanner import Scanner
-from utils import emojis
+from utils import emojis, COMMON_HELP_ARGS
 
 
 class EmotesScanner(Scanner):
@@ -17,8 +17,7 @@ class EmotesScanner(Scanner):
         return "```\n"
         +"%emotes : Rank emotes by their usage\n"
         +"arguments:\n"
-        +"* @member/me : filter for one or more member\n"
-        +"* #channel/here : filter for one or more channel\n"
+        +COMMON_HELP_ARGS
         +"* <n> : top <n> emojis, default is 20\n"
         +"* all : list all common emojis in addition to this guild's\n"
         +"* members : show top member for each emote\n"
diff --git a/src/scanners/frequency_scanner.py b/src/scanners/frequency_scanner.py
index 71fc1a9..ac8b545 100644
--- a/src/scanners/frequency_scanner.py
+++ b/src/scanners/frequency_scanner.py
@@ -8,6 +8,7 @@ import discord
 from .scanner import Scanner
 from data_types import Frequency
 from logs import ChannelLogs, MessageLog
+from utils import COMMON_HELP_ARGS
 
 
 class FrequencyScanner(Scanner):
@@ -16,8 +17,7 @@ class FrequencyScanner(Scanner):
         return "```\n"
         +"%freq : Show frequency-related statistics\n"
         +"arguments:\n"
-        +"* @member/me : filter for one or more member\n"
-        +"* #channel/here : filter for one or more channel\n"
+        +COMMON_HELP_ARGS
         +"Example: %freq #mychannel1 @user\n"
         +"```"
 
diff --git a/src/scanners/full_scanner.py b/src/scanners/full_scanner.py
index d780d91..a90a5aa 100644
--- a/src/scanners/full_scanner.py
+++ b/src/scanners/full_scanner.py
@@ -7,8 +7,9 @@ import discord
 
 from .scanner import Scanner
 from . import FrequencyScanner, CompositionScanner, PresenceScanner, EmotesScanner
-from data_types import Frequency, Composition, Presence, Emote, get_emote_dict
+from data_types import Frequency, Composition, Presence, get_emote_dict
 from logs import ChannelLogs, MessageLog
+from utils import COMMON_HELP_ARGS
 
 
 class FullScanner(Scanner):
@@ -17,8 +18,7 @@ class FullScanner(Scanner):
         return "```\n"
         +"%full : Show full statistics\n"
         +"arguments:\n"
-        +"* @member/me : filter for one or more member\n"
-        +"* #channel/here : filter for one or more channel\n"
+        +COMMON_HELP_ARGS
         +"Example: %full #mychannel1 @user\n"
         +"```"
 
diff --git a/src/scanners/presence_scanner.py b/src/scanners/presence_scanner.py
index 82758c6..164a1bc 100644
--- a/src/scanners/presence_scanner.py
+++ b/src/scanners/presence_scanner.py
@@ -8,6 +8,7 @@ from .scanner import Scanner
 from . import EmotesScanner
 from data_types import Presence, Emote, get_emote_dict
 from logs import ChannelLogs, MessageLog
+from utils import COMMON_HELP_ARGS
 
 
 class PresenceScanner(Scanner):
@@ -16,8 +17,7 @@ class PresenceScanner(Scanner):
         return "```\n"
         +"%pres : Show presence statistics\n"
         +"arguments:\n"
-        +"* @member/me : filter for one or more member\n"
-        +"* #channel/here : filter for one or more channel\n"
+        +COMMON_HELP_ARGS
         +"Example: %pres #mychannel1 @user\n"
         +"```"
 
diff --git a/src/utils/utils.py b/src/utils/utils.py
index 8743387..2ef96ec 100644
--- a/src/utils/utils.py
+++ b/src/utils/utils.py
@@ -6,6 +6,13 @@ from datetime import datetime
 
 # OTHER
 
+COMMON_HELP_ARGS = (
+    ""
+    + "* @member/me : filter for one or more member\n"
+    + "* #channel/here : filter for one or more channel\n"
+    + "* fast: only read cache\n"
+)
+
 
 def delta(t0: datetime):
     return round((datetime.now() - t0).total_seconds() * 1000)