ecasbot.settings.Settings Class Reference

Public Member Functions
def	__init__ (self, schid)
def	add_stopword
def	add_watch
def	admins (self)
def	bantime (self)
def	chkrgx (self)
def	fmterr (self)
def	fmtlog (self)
def	get_cfgpath (self)
def	get_watchers
def	load (self)
def	logtofile (self)
def	maxemoji (self)
def	maxname (self)
def	msggoal (self)
def	nickgoal (self)
def	remove_stopword
def	remove_watch
def	restent (self)
def	restricted_languages (self)
def	save (self)
def	stopwords (self)
def	stwrgx (self)
def	tgkey (self)
def	urlrgx (self)
def	watches (self)

Static Public Member Functions
def	get_logging_level ()

Private Member Functions
def	__check_schema (self, schid)
def	__check_watchers
def	__find_cfgfile (self)

Private Attributes
	__appname
	__cfgfile
	__data

Constructor & Destructor Documentation

__init__()

def ecasbot.settings.Settings.__init__	(		self,
			schid,
			None
	)

Main constructor of Settings class.
:param schid: Required schema version.

Member Function Documentation

__check_schema()

def ecasbot.settings.Settings.__check_schema (   self,   schid,   bool  )

private

Check JSON config schema version.
:param schid: New schema version.
:return: True if equal.

__find_cfgfile()

def ecasbot.settings.Settings.__find_cfgfile (   self,   None  )

private

Get fully-qualified path to main configuration file.

admins()

def ecasbot.settings.Settings.admins	(		self,
			list
	)

Get bot admins list. This users can execute any bot command and even
control supergroups using special bot actions.
:return: Bot admins list.

bantime()

def ecasbot.settings.Settings.bantime	(		self,
			int
	)

Get user ban time (in seconds). Bot will restrict new users for
this time.
:return: Restriction time.

chkrgx()

def ecasbot.settings.Settings.chkrgx	(		self,
			str
	)

Get regular expression for checking user names on joining supergroups.
:return: Regex for user names checking.

fmterr()

def ecasbot.settings.Settings.fmterr	(		self,
			int
	)

Get custom formatter for stderr (journald) logs.
:return: Custom formatter for stderr logs.

fmtlog()

def ecasbot.settings.Settings.fmtlog	(		self,
			int
	)

Get custom formatter for file logs.
:return: Custom formatter for text logs.

get_cfgpath()

def ecasbot.settings.Settings.get_cfgpath	(		self,
			str
	)

Get directory where bot's configuration are stored.
User can override this setting by exporting CFGPATH
environment option.
:return: Full directory path.

get_logging_level()

def ecasbot.settings.Settings.get_logging_level (   int )

static

Get current log level. User can override this setting by exporting
LOGLEVEL environment option.
:return:

load()

def ecasbot.settings.Settings.load	(		self,
			None
	)

Load settings from JSON file.

logtofile()

def ecasbot.settings.Settings.logtofile	(		self,
			str
	)

Get log file name. If not set or empty, stderr will be used.
:return: Log file name.

maxemoji()

def ecasbot.settings.Settings.maxemoji	(		self,
			int
	)

Get maximum allowed emoji count in messages of new users. Bot
will remove messages exceeding this limit.
:return: Maximum emoji count in messages.

maxname()

def ecasbot.settings.Settings.maxname	(		self,
			int
	)

Get maximum allowed length of name. Bot will score users with
very long names.
:return: Maximum username length.

msggoal()

def ecasbot.settings.Settings.msggoal	(		self,
			int
	)

Get number of score points after message checks required to
delete it.
:return: Maximum score points required.

nickgoal()

def ecasbot.settings.Settings.nickgoal	(		self,
			int
	)

Get number of score points after nickname checks required to
block new joined user.
:return: Maximum score points required.

restent()

def ecasbot.settings.Settings.restent	(		self,
			list
	)

Get list of forbidden entitles for new users. Bot will remove any
messages from restricted users contains any of it.
:return: List of forbidden entitles.

restricted_languages()

def ecasbot.settings.Settings.restricted_languages	(		self,
			list
	)

Get list of restricted languages.
:return: Blocked langs list.

save()

def ecasbot.settings.Settings.save	(		self,
			None
	)

Save current settings to JSON file.

stopwords()

def ecasbot.settings.Settings.stopwords	(		self,
			list
	)

Get list of forbidden words in nicknames of new users. Bot will
score such users.
:return: List of forbidden words in user names.

stwrgx()

def ecasbot.settings.Settings.stwrgx	(		self,
			str
	)

Get regular expression for checking forbidden words in nicknames
or new messages.
:return: Regex with forbidden words.

tgkey()

def ecasbot.settings.Settings.tgkey	(		self,
			str
	)

Get Telegram Bot API token.
:return: Bot API token.

urlrgx()

def ecasbot.settings.Settings.urlrgx	(		self,
			str
	)

Get regular expression for checking if string contains any URLs.
:return: Regex for URL checking.

watches()

def ecasbot.settings.Settings.watches	(		self,
			list
	)

Get watch list for reports feature.
:return: Watch list.