Instructions for checklist

These examples demonstrate how addTask works. Note that the value for the new task is always False, and if the task can't be added because the desired name is already being used, a message is printed and None is returned.

In []:
addTask({}, 'New task')
Out[]:
{'New task': False}

In []:
addTask({'Task 1': False, 'Task 2': True}, 'New task')
Out[]:
{'Task 1': False, 'Task 2': True, 'New task': False}

In []:
addTask(
 {
  'Tent': False,
  'Sleeping bags': True,
  'Cooking supplies': True,
  'Camp chairs': False,
  'Snacks': False,
  'Meals': True,
 },
 'Flashlights'
)
Out[]:
{
 'Tent': False,
 'Sleeping bags': True,
 'Cooking supplies': True,
 'Camp chairs': False,
 'Snacks': False,
 'Meals': True,
 'Flashlights': False,
}

In []:
addTask({'only': True}, 'only')
Prints
That task already exists.

These examples demonstrate how taskStatus works. Note that if the named task isn't in the checklist, a message is printed and None is returned.

In []:
taskStatus({'Task 1': False, 'Task 2': True}, 'Task 1')
Out[]:
False

In []:
taskStatus(
 {
  'Tent': False,
  'Sleeping bags': True,
  'Cooking supplies': True,
  'Camp chairs': False,
  'Snacks': False,
  'Meals': True,
 },
 'Tent'
)
Out[]:
False

In []:
taskStatus(
 {
  'Tent': False,
  'Sleeping bags': True,
  'Cooking supplies': True,
  'Camp chairs': False,
  'Snacks': False,
  'Meals': True,
 },
 'Meals'
)
Out[]:
True

In []:
taskStatus({}, 'Item')
Prints
That task does not exist.

These examples demonstrate how completeTask works. Note that a message is printed and None is returned if the task isn't already in the checklist, or if a list is named instead of a task. Also note that if the task is already completed, that's not an error, and it just stays completed.

In []:
completeTask({'Task 1': False, 'Task 2': True}, 'Task 1')
Out[]:
{'Task 1': True, 'Task 2': True}

In []:
completeTask(
 {
  'Tent': False,
  'Sleeping bags': True,
  'Cooking supplies': True,
  'Camp chairs': False,
  'Snacks': False,
  'Meals': True,
 },
 'Tent'
)
Out[]:
{
 'Tent': True,
 'Sleeping bags': True,
 'Cooking supplies': True,
 'Camp chairs': False,
 'Snacks': False,
 'Meals': True,
}

In []:
completeTask(
 {
  'Tent': False,
  'Sleeping bags': True,
  'Cooking supplies': True,
  'Camp chairs': False,
  'Snacks': False,
  'Meals': True,
 },
 'Meals'
)
Out[]:
{
 'Tent': False,
 'Sleeping bags': True,
 'Cooking supplies': True,
 'Camp chairs': False,
 'Snacks': False,
 'Meals': True,
}

In []:
completeTask({}, 'Anything')
Prints
That task does not exist.

These examples demonstrate how resetChecklist works.

In []:
resetChecklist({'Task 1': False, 'Task 2': True})
Out[]:
{'Task 1': False, 'Task 2': False}

In []:
resetChecklist(
 {
  'Tent': False,
  'Sleeping bags': True,
  'Cooking supplies': True,
  'Camp chairs': False,
  'Snacks': False,
  'Meals': True,
 }
)
Out[]:
{
 'Tent': False,
 'Sleeping bags': False,
 'Cooking supplies': False,
 'Camp chairs': False,
 'Snacks': False,
 'Meals': False,
}

In []:
resetChecklist({})
Out[]:
{}

These examples demonstrate how lengthAndValue works. Note that although it will be used for sorting, it does not itself do any sorting or even involve a loop.

In []:
lengthAndValue('hello')
Out[]:
(5, 'hello')

In []:
lengthAndValue('hi')
Out[]:
(2, 'hi')

In []:
lengthAndValue('goodbye')
Out[]:
(7, 'goodbye')

These examples demonstrate how displayChecklist works. Note that whether a task is completed or not is indicated using either a capital 'X' or a space between square brackets. Also note that the keys of the checklist are sorted by the lengths of their names, shortest to longest, with ties broken by alphabetical order.

In []:
displayChecklist({'only': True})
Prints
[X] only

In []:
displayChecklist({'Task 1': False, 'Task 2': True})
Prints
[ ] Task 1
[X] Task 2

In []:
displayChecklist(
 {
  'Tent': False,
  'Sleeping bags': True,
  'Cooking supplies': True,
  'Camp chairs': False,
  'Snacks': False,
  'Meals': True,
 }
)
Prints
[ ] Tent
[X] Meals
[ ] Snacks
[ ] Camp chairs
[X] Sleeping bags
[X] Cooking supplies

These examples demonstrate how saveChecklist works. Note that the text it writes into the specified file is the same as what gets printed by displayChecklist, including the sorting of the keys. Also note that if the checklist is empty, nothing gets written to the file.

In []:
saveChecklist({'Task 1': False, 'Task 2': True}, 'checklist.txt')

File
checklist.txt
[ ] Task 1
[X] Task 2

In []:
saveChecklist(
 {
  'Tent': False,
  'Sleeping bags': True,
  'Cooking supplies': True,
  'Camp chairs': False,
  'Snacks': False,
  'Meals': True,
 },
 'camping.txt'
)

File
camping.txt
[ ] Tent
[X] Meals
[ ] Snacks
[ ] Camp chairs
[X] Sleeping bags
[X] Cooking supplies

In []:
saveChecklist({}, 'empty.txt')

File
empty.txt

These examples demonstrate how loadChecklist works. It operates as the opposite of saveChecklist. Note that in these examples, the file contents shown must exist before the function is called; they are not produced by it, unlike with saveChecklist.

In []:
loadChecklist('checklist.txt')
Out[]:
{'Task 1': False, 'Task 2': True}


File
checklist.txt
[ ] Task 1
[X] Task 2

In []:
loadChecklist('camping.txt')
Out[]:
{
 'Tent': False,
 'Meals': True,
 'Snacks': False,
 'Camp chairs': False,
 'Sleeping bags': True,
 'Cooking supplies': True,
}


File
camping.txt
[ ] Tent
[X] Meals
[ ] Snacks
[ ] Camp chairs
[X] Sleeping bags
[X] Cooking supplies

In []:
loadChecklist('empty.txt')
Out[]:
{}


File
empty.txt

In []:
loadChecklist('malformed.txt')
Prints
Invalid file format!


File
malformed.txt
Not
a
checklist.