Stuck with implementing 'create song' for bot

[tracey-le]

Current work: https://github.com/e-a-h/That-Sky-Bot/blob/dev-music/cogs/Music.py

---

My earlier test (copied code from the old main.py): https://github.com/t1-tracey/That-Sky-Bot/blob/dev-music/cogs/Music.py

Bugs channel example: https://github.com/e-a-h/That-Sky-Bot/blob/dev-music/cogs/Bugs.py

---

I don't know how to implement asking the questions. Alex recommended to make each question a model, (which is in line with what Strawb suggested about making Parser, Song and Renderer separate). that will mean more reorganising.

I keep feeling too overwhelmed and incompetent on my own, about what to prioritise next, I need help

[tracey-le]

I tried to separate all the print and input statements in the original main.py (currently replaced with ask and output in Responder). This is because the bot uses await commands to send and ask messages.

But I'm not sure that the way I organised Responder is working. In the current work, I don't think I can override ask and output to be used like this...

(I've asked Alex to give access to jmmelko too to That-Sky-Bot btw. Strawb, if you'd like to push to That-Sky-Bot, just let me know and I'll ask Alex too)

[jmmelko]

I definitely can create the Renderer again, if needed. Or Strawb can do it if he wants to.

I don’t know much about bots, but I know that they are mostly conversational bots, so an ask-wait-and-answer logic seems fine.

Alex is nice but he talks in a very abstract (conceptual) manner. So I suppose we have to take a look at that-Sky-bot to get a proper example.

I’ll tell you what I find.

[jmmelko]

Ok, after a quick look, I have 3 comments:

• there is no way we could rewrite something like AutoResponders.py in a short time, so I hope we won’t have to, or else Alex has to do it

• a basic code for sending text to the channel seems to be: txt =Lang.get_string("welcome/welcome_msg", user=member.mention, rules_channel=rules_channel.mention, accept_emoji=Emoji.get_chat_emoji('CANDLE')) await welcome_channel.send(txt) This code is for a messages stored in a text file but there should be the equivalent for a simple text string, I think

• the bot seems to be able to perform asynchronous tasks (asyncio module), i.e. tasks in the background. The def keyword of such methods is preceded by “async”, and called with bot.loop.create_task(). I suppose await is also an asynchronous command. This may be useful to create several files in parallel. But that’s all I think, because the Music Maker program is pretty linear (notation->key->parsing). We could use this to ask the user for the song title etc while the song is being processed, but that would save little time and would force use to rewrite the rendering functions.

[jmmelko]

• A basic send string: content += f"There are {len(recent['verified'])} verified members" await ctx.send(content)

• to edit a message:

await message.edit(

• error handling and logging: except Exception as ex: Logging.info(f"failed to welcome unverified role.") Logging.error(ex) raise ex

3 questions remain unanswered:

1/ should we write “bot code” directly in our functions, or is there a way to wrap existing code? I hope there is.

2/ how do we wait for user input? I mean, can we just wait for the next text they type, or do we have to create a trigger ?and then the trigger would be very loose, meaning “if any text is typed”. (Maybe the answer is the same as for 3/)

3/ what do we do with the listening functions? @commands.Cog.listener()

They seem to be linked to trigger objects, defined in Utils.utils. Should we be able to use those or will Alex do it?

[jmmelko]

There seems to be a trigger list, a dictionary object with the following structure: `trigger = responder.trigger

chance = responder.chance / 10000 # chance is 0-10,000. make it look more like a percentage

self.triggers[guild.id][trigger] = { 'match_list': match_list, 'response': response, 'flags': flags, 'chance': chance, 'responsechannelid': responder.responsechannelid, 'listenchannelid': responder.listenchannelid } `

As for the trigger object, it seems to be nothing more than a list of words:

trigger = ''.join(words)

[tracey-le]

Oh I will just add, the only file we need to edit is Music.py in the Cogs folder of That-Sky-Bot.

Everything from our program will be there and can be imported, here is what it first looked like: https://github.com/e-a-h/That-Sky-Bot/commit/50233dc32811b096594533662428a326518606e1#diff-72f124c5161a0c6cab39520863827eea

[jmmelko]

Oh I will just add, the only file we need to edit is Music.py in the Cogs folder of That-Sky-Bot.

Everything from our program will be there and can be imported, here is what it first looked like: e-a-h/That-Sky-Bot@50233dc#diff-72f124c5161a0c6cab39520863827eea

Ok, but clearly a drawing (logical diagram) from Alex would help, showing the interactions with the rest of the bot, or at least a specification sheet telling:

• what are the input and output of the cog
• what are the obligatory methods a cogs should contain

Would be more efficient than looking into Krill.py and try to infer the rules from there. I’ll try my best though.

[tracey-le]

Yeah that would be helpful ;-;

There is just the discord.py documentation https://discordpy.readthedocs.io/en/latest/

[jmmelko]

Could be useful:

Waiting for a user reply:

@client.event
async def on_message(message):
if message.content.startswith('$greet'):
        channel = message.channel
        await channel.send('Say hello!')
        def check(m):
            return m.content == 'hello' and m.channel == channel

msg = await client.wait_for('message', check=check)
        await channel.send('Hello {.author}!'.format(msg))

[jmmelko]

What is a model? Does he mean that:

https://discordpy.readthedocs.io/en/latest/api.html#discord-models

I don’t think so since those classes are read-only. I have sent him a message to ask him what he meant.

[IchigoDaifuku]

should we write “bot code” directly in our functions, or is there a way to wrap existing code?

What do you mean bot code? I think there is a way to wrap functions - would using decorators or functools.wraps work?

Strawb, if you'd like to push to That-Sky-Bot, just let me know and I'll ask Alex too)

Thanks! I won't be able to push anything any time soon though.

I definitely can create the Renderer again, if needed. Or Strawb can do it if he wants to.

I definitely want to rewrite the renderer but I currently don't have Python 3, PIL and mido installed, so any code I write and push would be untested.

[jmmelko]

What do you mean bot code? I think there is a way to wrap functions - would using decorators or functools.wraps work?

Actually I mean anything that needs the modules discordpy, Utils, and aynscio. My fear is having to use channel.send(), decorators, asyncio, etc directly inside the core functions of the program. Especially I’d like to keep Instruments, Notes, Songs, Parsers, noteparsers untouched.

I definitely want to rewrite the renderer but I currently don't have Python 3, PIL and mido installed, so any code I write and push would be untested.

Ok, so let’s wait 2.5 weeks first ;-). Or rather 2.35.

In any case, before doing that, we’ll have to wait for the dev branch to be pulled to the beta one.

[jmmelko]

Okaaaay.... after talking with Alex (see here) it seems that it won’t be possible to go further if we don’t take the code to a more abstract level. It’s just that “the bot” and the music-maker program don’t talk the same language, so they’ll have to cross at midpoint. I could say that Alex and I don’t speak the same language, that would also apply 👽

Well, actually, we could, by using discordpy functions, and implementing dumb, linear, ask-and-wait interaction between the bot and the player, but I have the feeling that Alex would be somewhat reticent to push that.

Tracey has done a lot with putting main.py into the Responder object, but it was only the first step it seems. I know she has some ideas for the rest.

In any case, I think that everything peripheral to the Song, such as: title, composer, key, notation, is susceptible to become an object, as well as methods such as ask_song_title()

I remember the time when Tracy used her pencil and notebook and came out with this great idea of base 7 and completely revamped the parser. I hope she will succeed in doing that again 🤩

EDIT: I think pencils and notebooks are best suited to do one’s homework 😏

In any case, I’m open for discussion on the new structure; we should open a new issue for this.

The only thing that remains obscure is the partition between our work and Alex’s. I suspect that it will be 90/10% 😱