Adding default_value to CogSetting. Better config value formatting.

rocketbot/cogs/autokickcog.py

@@ -33,23 +33,33 @@ class AutoKickCog(BaseCog, name='Auto Kick'):
 	"""
 	Cog for automatically kicking ALL new joins. For temporary use during join raids.
 	"""
-	SETTING_ENABLED = CogSetting('enabled', bool,
+	SETTING_ENABLED = CogSetting(
+		'enabled',
+		bool,
+		default_value=False,
 		brief='autokick',
-		description='Whether this cog is enabled for a guild.')
-	SETTING_BAN_COUNT = CogSetting('bancount', int,
+		description='Whether this cog is enabled for a guild.',
+	)
+	SETTING_BAN_COUNT = CogSetting(
+		'bancount',
+		int,
+		default_value=0,
 		brief='number of repeat kicks before a ban',
 		description='The number of times a user can join and be kicked '
 					'before the next rejoin will result in a ban. A value of 0 '
 					'disables this feature (only kick, never ban).',
-		usage='<count:int>',
-		min_value=0)
-	SETTING_OFFLINE_ONLY = CogSetting('offlineonly', bool,
+		min_value=0,
+	)
+	SETTING_OFFLINE_ONLY = CogSetting(
+		'offlineonly',
+		bool,
+		default_value=False,
 		brief='whether to only kick users whose status is offline',
 		description='Compromised accounts may have a status of offline. '
 					'If this setting is enabled, the user\'s status will be '
 					'checked a few seconds after joining. If it is offline '
 					'they will be kicked.',
-		usage='<true|false>')
+	)
 
 	STATE_KEY_RECENT_KICKS = "AutoKickCog.recent_joins"
 

rocketbot/cogs/basecog.py

@@ -138,7 +138,10 @@ class BaseCog(Cog):
 			if value is not None:
 				return value
 		if use_cog_default_if_not_set:
-			return cls.get_cog_default(setting.name)
+			config_default = cls.get_cog_default(setting.name)
+			if config_default is not None:
+				return None
+			return setting.default_value
 		return None
 
 	@classmethod

rocketbot/cogs/crosspostcog.py

@@ -45,51 +45,73 @@ class CrossPostCog(BaseCog, name='Crosspost Detection'):
 	often be for a reason or due to trying a failed post when connectivity is
 	poor. Minimum message length can be enforced for detection.
 	"""
-	SETTING_ENABLED = CogSetting('enabled', bool,
+	SETTING_ENABLED = CogSetting(
+		'enabled',
+		bool,
+		default_value=False,
 		brief='crosspost detection',
-		description='Whether crosspost detection is enabled.')
-	SETTING_WARN_COUNT = CogSetting('warncount', int,
+		description='Whether crosspost detection is enabled.',
+	)
+	SETTING_WARN_COUNT = CogSetting(
+		'warncount',
+		int,
+		default_value=5,
 		brief='number of messages to trigger a warning',
 		description='The number of unique channels messages are ' + \
 			'posted in by the same user to trigger a mod warning. The ' + \
 			'messages need not be identical (see dupewarncount).',
-		usage='<count:int>',
-		min_value=2)
-	SETTING_DUPE_WARN_COUNT = CogSetting('dupewarncount', int,
+		min_value=2,
+	)
+	SETTING_DUPE_WARN_COUNT = CogSetting(
+		'dupewarncount',
+		int,
+		default_value=3,
 		brief='number of identical messages to trigger a warning',
 		description='The number of unique channels identical messages are ' + \
 			'posted in by the same user to trigger a mod warning.',
-		usage='<count:int>',
-		min_value=2)
-	SETTING_BAN_COUNT = CogSetting('bancount', int,
+		min_value=2,
+	)
+	SETTING_BAN_COUNT = CogSetting(
+		'bancount',
+		int,
+		default_value=9999,
 		brief='number of messages to trigger a ban',
 		description='The number of unique channels messages are ' + \
 			'posted in by the same user to trigger an automatic ban. The ' + \
 			'messages need not be identical (see dupebancount). Set ' + \
 			'to a large value to effectively disable, e.g. 9999.',
-		usage='<count:int>',
-		min_value=2)
-	SETTING_DUPE_BAN_COUNT = CogSetting('dupebancount', int,
+		min_value=2,
+	)
+	SETTING_DUPE_BAN_COUNT = CogSetting(
+		'dupebancount',
+		int,
+		default_value=9999,
 		brief='number of identical messages to trigger a ban',
 		description='The number of unique channels identical messages are ' + \
 			'posted in by the same user to trigger an automatic ban. Set ' + \
 			'to a large value to effectively disable, e.g. 9999.',
-		usage='<count:int>',
-		min_value=2)
-	SETTING_MIN_LENGTH = CogSetting('minlength', int,
+		min_value=2,
+	)
+	SETTING_MIN_LENGTH = CogSetting(
+		'minlength',
+		int,
+		default_value=1,
 		brief='minimum message length',
 		description='The minimum number of characters in a message to be ' + \
 			'checked for duplicates. This can help ignore common short ' + \
 			'messages like "lol" or a single emoji.',
-		usage='<character_count:int>',
-		min_value=1)
-	SETTING_TIMESPAN = CogSetting('timespan', timedelta,
+		min_value=1,
+	)
+	SETTING_TIMESPAN = CogSetting(
+		'timespan',
+		timedelta,
+		default_value=timedelta(seconds=60),
 		brief='time window to look for dupe messages',
-		description='The number of seconds of message history to look at ' + \
-			'when looking for duplicates. Shorter values are preferred, ' + \
+		description='The number of seconds of message history to look at '
+			'when looking for duplicates. Shorter values are preferred, '
 			'both to detect bots and avoid excessive memory usage.',
-		usage='<seconds:int>',
-		min_value=timedelta(seconds=1))
+		min_value=timedelta(seconds=1),
+	)
 
 	STATE_KEY_RECENT_MESSAGES = "CrossPostCog.recent_messages"
 	STATE_KEY_SPAM_CONTEXT = "CrossPostCog.spam_context"

rocketbot/cogs/joinraidcog.py

@@ -29,23 +29,33 @@ class JoinRaidCog(BaseCog, name='Join Raids'):
 	"""
 	Cog for monitoring member joins and detecting potential bot raids.
 	"""
-	SETTING_ENABLED = CogSetting('enabled', bool,
-			brief='join raid detection',
-			description='Whether this cog is enabled for a guild.')
-	SETTING_JOIN_COUNT = CogSetting('joincount', int,
-			brief='number of joins to trigger a warning',
-			description='The number of joins occuring within the time ' + \
-				'window to trigger a mod warning.',
-			usage='<count:int>',
-			min_value=2)
-	SETTING_JOIN_TIME = CogSetting('jointime', timedelta,
-			brief='time window length to look for joins',
-			description='The number of seconds of join history to look ' + \
-				'at when counting recent joins. If joincount or more ' + \
-				'joins occur within jointime seconds a mod warning is issued.',
-			usage='<seconds:float>',
-			min_value=timedelta(seconds=1.0),
-			max_value=timedelta(seconds=900.0))
+	SETTING_ENABLED = CogSetting(
+		'enabled',
+		bool,
+		default_value=False,
+		brief='join raid detection',
+		description='Whether this cog is enabled for a guild.',
+	)
+	SETTING_JOIN_COUNT = CogSetting(
+		'joincount',
+		int,
+		default_value=5,
+		brief='number of joins to trigger a warning',
+		description='The number of joins occurring within the time '
+					'window to trigger a mod warning.',
+		min_value=2,
+	)
+	SETTING_JOIN_TIME = CogSetting(
+		'jointime',
+		timedelta,
+		default_value=timedelta(seconds=5),
+		brief='time window length to look for joins',
+		description='The number of seconds of join history to look '
+					'at when counting recent joins. If joincount or more '
+				    'joins occur within jointime seconds a mod warning is issued.',
+		min_value=timedelta(seconds=1.0),
+		max_value=timedelta(seconds=900.0),
+	)
 
 	STATE_KEY_RECENT_JOINS = "JoinRaidCog.recent_joins"
 	STATE_KEY_LAST_RAID = "JoinRaidCog.last_raid"

rocketbot/cogs/logcog.py

@@ -38,9 +38,13 @@ class LoggingCog(BaseCog, name='Logging'):
 	"""
 	Cog for logging notable events to a designated logging channel.
 	"""
-	SETTING_ENABLED = CogSetting('enabled', bool,
-			brief='logging',
-			description='Whether this cog is enabled for a guild.')
+	SETTING_ENABLED = CogSetting(
+		'enabled',
+		bool,
+		default_value=False,
+		brief='logging',
+		description='Whether this cog is enabled for a guild.',
+	)
 
 	STATE_EVENT_BUFFER = 'LoggingCog.eventBuffer'
 

rocketbot/cogs/patterncog.py

@@ -91,7 +91,7 @@ class PatternCog(BaseCog, name='Pattern Matching'):
 	various criteria. Patterns can be defined by mods for each guild.
 	"""
 
-	SETTING_PATTERNS = CogSetting('patterns', None)
+	SETTING_PATTERNS = CogSetting('patterns', None, default_value=None)
 
 	shared: Optional['PatternCog'] = None
 

rocketbot/cogs/urlspamcog.py

@@ -29,29 +29,44 @@ class URLSpamCog(BaseCog, name='URL Spam'):
 	Can be configured to take immediate action or just warn the mods.
 	"""
 
-	SETTING_ENABLED = CogSetting('enabled', bool,
-			brief='URL spam detection',
-			description='Whether URLs posted soon after joining are flagged.')
-	SETTING_ACTION = CogSetting('action', Literal['nothing', 'modwarn', 'delete', 'kick', 'ban'],
-			brief='action to take on spam',
-			description='The action to take on detected URL spam.',
-			enum_values={'nothing', 'modwarn', 'delete', 'kick', 'ban'})
-	SETTING_JOIN_AGE = CogSetting('joinage', timedelta,
-			brief='seconds since member joined',
-			description='The minimum seconds since the user joined the '
-				'server before they can post URLs. URLs posted by users '
-				'who joined too recently will be flagged. Keep in mind '
-				'many servers have a minimum 10 minute cooldown before '
-				'new members can say anything. Setting to 0 effectively '
-				'disables URL spam detection.',
-			usage='<seconds:int>',
-			min_value=timedelta(seconds=0))
-	SETTING_DECEPTIVE_ACTION = CogSetting('deceptiveaction', Literal['nothing', 'modwarn', 'modwarndelete', 'chatwarn', 'chatwarndelete', 'delete', 'kick', 'ban'],
-			brief='action to take on deceptive link markdown',
-			description='The action to take on chat messages with links '
-				'where the text looks like a different URL than the actual link.',
-			enum_values={'nothing', 'modwarn', 'modwarndelete',
-				'chatwarn', 'chatwarndelete', 'delete', 'kick', 'ban'})
+	SETTING_ENABLED = CogSetting(
+		'enabled',
+		bool,
+		default_value=False,
+		brief='URL spam detection',
+		description='Whether URLs posted soon after joining are flagged.',
+	)
+	SETTING_ACTION = CogSetting(
+		'action',
+		Literal['nothing', 'modwarn', 'delete', 'kick', 'ban'],
+		default_value='nothing',
+		brief='action to take on spam',
+		description='The action to take on detected URL spam.',
+		enum_values={'nothing', 'modwarn', 'delete', 'kick', 'ban'},
+	)
+	SETTING_JOIN_AGE = CogSetting(
+		'joinage',
+		timedelta,
+		default_value=timedelta(minutes=15),
+		brief='seconds since member joined',
+		description='The minimum seconds since the user joined the '
+					'server before they can post URLs. URLs posted by users '
+				    'who joined too recently will be flagged. Keep in mind '
+				    'many servers have a minimum 10 minute cooldown before '
+				    'new members can say anything. Setting to 0 effectively '
+				    'disables URL spam detection.',
+		min_value=timedelta(seconds=0),
+	)
+	SETTING_DECEPTIVE_ACTION = CogSetting(
+		'deceptiveaction',
+		Literal['nothing', 'modwarn', 'modwarndelete', 'chatwarn', 'chatwarndelete', 'delete', 'kick', 'ban'],
+		default_value='nothing',
+		brief='action to take on deceptive link markdown',
+		description='The action to take on chat messages with links '
+					'where the text looks like a different URL than the actual link.',
+		enum_values={'nothing', 'modwarn', 'modwarndelete',
+					 'chatwarn', 'chatwarndelete', 'delete', 'kick', 'ban'},
+	)
 
 	def __init__(self, bot):
 		super().__init__(

rocketbot/cogs/usernamecog.py

@@ -47,11 +47,15 @@ class UsernamePatternCog(BaseCog, name='Username Pattern'):
 	message on a match.
 	"""
 
-	SETTING_ENABLED = CogSetting('enabled', bool,
-			brief='username pattern detection',
-			description='Whether new users are checked for common patterns.')
+	SETTING_ENABLED = CogSetting(
+		'enabled',
+		bool,
+		default_value=False,
+		brief='username pattern detection',
+		description='Whether new users are checked for common patterns.',
+	)
 
-	SETTING_PATTERNS = CogSetting('patterns', None)
+	SETTING_PATTERNS = CogSetting('patterns', None, default_value=None)
 
 	def __init__(self, bot):
 		super().__init__(

rocketbot/cogsetting.py

@@ -11,7 +11,8 @@ from discord.ext.commands import Bot
 
 from config import CONFIG
 from rocketbot.storage import Storage
-from rocketbot.utils import bot_log, TimeDeltaTransformer, MOD_PERMISSIONS, dump_stacktrace
+from rocketbot.utils import bot_log, TimeDeltaTransformer, MOD_PERMISSIONS, dump_stacktrace, str_from_timedelta
+
 
 # def _fix_command(command: Command) -> None:
 # 	"""
@@ -35,9 +36,9 @@ class CogSetting:
 	def __init__(self,
 			name: str,
 			datatype: Optional[Type],
+			default_value: Any,
 			brief: Optional[str] = None,
 			description: Optional[str] = None,
-			usage: Optional[str] = None,
 			min_value: Optional[Any] = None,
 			max_value: Optional[Any] = None,
 			enum_values: Optional[set[Any]] = None):
@@ -48,6 +49,9 @@ class CogSetting:
 			Setting identifier. Must follow variable naming conventions.
 		datatype: Optional[Type]
 		    Datatype of the setting. E.g. int, float, str
+		default_value: Any
+			Value to use in the absence of a specified value for the guild and
+			no value in config.py.
 		brief: Optional[str]
 			Description of the setting, starting with lower case.
 			Will be inserted into phrases like "Sets <brief>" and
@@ -55,8 +59,6 @@ class CogSetting:
 		description: Optional[str]
 		  	Long-form description. Min, max, and enum values will be
 		    appended to the end, so does not need to include these.
-		usage: Optional[str]
-		    Description of the value argument in a set command, e.g. "<maxcount:int>"
 		min_value: Optional[Any]
 		    Smallest allowable value. Must be of the same datatype as
 		    the value. None for no minimum.
@@ -67,9 +69,9 @@ class CogSetting:
 		"""
 		self.name: str = name
 		self.datatype: Type = datatype
+		self.default_value = default_value
 		self.brief: Optional[str] = brief
 		self.description: str = description or ''  # Can't be None
-		self.usage: Optional[str] = usage
 		self.min_value: Optional[Any] = min_value
 		self.max_value: Optional[Any] = max_value
 		self.enum_values: Optional[set[Any]] = enum_values
@@ -117,6 +119,15 @@ class CogSetting:
 			return timedelta(seconds=stored_value)
 		return stored_value
 
+	def native_value_to_str(self, native_value: Any) -> str:
+		if native_value is None:
+			return '<no value>'
+		if isinstance(native_value, timedelta):
+			return str_from_timedelta(native_value)
+		if isinstance(native_value, bool):
+			return 'true' if native_value else 'false'
+		return f'{native_value}'
+
 	def __make_getter_command(self, cog: 'BaseCog') -> Command:
 		setting: CogSetting = self
 		setting_name = setting.name
@@ -130,12 +141,12 @@ class CogSetting:
 			if value is None:
 				value = setting.to_native_value(cog0.get_cog_default(setting.name))
 				await interaction.response.send_message(
-					f'{CONFIG["info_emoji"]} `{setting_name}` is using default of `{value}`',
+					f'{CONFIG["info_emoji"]} `{setting_name}` is using default of `{setting.native_value_to_str(value)}`',
 					ephemeral=True
 				)
 			else:
 				await interaction.response.send_message(
-					f'{CONFIG["info_emoji"]} `{setting_name}` is set to `{value}`',
+					f'{CONFIG["info_emoji"]} `{setting_name}` is set to `{setting.native_value_to_str(value)}`',
 					ephemeral=True
 				)
 
@@ -178,7 +189,7 @@ class CogSetting:
 			key = f'{cog0.__class__.__name__}.{setting.name}'
 			Storage.set_config_value(interaction.guild, key, setting.to_stored_value(new_value))
 			await interaction.response.send_message(
-				f'{CONFIG["success_emoji"]} `{setting_name}` is now set to `{new_value}`',
+				f'{CONFIG["success_emoji"]} `{setting_name}` is now set to `{setting.to_native_value(new_value)}`',
 				ephemeral=True
 			)
 			await cog0.on_setting_updated(interaction.guild, setting)
@@ -410,12 +421,12 @@ class CogSetting:
 							if value is not None:
 								text += '**' + ('enabled' if value else 'disabled') + '**'
 							else:
-								text += ('enabled' if deflt else 'disabled') + ' _(using default)_'
+								text += ('enabled' if deflt else 'disabled') + ' _(default)_'
 						else:
 							if value is not None:
-								text += f'\n- `{bcog.config_prefix}_{setting.name}` = **{value}**'
+								text += f'\n- `{bcog.config_prefix}_{setting.name}` = **{setting.native_value_to_str(value)}**'
 							else:
-								text += f'\n- `{bcog.config_prefix}_{setting.name}` = {deflt} _(using default)_'
+								text += f'\n- `{bcog.config_prefix}_{setting.name}` = {setting.native_value_to_str(deflt)} _(using default)_'
 				await interaction.response.send_message(
 					text,
 					ephemeral=True,