-
Notifications
You must be signed in to change notification settings - Fork 0
/
todo_bot.py
458 lines (338 loc) · 13 KB
/
todo_bot.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
import logging
import todo_choices
from telegram import Update, ReplyKeyboardMarkup, ReplyKeyboardRemove
from telegram.ext import MessageHandler, ApplicationBuilder, ContextTypes, CommandHandler, ConversationHandler, filters
# enables logging
logging.basicConfig(
format='%(asctime)s - %(name)s - %(levelname)s - %(message)s',
level=logging.INFO
)
# defines the different states of the todo bot as part of a conversation
# see conversationbot2.py on the python-telegram-bot github for ref
CHOOSING, ADD, EDIT, DELETE, EDIT_CHOICE, COMMIT_EDIT, COMMIT_DELETE = range(7)
# This will be the default keyboard with the various options:
# 1. add todo
# 2. edit todo
# 3. delete todo
# 4. view todo
reply_keyboard = [
['Add Todo', 'View Todo'],
['Edit Todo', 'Delete Todo'],
['Exit']
]
markup = ReplyKeyboardMarkup(
keyboard = reply_keyboard,
one_time_keyboard = True
)
def task_dict_to_str(task_dict):
"""Helper function to format user info"""
task_str = [f'{key}: {value}' for key, value in task_dict.items()]
return '\n'.join(task_str) + '\n\n'
async def start(update: Update, context: ContextTypes.DEFAULT_TYPE):
"""
Starts the conversation and sets up the keyboard with user options.
"""
await context.bot.send_message(
chat_id = update.effective_chat.id,
text = 'Hi there! I am a todo bot.\n' + \
'What can I do for you today?',
reply_markup = markup
)
return CHOOSING
async def add(update: Update, context: ContextTypes.DEFAULT_TYPE):
"""Asks the user to add a task"""
await context.bot.send_message(
chat_id = update.effective_chat.id,
text = 'Add a task? Sounds good! What is your task?' + \
'\n\nOr, press /cancel to go back to the menu.'
)
return ADD
async def add_todo(update: Update, context: ContextTypes.DEFAULT_TYPE):
"""Processes the user's input and adds it into database"""
task = update.message.text
await context.bot.send_message(
chat_id = update.effective_chat.id,
text = f'New Task: "{task}". I will add this in!'
)
try:
todo_choices.add_task(task)
await context.bot.send_message(
chat_id = update.effective_chat.id,
text = 'The task has been added successfully! ' + \
'What else would you like to do?',
reply_markup = markup
)
except:
await context.bot.send_message(
chat_id = update.effective_chat.id,
text = 'Something went wrong, or the task may already exist.',
reply_markup = markup
)
return CHOOSING
async def view(update: Update, context: ContextTypes.DEFAULT_TYPE):
"""Displays all tasks"""
tasks = todo_choices.view_tasks()
if not tasks: # empty list
text = 'You have not added any tasks. Add some before viewing!'
else:
text = 'Your saved tasks:\n\n'
for task in tasks:
text += task_dict_to_str(task)
await context.bot.send_message(
chat_id = update.effective_chat.id,
text = text,
reply_markup = markup
)
return CHOOSING
async def edit(update: Update, context: ContextTypes.DEFAULT_TYPE):
"""Allows the user to choose tasks to edit"""
tasks = todo_choices.view_tasks()
if not tasks: # empty list
text = 'You have not added any tasks. Add some before editing!'
await context.bot.send_message(
chat_id = update.effective_chat.id,
text = text,
reply_markup = markup
)
return CHOOSING
else:
task_list = [[task['TaskName'] for task in tasks]]
tasks_keyboard = ReplyKeyboardMarkup(
keyboard = task_list,
one_time_keyboard = True
)
await context.bot.send_message(
chat_id = update.effective_chat.id,
text = 'Editing? Which task would you like to edit?' + \
'\n\nOr, press /cancel to go back to the menu.',
reply_markup = tasks_keyboard
)
return EDIT
async def choose_edit(update: Update, context: ContextTypes.DEFAULT_TYPE):
"""Choose what to edit"""
# save the user's choice temporarily in a chat-based dictionary
user_data = context.user_data
user_data['task_name'] = update.message.text
markup = ReplyKeyboardMarkup(
keyboard = [['Task Name', 'Status']],
one_time_keyboard = True
)
await context.bot.send_message(
chat_id = update.effective_chat.id,
text = 'Choose which values to update!' + \
'\n\nOr, press /cancel to go back to the menu.',
reply_markup = markup
)
return EDIT_CHOICE
async def edit_name(update: Update, context: ContextTypes.DEFAULT_TYPE):
"""Asks the user to provide the newly edited task name"""
user_data = context.user_data
user_data['edit_choice'] = 'TaskName'
await context.bot.send_message(
chat_id = update.effective_chat.id,
text = f'Enter the new task name for "{user_data["task_name"]}".' + \
'\n\nOr, press /cancel to go back to the menu.',
)
return COMMIT_EDIT
async def edit_status(update: Update, context: ContextTypes.DEFAULT_TYPE):
"""Asks the user to provide the newly edited status"""
user_data = context.user_data
user_data['edit_choice'] = 'Status'
markup = ReplyKeyboardMarkup(
keyboard = [['Completed', 'Incomplete']],
one_time_keyboard = True
)
await context.bot.send_message(
chat_id = update.effective_chat.id,
text = f'Choose a new status for "{user_data["task_name"]}".' + \
'\n\nOr, press /cancel to go back to the menu.',
reply_markup = markup
)
return COMMIT_EDIT
async def process_edit(update: Update, context: ContextTypes.DEFAULT_TYPE):
"""Commits the edit based on the selected options"""
new_value = update.message.text
user_data = context.user_data
try:
# update database
todo_choices.edit(
user_data['task_name'],
user_data['edit_choice'],
new_value
)
await context.bot.send_message(
chat_id = update.effective_chat.id,
text = 'Edit is complete! What would you like to do now?',
reply_markup = markup
)
except:
await context.bot.send_message(
chat_id = update.effective_chat.id,
text = 'Something went wrong with the edit. ' + \
'Duplicate tasks might have occurred',
reply_markup = markup
)
# clears stored data for edits after edit process is finished
user_data.clear()
return CHOOSING
async def delete(update: Update, context: ContextTypes.DEFAULT_TYPE):
"""Allows the user to delete tasks"""
tasks = todo_choices.view_tasks()
if not tasks: # empty list
text = 'You have not added any tasks. Add some before deleting!'
await context.bot.send_message(
chat_id = update.effective_chat.id,
text = text,
reply_markup = markup
)
return CHOOSING
else:
task_list = [[task['TaskName'] for task in tasks]]
tasks_keyboard = ReplyKeyboardMarkup(
keyboard = task_list,
one_time_keyboard = True
)
await context.bot.send_message(
chat_id = update.effective_chat.id,
text = 'Deleting? Which task would you like to delete?' + \
'\n\nOr, press /cancel to go back to the menu.',
reply_markup = tasks_keyboard
)
return DELETE
async def confirm_del(update: Update, context: ContextTypes.DEFAULT_TYPE):
"""Asks the user for confirmation to delete task"""
user_data = context.user_data
user_data['task_name'] = update.message.text
markup = ReplyKeyboardMarkup(
keyboard = [['Yes', 'No']],
one_time_keyboard = True
)
await context.bot.send_message(
chat_id = update.effective_chat.id,
text = f'Are you sure you want to delete "{user_data["task_name"]}"?' + \
'\n\nOr, press /cancel to go back to the menu.',
reply_markup = markup
)
return COMMIT_DELETE
async def process_del(update: Update, context: ContextTypes.DEFAULT_TYPE):
"""Commits the deletion based on user selection"""
choice = update.message.text
if choice == 'No':
await context.bot.send_message(
chat_id = update.effective_chat.id,
text = f'No worries! What do you want to do now?',
reply_markup = markup
)
else:
user_data = context.user_data
task_name = user_data['task_name']
todo_choices.delete(task_name)
user_data.clear()
await context.bot.send_message(
chat_id = update.effective_chat.id,
text = f'Deletion successful! What do you want to do now?',
reply_markup = markup
)
return CHOOSING
async def cancel(update: Update, context: ContextTypes.DEFAULT_TYPE):
"""Command to allow user to cancel process and return to menu"""
user_data = context.user_data
user_data.clear()
await context.bot.send_message(
chat_id = update.effective_chat.id,
text = 'Alright! What would you like to do now?',
reply_markup = markup
)
return CHOOSING
async def exit(update: Update, context: ContextTypes.DEFAULT_TYPE):
"""Ends and exits the conversation immediately"""
# clear user_data
user_data = context.user_data
user_data.clear()
await context.bot.send_message(
chat_id = update.effective_chat.id,
text = 'Thanks for using me! Press /start to use me again 😋😋',
reply_markup = ReplyKeyboardRemove()
)
return ConversationHandler.END
def main():
"""Runs the application"""
# create application and pass in bot token
TOKEN = "5699172169:AAE30agPT1rbtXDFrVYuSv5D7IMZwCE6BkM" # change this to the actual one after tests are done
app = ApplicationBuilder().token(TOKEN).build()
# add in conversation handler with the various states
conv_handler = ConversationHandler(
entry_points = [CommandHandler('start', start)],
states = {
CHOOSING: [
MessageHandler(
filters = filters.Regex("^Add Todo$"),
callback = add
),
MessageHandler(
filters = filters.Regex("^View Todo$"),
callback = view
),
MessageHandler(
filters = filters.Regex("^Edit Todo$"),
callback = edit
),
MessageHandler(
filters = filters.Regex("^Delete Todo$"),
callback = delete
)
],
ADD: [
MessageHandler(
filters = filters.TEXT & ~(filters.COMMAND | filters.Regex("^Exit$")),
callback = add_todo
)
],
EDIT: [
MessageHandler(
filters = filters.TEXT & ~(filters.COMMAND | filters.Regex("^Exit$")),
callback = choose_edit
)
],
EDIT_CHOICE: [
MessageHandler(
filters = filters.Regex("^Task Name$"),
callback = edit_name
),
MessageHandler(
filters = filters.Regex("^Status$"),
callback = edit_status
)
],
COMMIT_EDIT: [
MessageHandler(
filters = filters.TEXT & ~(filters.COMMAND | filters.Regex("^Exit$")),
callback = process_edit
)
],
DELETE: [
MessageHandler(
filters = filters.TEXT & ~(filters.COMMAND | filters.Regex("^Exit$")),
callback = confirm_del
)
],
COMMIT_DELETE: [
MessageHandler(
filters = filters.Regex("^(Yes|No)$"),
callback = process_del
)
]
},
fallbacks = [
MessageHandler(
filters = filters.Regex("^Exit$"),
callback = exit
),
CommandHandler('cancel', cancel)
]
)
app.add_handler(conv_handler)
# run the bot until ctrl-c
app.run_polling()
if __name__ == '__main__':
main()