Add bot-initiated messaging ability #95
Conversation
The approach is to use an idle handler, which gets called whenever something else hasn't already happened, or once per second. This should help reduce rate limiting. Functional testing has been added. Updated README.md with how to use the new functionality. Resolves scrapinghub#92.
|
Oh boy, didn't see #89 and #54 already. Hmm well I'll leave this open as it's another approach. It's basically like #54 except it provides easy access to the Also it opens direct message channels if they aren't open yet. I think this may be necessary for messaging a user who has never messaged you, for example. |
|
@lins05 due to @prathyush not updating his PR, do you think we could focus on this one and fix what is needed to merge it? I think this would be really useful for slackbot. |
| @@ -72,3 +73,6 @@ def get_plugins(self, category, text): | |||
|
|
|||
| if not has_matching_plugin: | |||
| yield None, None | |||
|
|
|||
| def get_idle_plugins(self): | |||
| yield from self.idle_commands | |||
There was a problem hiding this comment.
@csaftoiu: Not compatible with Python2.7. Can be changed to the following -
for c in self.idle_commands: yield c
There was a problem hiding this comment.
This is a neat PR. One of the big concepts it introduces is the idea of passing the client directly to a function. In the past, the client has been in message._client, implying that it's not meant to be a public interface. The changes you had to add to client (like channelfy and so on) reflect that. So, either we can clean up client and say that it has a stable API and should be user facing, or we should make a new type of interface, like a client-type object, that we expose both in messages and idle handlers. I think @lins05 might be a better person to make that decision 😄
| @idle | ||
| def bored(client): | ||
| if time.time() - last_bored >= 30: | ||
| last_bored = time.time() |
There was a problem hiding this comment.
Don't we need global last_bored to write to the outer scoped var?
| @@ -65,6 +66,17 @@ def wrapper(func): | |||
| return wrapper | |||
|
|
|||
|
|
|||
| # use optional_arg_decorator so users can either do @idle or @idle() | |||
| @optional_arg_decorator | |||
| if self._client.idle_time() < 1: | ||
| break | ||
|
|
||
| try: |
There was a problem hiding this comment.
I wonder if the next few lines should be in loop() or elsewhere. Unlike regular messages, this would mean that idle functions are run in the loop thread. Other messages are handled in their own thread, being added to the pool.
|
sad this isn't merged.. this is a killer PR |
|
Looks awesome! I'm excited to see this merged! |
|
Any chance of this being merged? |
The approach is to use an idle handler, which gets called whenever something else hasn't already happened, or once per second. This should help reduce rate limiting.
Functional testing has been added.
Updated README.md with how to use the new functionality.
Resolves #92.
Dev Notes
To allow the idle handler to send messages, I give it the instance of the
SlackClientas a parameter.To make
SlackClienteasier to use, I madesend_message,rtm_send_message, andupload_fileall take a "channelish" string, instead of a channel. This turns a string into a channel as follows:This way a user can just
client.send_message("some_user", "Here the message")instead of having to call any other helper functions.