Redesigned for plugins and aliases support #19

kolayne · 2023-01-17T11:13:10Z

Decomposed Rimokon code into core and plugins. Introduced aliases.

Resolves #13

- Invalidate most of the readme - Update the filetree to match the upcoming updates - Minor updates to the files to preserve the bot functioning

The core part of the bot does not handle it in a proper plugin manner (yet), but it's going to be fixed in the next commit(s)

Implemented the action lookup function that will be used to find the action function corresponding to received commands. Added terminology.txt (temp file) that states the differences between plugin, action, and command.

Implemented the run-rawrun-shell functionality as a plugin, represented key/type actions through that plugin implementation and made use of them in the main file, dropping their previous implementations; Added plugin helpers, which currently contain decorators for notifying of action execution; Removed dangling stuff from Rimokon/__main__.py and Rimokon/__util__.py.

Fixed a missing import; fixed bugs in `cmd_get_*`, extended `cmd_get_rest` to preserve whitespace when requested.

In import_config.py implemented importing config and canonicalizing actions and aliases defined in it.

The long description at config.py.example are going to be moved to Wikis (#18)

One more step on the way to #15

kolayne · 2023-01-17T11:14:05Z

Oops, forgot about the README and the /help command

+ removed the temporary terminology.txt

Generate help message from the enabled actions and aliases. Modified and moved /start message, fixed #16

Pylint reports unexpected keyword argument "notify"

kolayne

There are things to fix

kolayne · 2023-01-23T09:08:04Z

Rimokon/util.py

+
+def cmd_get_rest(s: str, cut_first_whitespace: bool = True) -> str:
+    """
+    Cut the first word of the string and (optionally, default) the first whitespace symbol after it.


Suggested change

Cut the first word of the string and (optionally, default) the first whitespace symbol after it.

Cut the first word of the string and, optionally, the first whitespace symbol after it (default).

kolayne · 2023-02-12T08:43:03Z

README.md

-[@myidbot](https://t.me/myidbot).
+-  Copy `Rimokon/config.py.example` to `Rimokon/config.py` and modify it according to your use case.
+   Optionally, install `xdotool`/`ydotool` or a similar utility for graphics interaction.
+   Use [@BotFather


kolayne · 2023-02-12T08:46:44Z

Rimokon/__main__.py

+
+
+# Decorator that prevents the actions when executed by a non-admin user.
+# Must be specified UNDER the `@bot.*_handler` decorator (must be applied before it)


Suggested change

# Must be specified UNDER the `@bot.*_handler` decorator (must be applied before it)

# Must be specified UNDER the `@bot.*_handler` decorator (that is, be applied before it)

kolayne · 2023-02-12T08:50:24Z

Rimokon/config.py.example

+# It is an array of arrays of strings. Second-level arrays represent lines of keyboard (top-to-bottom),
+# strings in them are the commands for the keyboard.
+#
+# `quick_access_cmds` can be empty (or completely omitted in the config), but its subarrays and the strings


It can't be omitted any longer, can it?

kolayne · 2023-02-12T08:55:09Z

Rimokon/import_config.py

+    # TODO: use logger object
+    logger.critical(*args)


Suggested change

# TODO: use logger object

logger.critical(*args)

logger.critical(*args)

Rimokon/import_config.py

kolayne · 2023-02-19T12:44:43Z

Rimokon/import_config.py

+    if k in updated_aliases.keys():
+        die('Attempt to redefine alias %s (in `config.aliases`)', repr(k))
+    if k in updated_actions.keys():
+        die('Alias %s attempts to overwrite an existing action', repr(k_))


I would make this error messages look more similar

kolayne · 2023-02-19T12:45:11Z

Rimokon/import_config.py

+    if k in updated_actions.keys():
+        die('Alias %s attempts to overwrite an existing action', repr(k_))
+    if isinstance(v_, str):
+        base_plugin = cmd_get_action_name(v_)


base_action_name?

Rimokon/import_config.py

kolayne · 2023-02-19T13:03:09Z

Rimokon/plugins/plugin_helpers.py

+
+    Modifes an action function (which accepts `telebot.TeleBot` and `telebot.Message` as its
+    first position arguments) such that an additional kw-only argument `notify` is added to
+    the function. If it is `True` (default), the behavior is the same with `notify_of_execution`;


Suggested change

the function. If it is `True` (default), the behavior is the same with `notify_of_execution`;

the function. If it is `True` (default), the behavior is the same as with `notify_of_execution`;

But maybe it's better to elaborate on the behavior instead of referring to another function

kolayne · 2023-02-27T14:04:19Z

Rimokon/config.py.example

+aliases = {
+    # A "simple alias" (or "string alias") just expands the given action name in the beginning of the
+    # received commands to the value. Notice that it is interpreted just like other action names,
+    # i.e. letters lower/upper case or trailing slashes do not matter.


Suggested change

# i.e. letters lower/upper case or trailing slashes do not matter.

# i.e. letters lower/upper case or leading slashes do not matter.

kolayne · 2023-02-27T14:13:44Z

Rimokon/import_config.py

+    else:
+        die('The alias %s specifies neither a string nor a callable object', repr(k_))
+    # Note: the above checks are not comprehensive, as the function isn't ensured to
+    # accept the correct set of parameters.


Here it's unclear what function we are talking about

kolayne added 9 commits January 10, 2023 23:56

Start restructuring

6a35dbb

- Invalidate most of the readme - Update the filetree to match the upcoming updates - Minor updates to the files to preserve the bot functioning

Turned screenshot creation into a plugin

61390c9

The core part of the bot does not handle it in a proper plugin manner (yet), but it's going to be fixed in the next commit(s)

Implemented action lookup function, added terminology.txt

6d31c45

Implemented the action lookup function that will be used to find the action function corresponding to received commands. Added terminology.txt (temp file) that states the differences between plugin, action, and command.

Rewrote util.py (for the upcoming import_config.py)

877f3bd

Fixed a missing import; fixed bugs in `cmd_get_*`, extended `cmd_get_rest` to preserve whitespace when requested.

Implemented config importing and canonicalization

d3b1cb4

In import_config.py implemented importing config and canonicalizing actions and aliases defined in it.

Implemented actual config parsing, added explanations

f84572e

The long description at config.py.example are going to be moved to Wikis (#18)

Nicer logging - using the logger object

4380987

One more step on the way to #15

Carefully handle exceptions and notify user of them

dc01bef

kolayne self-assigned this Jan 17, 2023

kolayne added 2 commits January 17, 2023 17:27

Actualized README.md

87e8a61

+ removed the temporary terminology.txt

Implemented /help message generation for actions

ce2056d

Generate help message from the enabled actions and aliases. Modified and moved /start message, fixed #16

kolayne force-pushed the redesgin_for_plugins branch from 610a93e to ce2056d Compare January 17, 2023 16:22

Fix pylint false-positives

961d298

Pylint reports unexpected keyword argument "notify"

kolayne commented Feb 19, 2023

View reviewed changes

kolayne commented Feb 27, 2023

View reviewed changes

kolayne added 2 commits February 27, 2023 17:22

Renames, documentation fixes

65ce781

Readme: remove the outdated notice

3e92662

kolayne force-pushed the redesgin_for_plugins branch from 0eef5f0 to 3e92662 Compare February 27, 2023 14:24

kolayne merged commit 461cf05 into master Feb 27, 2023

kolayne deleted the redesgin_for_plugins branch February 27, 2023 14:30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Redesigned for plugins and aliases support #19

Redesigned for plugins and aliases support #19

kolayne commented Jan 17, 2023

kolayne commented Jan 17, 2023

kolayne left a comment

kolayne Jan 23, 2023

kolayne Feb 12, 2023

kolayne Feb 12, 2023

kolayne Feb 12, 2023

kolayne Feb 12, 2023

kolayne Feb 19, 2023

kolayne Feb 19, 2023

kolayne Feb 19, 2023

kolayne Feb 27, 2023

kolayne Feb 27, 2023

	Cut the first word of the string and (optionally, default) the first whitespace symbol after it.
	Cut the first word of the string and, optionally, the first whitespace symbol after it (default).



		# Decorator that prevents the actions when executed by a non-admin user.
		# Must be specified UNDER the `@bot.*_handler` decorator (must be applied before it)

	# TODO: use logger object
	logger.critical(*args)
	logger.critical(*args)

	the function. If it is `True` (default), the behavior is the same with `notify_of_execution`;
	the function. If it is `True` (default), the behavior is the same as with `notify_of_execution`;

	# i.e. letters lower/upper case or trailing slashes do not matter.
	# i.e. letters lower/upper case or leading slashes do not matter.

Redesigned for plugins and aliases support #19

Redesigned for plugins and aliases support #19

Conversation

kolayne commented Jan 17, 2023

kolayne commented Jan 17, 2023

kolayne left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment