filled_Introduction_to_Programming_with_Python_3.ipynb

{
 "cells": [
  {
   "attachments": {},
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Introduction to Programming with Python - Part 3\n",
    "\n",
    "## Setup\n",
    "\n",
    "With this Google Colaboratory (Colab) notebook open, click the \"Copy to Drive\" button that appears in the menu bar. The notebook will then be attached to your own user account, so you can edit it in any way you like -- you can even take notes directly in the notebook.\n",
    "\n",
    "## Learning objectives\n",
    "\n",
    "By the end of our workshop today, we hope you'll build on basic Python syntax to understand functions and reading and writing files. With these in hand, you'll know enough to write and apply basic scripts and explore other features of the language.  \n",
    "\n",
    "## Today's Topics\n",
    "\n",
    "- Functions\n",
    "- Reading and writing files\n",
    "\n",
    "If you would like to learn more about data analysis using Python, we will explore these topics in our Python Open Lab series.\n",
    "\n",
    "For a reference to previous workshop content, you can access a version of the previous workshop materials with all example and exercise code completed in the [Introduction to Programming with Python - Part 1 filled notebook](https://colab.research.google.com/github/ncsu-libraries-data-vis/introduction-to-programming-with-python/blob/main/filled_Introduction_to_Programming_with_Python_1.ipynb) and [Introduction to Programming with Python - Part 2 filled notebook](https://colab.research.google.com/github/ncsu-libraries-data-vis/introduction-to-programming-with-python/blob/main/filled_Introduction_to_Programming_with_Python_1.ipynb).\n",
    "\n",
    "## Questions during the workshop\n",
    "\n",
    "Please feel free to ask questions throughout the workshop.\n",
    "\n",
    "We have a second instructor who will available during the workshop. They will answer as able, and will collect questions with answers that might help everyone to be answered at the end of the workshop."
   ]
  },
  {
   "attachments": {},
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Functions\n",
    "\n",
    "At the most basic level, functions are chunks of reusable code. A function can optionally accept data, defined as parameters and passed in as arguments, and optionally return data.\n",
    "\n",
    "A function is declared using the generalized syntax:\n",
    "\n",
    "```python\n",
    "def function_name(parameter_1, parameter_2, parameter_3):\n",
    "    indented function code...\n",
    "    return value\n",
    "```\n",
    "\n",
    "To learn more about functions:\n",
    "\n",
    "- [\"Functions\" chapter of *A Byte of Python*](https://python.swaroopch.com/functions.html)\n",
    "- [Python documentation for defining functions](https://docs.python.org/3/tutorial/controlflow.html#defining-functions)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 7,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "'HELLO'"
      ]
     },
     "execution_count": 7,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "# Python built-in functions\n",
    "len(\"Hello\")\n",
    "\n",
    "# Object methods\n",
    "\"Hello\".upper()"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 8,
   "metadata": {
    "colab": {
     "base_uri": "https://localhost:8080/"
    },
    "executionInfo": {
     "elapsed": 265,
     "status": "ok",
     "timestamp": 1613508328055,
     "user": {
      "displayName": "Walt Gurley",
      "photoUrl": "https://lh3.googleusercontent.com/a-/AOh14Gg9eQ8NtdhzyTtyTqhb-4LANYN8W8pA7TUUhK54=s64",
      "userId": "03624837261806285415"
     },
     "user_tz": 300
    },
    "id": "DuPwMqK5A4BN",
    "outputId": "ea2c2b1c-7a76-404d-a7c9-e96f2964194b"
   },
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "Hello, it's nice to see you!\n",
      "Hello, it's nice to see you!\n"
     ]
    },
    {
     "data": {
      "text/plain": [
       "NoneType"
      ]
     },
     "execution_count": 8,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "# Define a function named \"print_hello\" that prints out a hello message -- note\n",
    "# the use of indenting!\n",
    "def print_hello():\n",
    "  print(\"Hello, it's nice to see you!\")\n",
    "\n",
    "# Call the print_hello function to run the code contained in the function\n",
    "print_hello()\n",
    "\n",
    "# Print the type of the value returned from calling the print_hello function\n",
    "type(print_hello())"
   ]
  },
  {
   "attachments": {},
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Returning data from a function\n",
    "\n",
    "The `print_hello` function above does not return any data, it only calls a `print` function. We cannot do anything with this function beyond printing a message. We can use the special `return` keyword to return a value when a function is called."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 9,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "str"
      ]
     },
     "execution_count": 9,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "# Define a function named \"return_hello\" that returns a hello message\n",
    "def return_hello():\n",
    "    return \"Hello, it's nice to see you!\"\n",
    "\n",
    "# Call the return_hello function\n",
    "return_hello()\n",
    "\n",
    "# Print the type of the return value of the \"return_hello\" function\n",
    "type(return_hello())"
   ]
  },
  {
   "attachments": {},
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "Return values can be stored in variables and used just like other values"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 10,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "\"HELLO, IT'S NICE TO SEE YOU!\""
      ]
     },
     "execution_count": 10,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "# Store the return value of \"return_hello\"\n",
    "hello = return_hello()\n",
    "\n",
    "# Print it out\n",
    "hello.upper()"
   ]
  },
  {
   "attachments": {},
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Function parameters\n",
    "\n",
    "A function can have defined parameters that serve as variables within the function code. Parameters are defined within the parentheses of a function definition and are separated by commas. When you call a function you provide the values, or arguments, in the same way."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 11,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "\"Hello Bill, it's nice to see you at Intro to Python today!\""
      ]
     },
     "execution_count": 11,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "# Define a function named \"return_hello_personal\" that returns a personalized\n",
    "# hello message for a given person's name and a workshop name\n",
    "def return_hello_personal(name, workshop):\n",
    "    return \"Hello \" + name + \", it's nice to see you at \" + workshop + \" today!\"\n",
    "\n",
    "# Call the function with provided arguments\n",
    "return_hello_personal(\"Bill\", \"Intro to Python\")"
   ]
  },
  {
   "attachments": {},
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "Arguments passed to a function can be variables"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 12,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "\"Hello walt, it's nice to see you at Intro to Python, Part 3 today!\""
      ]
     },
     "execution_count": 12,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "# Define variables to pass into personalized hello message function\n",
    "me = \"walt\"\n",
    "session = \"Intro to Python, Part 3\"\n",
    "\n",
    "# Call the personalized hello message function with the variables\n",
    "return_hello_personal(me, session)"
   ]
  },
  {
   "attachments": {},
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Using functions\n",
    "\n",
    "Functions are useful for grouping long or complex code blocks that can to be used more than once."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 13,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "'This! is! a! boring! sentence!'"
      ]
     },
     "execution_count": 13,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "# Define a function that replaces periods with exclamation marks in a string\n",
    "def replace_period(string):\n",
    "  new_string = \"\"\n",
    "  for char in string:\n",
    "    if char == \".\":\n",
    "      new_string = new_string + \"!\"\n",
    "    else:\n",
    "      new_string = new_string + char\n",
    "  return new_string\n",
    "\n",
    "# Call the function on a string that contains periods\n",
    "replace_period(\"This. is. a. boring. sentence.\")"
   ]
  },
  {
   "attachments": {},
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "**Try it yourself:** Create a function named `add_nums` that takes two numbers as arguments and returns the results of adding these two numbers\n",
    "\n",
    "For example: `add_nums(2, 3)` should return `5`"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 14,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "8"
      ]
     },
     "execution_count": 14,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "# Define a function that returns the results of adding two numbers passed as \n",
    "# arguments\n",
    "def add_nums(num_1, num_2):\n",
    "    return num_1 + num_2\n",
    "\n",
    "# Call the function on two numbers\n",
    "add_nums(5, 3)"
   ]
  },
  {
   "attachments": {},
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "**Bonus Try it yourself:** Create a function named `count_a` that takes a list of single letters and returns the count of the occurrence of the letter \"a\"\n",
    "\n",
    "For example: `count_a([\"a\", \"b\", \"a\"])` should return `2`\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 1,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "2"
      ]
     },
     "execution_count": 1,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "# A function that returns the count of \"a\"s in a list of letters\n",
    "def count_a(letters):\n",
    "    count = 0\n",
    "    for letter in letters:\n",
    "        if letter == \"a\":\n",
    "            count = count + 1\n",
    "    return count\n",
    "\n",
    "# A list of letters to test your function\n",
    "test_list = [\"a\", \"b\", \"a\"]\n",
    "\n",
    "# Call the function on the provided list of letters\n",
    "count_a(test_list)"
   ]
  },
  {
   "attachments": {},
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## 5 Minute break"
   ]
  },
  {
   "attachments": {},
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Reading and writing files\n",
    "\n",
    "Working with comma-separated and similar data files will be covered in a later workshop. It's worthwhile, however, to see how to read and write data or text to and from a file. We'll start with writing some text to a file, then explore how to read it."
   ]
  },
  {
   "attachments": {},
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Write to a file\n",
    "\n",
    "Write the text in `sample_text` to a file named `cat_text`"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 16,
   "metadata": {},
   "outputs": [],
   "source": [
    "# Sample text to write to a file\n",
    "sample_text = \"\"\"Cats and kittens everywhere,\n",
    "Hundreds of cats,\n",
    "Thousands of cats,\n",
    "Millions and billions and trillions of cats.\"\"\"\n",
    "\n",
    "# Write the sample text to a file named \"cat_text\" (test different open modes)\n",
    "with open('cat_text.txt', 'w') as f:\n",
    "    f.write(sample_text)\n",
    "    \n",
    "# You might sometimes see an older pattern:\n",
    "# f = open('lorem.txt', 'w')\n",
    "# f.write(sample_text)\n",
    "# f.close()"
   ]
  },
  {
   "attachments": {},
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "You can check the \"Files\" tab in the column at left now to find the output file. If you don't see it click the \"refresh\" button."
   ]
  },
  {
   "attachments": {},
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Read from a file"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 40,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "Cats and kittens everywhere,\n",
      "Hundreds of cats,\n",
      "Thousands of cats,\n",
      "Millions and billions and trillions of cats.\n"
     ]
    }
   ],
   "source": [
    "# Read the newly created file.\n",
    "with open('cat_text.txt', 'r') as f:\n",
    "    print(f.read())"
   ]
  },
  {
   "attachments": {},
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "You can also read a file line by line."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 18,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "Cats and kittens everywhere,END\n",
      "Hundreds of cats,END\n",
      "Thousands of cats,END\n",
      "Millions and billions and trillions of cats.\n"
     ]
    }
   ],
   "source": [
    "# Read the file line by line\n",
    "with open('cat_text.txt', 'r') as f:\n",
    "    for line in f:\n",
    "        line = line.replace('\\n', 'END')\n",
    "        print(line)"
   ]
  },
  {
   "attachments": {},
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "**Try it yourself:** Write the text below to a file named `text.txt` and then read the file line by line"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 2,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "Line 1\n",
      "Line 2\n",
      "Line 3\n",
      "Line 4\n",
      "Line 5\n"
     ]
    }
   ],
   "source": [
    "# Text to write to a file\n",
    "text = \"Line 1\\nLine 2\\nLine 3\\nLine 4\\nLine 5\"\n",
    "\n",
    "# Write the text to a file named \"text.txt\"\n",
    "with open(\"text.txt\", \"w\") as f:\n",
    "    f.write(text)\n",
    "\n",
    "# Read the new file just created line by line\n",
    "with open(\"text.txt\", \"r\") as f:\n",
    "    for line in f:\n",
    "        print(line.strip('\\n'))"
   ]
  },
  {
   "attachments": {},
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "#### Parsing data read from a file\n",
    "\n",
    "External data we read into our application is often not formatted for our desired manipulations or analyses. We often have to parse the data from a file into a structure that is appropriate for manipulation or analysis.\n",
    "\n",
    "For example, if we want to analyze the text contained in each line from the `cat_text.txt` file we need to isolate each line and word from the text and create a dataset of individual words by line."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 20,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "[['Cats', 'and', 'kittens', 'everywhere,'],\n",
       " ['Hundreds', 'of', 'cats,'],\n",
       " ['Thousands', 'of', 'cats,'],\n",
       " ['Millions', 'and', 'billions', 'and', 'trillions', 'of', 'cats.']]"
      ]
     },
     "execution_count": 20,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "# Create an empty list to store the data we will parse\n",
    "data = []\n",
    "\n",
    "# Read in the cat_text file line by line\n",
    "with open('cat_text.txt', 'r') as f:\n",
    "    for line in f:\n",
    "        line = line.strip('\\n')\n",
    "        words = line.split(' ')\n",
    "        data.append(words)\n",
    "\n",
    "# Print out the resulting list\n",
    "data"
   ]
  },
  {
   "attachments": {},
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Final Activity, Part 1: Parse a text file containing data seperated by semicolons\n",
    "\n",
    "We have membership information for 25 members of the *International Cats of Mystery* service stored in the file `international_cats_of_mystery.txt`. The file is formatted as follows:\n",
    "\n",
    "1. Each line is seperated by a newline character (\\n)\n",
    "\n",
    "1. The first line in the file contains the data variable names (e.g., Name, Joined, Address 1,...)\n",
    "\n",
    "1. Each subsequent line contains the data variable values for one member (e.g., Bill, 2015, 12309 Scratch Tree Lane,...)\n",
    "\n",
    "1. Each variable name or value is seperated by semicolons (;)\n",
    "\n",
    "Use a file parsing method to parse the `international_cats_of_mystery.txt` file to create a list that contains lists of values from each line in the file. The first two items in this list should be:\n",
    "\n",
    "```python\n",
    "[\n",
    "  ['Name', 'Joined', 'Address 1', 'Address 2', 'City', 'State', 'Zip Code', 'Subscriptions'],\n",
    "  ['Bill', '2015', '12309 Scratch Tree Lane', 'Apt. 1', 'Beverly Hills', 'CA', '90210', 'Little Known Hiss-tories podcast'],\n",
    "  ...\n",
    "]\n",
    "```"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 1,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current\n",
      "                                 Dload  Upload   Total   Spent    Left  Speed\n",
      "100  2667  100  2667    0     0   8386      0 --:--:-- --:--:-- --:--:--  8386\n"
     ]
    }
   ],
   "source": [
    "# Fetch the text file for the activity\n",
    "!curl https://raw.githubusercontent.com/ncsu-libraries-data-vis/introduction-to-programming-with-python/main/International_cats_of_mystery_US_chapter.txt -o international_cats_of_mystery.txt"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 2,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "[['Name',\n",
       "  'Joined',\n",
       "  'Address 1',\n",
       "  'Address 2',\n",
       "  'City',\n",
       "  'State',\n",
       "  'Zip Code',\n",
       "  'Subscriptions'],\n",
       " ['Bill',\n",
       "  '2015',\n",
       "  '12309 Scratch Tree Lane',\n",
       "  'Apt. 1',\n",
       "  'Beverly Hills',\n",
       "  'CA',\n",
       "  '90210',\n",
       "  'Little Known Hiss-tories podcast'],\n",
       " ['Pete',\n",
       "  '2018',\n",
       "  '501 Grumpy Street',\n",
       "  '',\n",
       "  'Long Beach',\n",
       "  'California',\n",
       "  '90803',\n",
       "  'Leisure Cats magazine, Little Known Hiss-tories podcast']]"
      ]
     },
     "execution_count": 2,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "# Parse the data in the \"international_cats_of_mystery.txt\" file\n",
    "member_data = []\n",
    "\n",
    "# Read the \"international_cats_of_mystery.txt\" file line by line \n",
    "# and parse the data based on the semicolon seperator\n",
    "with open('international_cats_of_mystery.txt') as f:\n",
    "    for line in f:\n",
    "        line = line.strip('\\n')\n",
    "        member_data.append(line.split(';'))\n",
    "\n",
    "# Print out the list to examine the results\n",
    "member_data[:3]"
   ]
  },
  {
   "attachments": {},
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Final Activity, Part 2: Use a function and a for loop to print a message for each member from the parsed text file\n",
    "\n",
    "Use a loop and a function to create a personalized message for each member of the *International Cats of Mystery* service from the text file parsed in the previous cell. The personalized message should use this template:\n",
    "\n",
    "> *Hello **[member name]**, Thank you for being a valued member for the last **[member's years of membership]** years. We have an exclusive discount on our **[member's top subscription with the service]**.*"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 5,
   "metadata": {},
   "outputs": [],
   "source": [
    "# Create a function that takes in a member's information in the form of the\n",
    "# parsed data from the \"international_cats_of_mystery.txt\" file and returns a\n",
    "# personalized message\n",
    "def personalized_message(member_info):\n",
    "    name = member_info[0]\n",
    "    member_years = 2021 - int(member_info[1])\n",
    "    top_subscription = member_info[7].split(\",\")[0]\n",
    "    return (\"Hello \" + name\n",
    "    + \", Thank you for being a valued member for the last \" + str(member_years)\n",
    "    + \" years. We have an exclusive discount on our \" + top_subscription)"
   ]
  },
  {
   "attachments": {},
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "**Tip**: Remember that the first item in our membership list contains a list of the data variable names. We do not want to apply the personalized message function to this list of values. When you loop through the member data list you will want to skip over the first item (remember [list slicing](https://www.programiz.com/python-programming/examples/list-slicing))."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 9,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "Hello Bill, Thank you for being a valued member for the last 6 years. We have an exclusive discount on our Little Known Hiss-tories podcast\n",
      "Hello Pete, Thank you for being a valued member for the last 3 years. We have an exclusive discount on our Leisure Cats magazine\n",
      "Hello Bob, Thank you for being a valued member for the last 2 years. We have an exclusive discount on our email newsletter\n",
      "Hello Carla, Thank you for being a valued member for the last 15 years. We have an exclusive discount on our email newsletter\n",
      "Hello Jose, Thank you for being a valued member for the last 1 years. We have an exclusive discount on our Cat Nips subscription box\n",
      "Hello Ali, Thank you for being a valued member for the last 14 years. We have an exclusive discount on our email newsletter\n",
      "Hello Marcus, Thank you for being a valued member for the last 2 years. We have an exclusive discount on our Leisure Cats Magazine\n",
      "Hello Tanvi, Thank you for being a valued member for the last 4 years. We have an exclusive discount on our Little Known Hiss-tories podcast\n",
      "Hello Lian, Thank you for being a valued member for the last 13 years. We have an exclusive discount on our email newsletter\n",
      "Hello Arturo, Thank you for being a valued member for the last 7 years. We have an exclusive discount on our Leisure Cats magazine\n",
      "Hello Silvia, Thank you for being a valued member for the last 12 years. We have an exclusive discount on our Little Known Hiss-tories podcast\n",
      "Hello Celine, Thank you for being a valued member for the last 14 years. We have an exclusive discount on our Cat Nips subscription box\n",
      "Hello Omar, Thank you for being a valued member for the last 13 years. We have an exclusive discount on our Little Known Hiss-tories podcast\n",
      "Hello Niko, Thank you for being a valued member for the last 5 years. We have an exclusive discount on our Leisure Cats magazine\n",
      "Hello Remi, Thank you for being a valued member for the last 1 years. We have an exclusive discount on our Little Known Hiss-tories podcast\n",
      "Hello Klaus, Thank you for being a valued member for the last 8 years. We have an exclusive discount on our email newsletter\n",
      "Hello Estaban, Thank you for being a valued member for the last 13 years. We have an exclusive discount on our Leisure Cats magazine\n",
      "Hello Dallas, Thank you for being a valued member for the last 2 years. We have an exclusive discount on our Cat Nips subscription box\n",
      "Hello Darci, Thank you for being a valued member for the last 14 years. We have an exclusive discount on our Leisure Cats magazine\n",
      "Hello Koko, Thank you for being a valued member for the last 5 years. We have an exclusive discount on our email newsletter\n",
      "Hello Mango, Thank you for being a valued member for the last 12 years. We have an exclusive discount on our Cat Nips subscription box \n",
      "Hello Freya, Thank you for being a valued member for the last 1 years. We have an exclusive discount on our Leisure Cats magazine\n",
      "Hello Big Guy, Thank you for being a valued member for the last 3 years. We have an exclusive discount on our Little Known Hiss-tories podcast\n",
      "Hello Fluffy, Thank you for being a valued member for the last 8 years. We have an exclusive discount on our Little Known Hiss-tories podcast\n",
      "Hello Squeaky, Thank you for being a valued member for the last 14 years. We have an exclusive discount on our Leisure Cats magazine\n"
     ]
    }
   ],
   "source": [
    "# Loop through the parsed data from the \"international_cats_of_mystery.txt\" file\n",
    "# and print a personalized message for each member\n",
    "for member in member_data[1:]:\n",
    "    print(personalized_message(member))"
   ]
  },
  {
   "attachments": {},
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Further resources and topics\n",
    "\n",
    "#### Unfilled version of this notebook\n",
    "\n",
    "[Introduction to Programming with Python - Part 3 unfilled notebook](https://colab.research.google.com/github/ncsu-libraries-data-vis/introduction-to-programming-with-python/blob/main/Introduction_to_Programming_with_Python_3.ipynb) - a version of this notebook without code filled in for the guided activities and exercises. Use the unfilled version to learn these materials or lead a workshop session.\n",
    "\n",
    "### Resources\n",
    "\n",
    "- [A Byte of Python](https://python.swaroopch.com/) is a great intro book and reference for Python\n",
    "- [Official Python documentation and tutorials](https://docs.python.org/3/)\n",
    "- [Real Python](https://realpython.com/) contains a lot of different tutorials at different levels\n",
    "- [LinkedIn Learning](https://www.lynda.com/Python-training-tutorials/415-0.html) is free with NC State accounts and contains several video series for learning Python\n",
    "- [Dataquest](https://www.dataquest.io/) is a free then paid series of courses with an emphasis on data science\n",
    "\n",
    "### Topics\n",
    "\n",
    "- Other data structures: sets, tuples\n",
    "- Libraries, packages, and pip\n",
    "- Virtual environments\n",
    "- Text editors and local execution environments\n",
    "- The object-oriented paradigm in Python: classes, methods\n",
    "\n",
    "### Installing Python \n",
    "\n",
    "There are quite a few ways to install Python on your own computer, including the [official Python downloads](https://www.python.org/downloads/) and the very popular data-science focused [Anaconda Python distribution](https://www.anaconda.com/products/individual). Depending on your operating system, how you want to write code, and what type of projects you might work on, there are other approaches as well, such as using [pyenv](https://github.com/pyenv/pyenv) and [poetry](https://python-poetry.org/). If you're not sure which approach to take, feel free to get in touch and we'll talk through options and help you get set up. \n",
    "\n",
    "### Popular editors for Python\n",
    "\n",
    "Today we've been writing and running code in Google Colab, which is one particular version of Jupyter Notebooks. Depending on your projects and what you're working on, you may want to write your code in a text editor. While there are many options, if you're just getting started we recommend [Visual Studio Code](https://code.visualstudio.com/) for any operating system but are happy to talk through other editors.\n"
   ]
  },
  {
   "attachments": {},
   "cell_type": "markdown",
   "metadata": {
    "id": "YjyTIZsdGI0D"
   },
   "source": [
    "## Evaluation survey\n",
    "Please, spend 1 minute answering these questions that can help us a lot on future workshops. \n",
    "\n",
    "[go.ncsu.edu/dvs-eval](https://go.ncsu.edu/dvs-eval)"
   ]
  },
  {
   "attachments": {},
   "cell_type": "markdown",
   "metadata": {
    "id": "y1yQcuLJGI0F"
   },
   "source": [
    "## Credits\n",
    "\n",
    "These materials were developed by Claire Cahoon and Walt Gurley from the NC State University Libraries. Materials are based on workshops by Scott Bailey, Ashley Evans Bandy, Natalia Lopez, Vincent Tompkins, Javier de la Rosa, Peter Broadwell, and Simon Wiles."
   ]
  },
  {
   "attachments": {},
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Additional Practice Activity:\n",
    "\n",
    "### Generate a dictionary and personalized messages using data from a file\n",
    "\n",
    "This activity incorporates concepts we have covered in all *Introduction to Programming with Python* workshops. Use the skills you have developed through your work on these materials as well as references to additional resources we provide to complete this extended activity.\n",
    "\n",
    "For this activity we have membership information for 25 members of the *International Cats of Mystery* service stored in the file `international_cats_of_mystery.txt`. The file is formatted as follows:\n",
    "\n",
    "1. Each line is seperated by a newline character (`\\n`)\n",
    "\n",
    "1. The first line in the file contains the data variable names (e.g., Name, Joined, Address 1,...)\n",
    "\n",
    "1. Each subsequent line contains the data variable values for one member (e.g., Bill, 2015, 12309 Scratch Tree Lane,...)\n",
    "\n",
    "1. Each variable name or value is seperated by semicolons (`;`)\n",
    "\n",
    "Our job is to read in the `international_cats_of_mystery.txt` file, parse the data, and format the data to create a list of dictionaries containing membership information that match the format:\n",
    "\n",
    "```python\n",
    "{'address 1': '12309 Scratch Tree Lane',\n",
    "  'address 2': 'Apt. 1',\n",
    "  'city': 'Beverly Hills',\n",
    "  'joined': 2015,\n",
    "  'name': 'Bill',\n",
    "  'state': 'CA',\n",
    "  'subscriptions': ['Little Known Hiss-tories podcast'],\n",
    "  'zip code': '90210'}\n",
    "```\n",
    "\n",
    "Once we have the data prepared we will generate the following personalized message for each member:\n",
    "\n",
    "> *Hello **[member name]**, Thank you for being a valued member of International Cats of Mystery for the last **[member's years of membership]** years. We have an exclusive discount on our **[member's top subscription with the service]**.*"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 25,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current\n",
      "                                 Dload  Upload   Total   Spent    Left  Speed\n",
      "100  2667  100  2667    0     0  11646      0 --:--:-- --:--:-- --:--:-- 11646\n"
     ]
    }
   ],
   "source": [
    "# Fetch the text file for the final activity\n",
    "!curl https://raw.githubusercontent.com/NCSU-Libraries/data-viz-workshops/master/Introduction_to_Programming_with_Python/International_cats_of_mystery_US_chapter.txt -o international_cats_of_mystery.txt"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 26,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "Name;Joined;Address 1;Address 2;City;State;Zip Code;Subscriptions\n",
      "Bill;2015;12309 Scratch Tree Lane;Apt. 1;Beverly Hills;CA;90210;Little Known Hiss-tories podcast\n",
      "Pete;2018;501 Grumpy Street;;Long Beach;California;90803;Leisure Cats magazine, Little Known Hiss-tories podcast\n",
      "Bob;2019;62 Ocean Catch Way;;Astoria;OR;97103;email newsletter\n",
      "Carla;2006;2120 Curious Court;unit B;Raleigh;North Carolina;27610;email newsletter, Cat Nips subscription box\n",
      "Jose;2020;10036 Sunny Spot Avenue;;Greensboro;NC;27502;Cat Nips subscription box, Little Known Hiss-tories podcast, Leisure Cats magazine\n",
      "Ali;2007;143 Right Meow Place;Apt. 2;Portland;ME;3901;email newsletter, Little Known Hiss-tories podcast\n",
      "Marcus;2019;21 Bird Watch Circle;;Austin;Texas;73301;Leisure Cats Magazine, Little Known Hiss-tories podcast\n",
      "Tanvi;2017;4532 Tiny Mouse Street;Unit D;Dallas;TX;73303;Little Known Hiss-tories podcast, Cat Nips subscription box\n",
      "Lian;2008;3132 Goldfish Lane;;Ithaca;NY;14850;email newsletter\n",
      "Arturo;2014;5120 Kibbler Blvd.;;New York;New York;10001;Leisure Cats magazine, email newsletter\n",
      "Silvia;2009;17001 Kling Street;;North Hollywood;CA;90812;Little Known Hiss-tories podcast,  Leisure Cats Magazine, email newsletter\n",
      "Celine;2007;2124 Bermuda Street;Apt. 3;San Francsico;California;94123;Cat Nips subscription box, Little Known Hiss-tories podcast, Leisure Cats magazine\n",
      "Omar;2008;9 Catnado Way;258;Bellevue;WA;98004;Little Known Hiss-tories podcast\n",
      "Niko;2016;4246 Scruffy Way;Apt. 19;Lincoln City;IN;47552;Leisure Cats magazine, Little Known Hiss-tories podcast, Cat Nips subscription box\n",
      "Remi;2020;3207 W. 2nd Street;;Las Vegas;NV;89128;Little Known Hiss-tories podcast\n",
      "Klaus;2013;5939 Friendly Ave.;Unit A;Miami;FL;33125;email newsletter\n",
      "Estaban;2008;72 Laser Lane;;Phoenix;AZ;85032;Leisure Cats magazine, email newsletter\n",
      "Dallas;2019;5525 E. Atlantic Katz Highway;;Saint Louis;MO;63116;Cat Nips subscription box, Little Known Hiss-tories podcast, Leisure Cats magazine\n",
      "Darci;2007;3836 Sleepy Place;231;Minneapolis;MN;55407;Leisure Cats magazine\n",
      "Koko;2016;5844 Perchcrest Court;;Germantown;TN;38138;email newsletter, Cat Nips subscription box\n",
      "Mango;2009;202 Cuddle Ave.;;Green River;UT;84525;Cat Nips subscription box \n",
      "Freya;2020;3532 Lazyport Circle.;;Buffalo;NY;14215;Leisure Cats magazine, email newsletter\n",
      "Big Guy;2018;3932 Parrot Cove Blvd;;Ely;NV;89301;Little Known Hiss-tories podcast\n",
      "Fluffy;2013;504 Catfish Swamp Road;;Villanova;PA;19085;Little Known Hiss-tories podcast, Cat Nips subscription box\n",
      "Squeaky;2007;21 Kitten Mews Drive;Apt. 21;Chicago;IL;60629;Leisure Cats magazine, Little Known Hiss-tories podcast, Cat Nips subscription box\n"
     ]
    }
   ],
   "source": [
    "# Read whole text file to preview contents\n",
    "with open('international_cats_of_mystery.txt', 'r') as f:\n",
    "    print(f.read())"
   ]
  },
  {
   "attachments": {},
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Read and parse data line by line and store in a list\n",
    "\n",
    "Read the membership information data file line by line, parse the string (remove the newline character and split based on semicolon), and store each line as a list in the empty list `data_from_file`.\n",
    "\n",
    "Tip: Remember the list method `append()` to append new items to a list"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 27,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "[['Name',\n",
       "  'Joined',\n",
       "  'Address 1',\n",
       "  'Address 2',\n",
       "  'City',\n",
       "  'State',\n",
       "  'Zip Code',\n",
       "  'Subscriptions'],\n",
       " ['Bill',\n",
       "  '2015',\n",
       "  '12309 Scratch Tree Lane',\n",
       "  'Apt. 1',\n",
       "  'Beverly Hills',\n",
       "  'CA',\n",
       "  '90210',\n",
       "  'Little Known Hiss-tories podcast'],\n",
       " ['Pete',\n",
       "  '2018',\n",
       "  '501 Grumpy Street',\n",
       "  '',\n",
       "  'Long Beach',\n",
       "  'California',\n",
       "  '90803',\n",
       "  'Leisure Cats magazine, Little Known Hiss-tories podcast']]"
      ]
     },
     "execution_count": 27,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "# Empty list to store data\n",
    "data_from_file = []\n",
    "\n",
    "# Read in text file line by line and parse the data\n",
    "with open('international_cats_of_mystery.txt') as f:\n",
    "    for line in f:\n",
    "        line = line.rstrip('\\n')\n",
    "        data_from_file.append(line.split(';'))\n",
    "\n",
    "# Print data_from_file\n",
    "data_from_file[:3]"
   ]
  },
  {
   "attachments": {},
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Create member info dictionaries\n",
    "\n",
    "We now have a list containing one list per line from the file that we read (stored in `data_from_file`). We need to loop through the `data_from_file` list and use the variable names and values to create dictionaries containing each member's information.\n",
    "\n",
    "To do this we will loop over the lists containing data in `data_from_file` (`data_from_file[1:]`, remember the first list item contains the variable names), create an empty dictionary, and then use another loop to loop over a range of values the length of items in `data_from_file[0]` to create a dictionary for each member consisting of variable names (`data_from_file[0][i]`) and values (`data[i]`) as key, value pairs.\n",
    "\n",
    "```python\n",
    "member_info = []\n",
    "\n",
    "for data in data_from_file[1:]:\n",
    "    data_dict = {}\n",
    "    for i in range(len(data_from_file[0])):\n",
    "        data_dict[data_from_file[0][i]] = data[i]\n",
    "    member_info.append(data_dict)\n",
    "```"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 28,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "[{'Name': 'Bill',\n",
       "  'Joined': '2015',\n",
       "  'Address 1': '12309 Scratch Tree Lane',\n",
       "  'Address 2': 'Apt. 1',\n",
       "  'City': 'Beverly Hills',\n",
       "  'State': 'CA',\n",
       "  'Zip Code': '90210',\n",
       "  'Subscriptions': 'Little Known Hiss-tories podcast'},\n",
       " {'Name': 'Pete',\n",
       "  'Joined': '2018',\n",
       "  'Address 1': '501 Grumpy Street',\n",
       "  'Address 2': '',\n",
       "  'City': 'Long Beach',\n",
       "  'State': 'California',\n",
       "  'Zip Code': '90803',\n",
       "  'Subscriptions': 'Leisure Cats magazine, Little Known Hiss-tories podcast'},\n",
       " {'Name': 'Bob',\n",
       "  'Joined': '2019',\n",
       "  'Address 1': '62 Ocean Catch Way',\n",
       "  'Address 2': '',\n",
       "  'City': 'Astoria',\n",
       "  'State': 'OR',\n",
       "  'Zip Code': '97103',\n",
       "  'Subscriptions': 'email newsletter'}]"
      ]
     },
     "execution_count": 28,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "# Empty list to store dictionaries\n",
    "member_info = []\n",
    "\n",
    "# Loop over each data list from the parsed data\n",
    "for data in data_from_file[1:]:\n",
    "    data_dict = {}\n",
    "    for i in range(len(data_from_file[0])):\n",
    "        data_dict[data_from_file[0][i]] = data[i]\n",
    "    member_info.append(data_dict)\n",
    "\n",
    "# Print member_info\n",
    "member_info[:3]"
   ]
  },
  {
   "attachments": {},
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "The following cell uses list comprehension to perform the same operations as the previous cell. This is included to show a comparison of two methods for generating the same resultes. The list comprehension uses a `zip` function to create an iterable of paired tuples of variable names (from `data_from_file[0]`) and variable values from each member data row in `data_from_file` (i.e., `data_from_file[1:]`). The `dict()` function is then used to construct a dictionary from the output of `zip()`."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 29,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "[{'Name': 'Bill',\n",
       "  'Joined': '2015',\n",
       "  'Address 1': '12309 Scratch Tree Lane',\n",
       "  'Address 2': 'Apt. 1',\n",
       "  'City': 'Beverly Hills',\n",
       "  'State': 'CA',\n",
       "  'Zip Code': '90210',\n",
       "  'Subscriptions': 'Little Known Hiss-tories podcast'},\n",
       " {'Name': 'Pete',\n",
       "  'Joined': '2018',\n",
       "  'Address 1': '501 Grumpy Street',\n",
       "  'Address 2': '',\n",
       "  'City': 'Long Beach',\n",
       "  'State': 'California',\n",
       "  'Zip Code': '90803',\n",
       "  'Subscriptions': 'Leisure Cats magazine, Little Known Hiss-tories podcast'},\n",
       " {'Name': 'Bob',\n",
       "  'Joined': '2019',\n",
       "  'Address 1': '62 Ocean Catch Way',\n",
       "  'Address 2': '',\n",
       "  'City': 'Astoria',\n",
       "  'State': 'OR',\n",
       "  'Zip Code': '97103',\n",
       "  'Subscriptions': 'email newsletter'}]"
      ]
     },
     "execution_count": 29,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "# For list items starting at index 1 in data_lists create a dictionary of\n",
    "# variable names (data_lists[0]) and values as key, value pairs\n",
    "member_info = [dict(zip(data_from_file[0], values)) for values in data_from_file[1:]]\n",
    "\n",
    "member_info[:3]"
   ]
  },
  {
   "attachments": {},
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Convert the `Joined` key value from a string to an integer\n",
    "\n",
    "When we read in our file, all of the data was parsed as a string. We must convert any data that should be in another data type accordingly."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 30,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "[{'Name': 'Bill',\n",
       "  'Joined': 2015,\n",
       "  'Address 1': '12309 Scratch Tree Lane',\n",
       "  'Address 2': 'Apt. 1',\n",
       "  'City': 'Beverly Hills',\n",
       "  'State': 'CA',\n",
       "  'Zip Code': '90210',\n",
       "  'Subscriptions': 'Little Known Hiss-tories podcast'},\n",
       " {'Name': 'Pete',\n",
       "  'Joined': 2018,\n",
       "  'Address 1': '501 Grumpy Street',\n",
       "  'Address 2': '',\n",
       "  'City': 'Long Beach',\n",
       "  'State': 'California',\n",
       "  'Zip Code': '90803',\n",
       "  'Subscriptions': 'Leisure Cats magazine, Little Known Hiss-tories podcast'},\n",
       " {'Name': 'Bob',\n",
       "  'Joined': 2019,\n",
       "  'Address 1': '62 Ocean Catch Way',\n",
       "  'Address 2': '',\n",
       "  'City': 'Astoria',\n",
       "  'State': 'OR',\n",
       "  'Zip Code': '97103',\n",
       "  'Subscriptions': 'email newsletter'}]"
      ]
     },
     "execution_count": 30,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "# Test that value stored in 'Joined' is a string\n",
    "# for member in member_info:\n",
    "#     print(type(member['Joined']))\n",
    "\n",
    "# Convert the 'Joined' value to an integer for each member\n",
    "for member in member_info:\n",
    "    member['Joined'] = int(member['Joined'])\n",
    "\n",
    "member_info[:3]"
   ]
  },
  {
   "attachments": {},
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Fix state names using a defined function\n",
    "\n",
    "Some of the state names in our member info list are not formatted correctly as two letter abbreviations. We will create a function to fix the incorrectly formatted state names."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 31,
   "metadata": {},
   "outputs": [],
   "source": [
    "# State abbreviations lookup\n",
    "state_abbreviations = {\n",
    "    'California': 'CA',\n",
    "    'New York': 'NY',\n",
    "    'North Carolina': 'NC',\n",
    "    'Texas': 'TX'\n",
    "}\n",
    "\n",
    "# Fix state names function\n",
    "def fix_state_name(member_state):\n",
    "    if len(member_state) > 2:\n",
    "        return state_abbreviations[member_state]\n",
    "    return member_state"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 32,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "[{'Name': 'Bill',\n",
       "  'Joined': 2015,\n",
       "  'Address 1': '12309 Scratch Tree Lane',\n",
       "  'Address 2': 'Apt. 1',\n",
       "  'City': 'Beverly Hills',\n",
       "  'State': 'CA',\n",
       "  'Zip Code': '90210',\n",
       "  'Subscriptions': 'Little Known Hiss-tories podcast'},\n",
       " {'Name': 'Pete',\n",
       "  'Joined': 2018,\n",
       "  'Address 1': '501 Grumpy Street',\n",
       "  'Address 2': '',\n",
       "  'City': 'Long Beach',\n",
       "  'State': 'CA',\n",
       "  'Zip Code': '90803',\n",
       "  'Subscriptions': 'Leisure Cats magazine, Little Known Hiss-tories podcast'},\n",
       " {'Name': 'Bob',\n",
       "  'Joined': 2019,\n",
       "  'Address 1': '62 Ocean Catch Way',\n",
       "  'Address 2': '',\n",
       "  'City': 'Astoria',\n",
       "  'State': 'OR',\n",
       "  'Zip Code': '97103',\n",
       "  'Subscriptions': 'email newsletter'}]"
      ]
     },
     "execution_count": 32,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "# Run the fix_state_format for each member in member_info\n",
    "for member in member_info:\n",
    "    member['State'] = fix_state_name(member['State'])\n",
    "\n",
    "member_info[:3]"
   ]
  },
  {
   "attachments": {},
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Convert `Subscriptions` string to a list\n",
    "\n",
    "Finally, as our file was parsed as a string, the values contained in the `Subscriptions` key are not formatted as a list. We must convert the current string form to a list using the string function `split()`."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 33,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "[{'Name': 'Bill',\n",
       "  'Joined': 2015,\n",
       "  'Address 1': '12309 Scratch Tree Lane',\n",
       "  'Address 2': 'Apt. 1',\n",
       "  'City': 'Beverly Hills',\n",
       "  'State': 'CA',\n",
       "  'Zip Code': '90210',\n",
       "  'Subscriptions': ['Little Known Hiss-tories podcast']},\n",
       " {'Name': 'Pete',\n",
       "  'Joined': 2018,\n",
       "  'Address 1': '501 Grumpy Street',\n",
       "  'Address 2': '',\n",
       "  'City': 'Long Beach',\n",
       "  'State': 'CA',\n",
       "  'Zip Code': '90803',\n",
       "  'Subscriptions': ['Leisure Cats magazine',\n",
       "   ' Little Known Hiss-tories podcast']},\n",
       " {'Name': 'Bob',\n",
       "  'Joined': 2019,\n",
       "  'Address 1': '62 Ocean Catch Way',\n",
       "  'Address 2': '',\n",
       "  'City': 'Astoria',\n",
       "  'State': 'OR',\n",
       "  'Zip Code': '97103',\n",
       "  'Subscriptions': ['email newsletter']}]"
      ]
     },
     "execution_count": 33,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "# Convert the Subscriptions key value for each member to a list\n",
    "for member in member_info:\n",
    "    member['Subscriptions'] = member['Subscriptions'].split(',')\n",
    "\n",
    "member_info[:3]"
   ]
  },
  {
   "attachments": {},
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Use a `for` loop to generate a pesonalized message for each member\n",
    "\n",
    "Use the code cells below to write two functions that produce a personalized email with the provided membership information and then loop through the `member_info` list to produce this message for all members.\n",
    "\n",
    "Tips:\n",
    "\n",
    "- Define a function that calculates how many years someone has been a member - Define a second function that:\n",
    "  1. gets the member name,\n",
    "  1. calls the previous function to calculate their years of membership,\n",
    "  1. gets their most popular subscription,\n",
    "  1. and formats this information into a personalized message.\n",
    "\n",
    "- The year a member joined is an integer. Remember, you can only concatenate strings (recall the `str()` method)\n",
    "\n",
    "- Subscriptions are a list. Each member's subscriptions are listed from most popular to least popular."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 34,
   "metadata": {},
   "outputs": [],
   "source": [
    "# Define a function that calculates membership years\n",
    "def calculate_member_years(year_joined):\n",
    "  return 2021 - year_joined"
   ]
  },
  {
   "attachments": {},
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "For reference, here is the message format again:\n",
    "> *Hello **[member name]**, Thank you for being a valued member of International Cats of Mystery for the last **[member's years of membership]** years. We have an exclusive discount on our **[member's top subscription with the service]**.*"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 35,
   "metadata": {},
   "outputs": [],
   "source": [
    "# Define a function that creates the personalized message\n",
    "def create_message(member):\n",
    "  membership_years = calculate_member_years(member[\"Joined\"])\n",
    "  return (\"Hello \"\n",
    "    + member[\"Name\"]\n",
    "    + \", Thank you for being a valued member of International Cats of Mystery for the last \"\n",
    "    + str(membership_years)\n",
    "    + \" years. We have an exclusive discount on our \"\n",
    "    + member[\"Subscriptions\"][0])"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 36,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "Hello Bill, Thank you for being a valued member of International Cats of Mystery for the last 6 years. We have an exclusive discount on our Little Known Hiss-tories podcast\n",
      "Hello Pete, Thank you for being a valued member of International Cats of Mystery for the last 3 years. We have an exclusive discount on our Leisure Cats magazine\n",
      "Hello Bob, Thank you for being a valued member of International Cats of Mystery for the last 2 years. We have an exclusive discount on our email newsletter\n",
      "Hello Carla, Thank you for being a valued member of International Cats of Mystery for the last 15 years. We have an exclusive discount on our email newsletter\n",
      "Hello Jose, Thank you for being a valued member of International Cats of Mystery for the last 1 years. We have an exclusive discount on our Cat Nips subscription box\n",
      "Hello Ali, Thank you for being a valued member of International Cats of Mystery for the last 14 years. We have an exclusive discount on our email newsletter\n",
      "Hello Marcus, Thank you for being a valued member of International Cats of Mystery for the last 2 years. We have an exclusive discount on our Leisure Cats Magazine\n",
      "Hello Tanvi, Thank you for being a valued member of International Cats of Mystery for the last 4 years. We have an exclusive discount on our Little Known Hiss-tories podcast\n",
      "Hello Lian, Thank you for being a valued member of International Cats of Mystery for the last 13 years. We have an exclusive discount on our email newsletter\n",
      "Hello Arturo, Thank you for being a valued member of International Cats of Mystery for the last 7 years. We have an exclusive discount on our Leisure Cats magazine\n",
      "Hello Silvia, Thank you for being a valued member of International Cats of Mystery for the last 12 years. We have an exclusive discount on our Little Known Hiss-tories podcast\n",
      "Hello Celine, Thank you for being a valued member of International Cats of Mystery for the last 14 years. We have an exclusive discount on our Cat Nips subscription box\n",
      "Hello Omar, Thank you for being a valued member of International Cats of Mystery for the last 13 years. We have an exclusive discount on our Little Known Hiss-tories podcast\n",
      "Hello Niko, Thank you for being a valued member of International Cats of Mystery for the last 5 years. We have an exclusive discount on our Leisure Cats magazine\n",
      "Hello Remi, Thank you for being a valued member of International Cats of Mystery for the last 1 years. We have an exclusive discount on our Little Known Hiss-tories podcast\n",
      "Hello Klaus, Thank you for being a valued member of International Cats of Mystery for the last 8 years. We have an exclusive discount on our email newsletter\n",
      "Hello Estaban, Thank you for being a valued member of International Cats of Mystery for the last 13 years. We have an exclusive discount on our Leisure Cats magazine\n",
      "Hello Dallas, Thank you for being a valued member of International Cats of Mystery for the last 2 years. We have an exclusive discount on our Cat Nips subscription box\n",
      "Hello Darci, Thank you for being a valued member of International Cats of Mystery for the last 14 years. We have an exclusive discount on our Leisure Cats magazine\n",
      "Hello Koko, Thank you for being a valued member of International Cats of Mystery for the last 5 years. We have an exclusive discount on our email newsletter\n",
      "Hello Mango, Thank you for being a valued member of International Cats of Mystery for the last 12 years. We have an exclusive discount on our Cat Nips subscription box \n",
      "Hello Freya, Thank you for being a valued member of International Cats of Mystery for the last 1 years. We have an exclusive discount on our Leisure Cats magazine\n",
      "Hello Big Guy, Thank you for being a valued member of International Cats of Mystery for the last 3 years. We have an exclusive discount on our Little Known Hiss-tories podcast\n",
      "Hello Fluffy, Thank you for being a valued member of International Cats of Mystery for the last 8 years. We have an exclusive discount on our Little Known Hiss-tories podcast\n",
      "Hello Squeaky, Thank you for being a valued member of International Cats of Mystery for the last 14 years. We have an exclusive discount on our Leisure Cats magazine\n"
     ]
    }
   ],
   "source": [
    "# Loop through the \"member_info\" list to produce the personalized message for\n",
    "# each member\n",
    "for member in member_info:\n",
    "    print(create_message(member))"
   ]
  }
 ],
 "metadata": {
  "interpreter": {
   "hash": "081725b835c3560cac4c924133f475729fd0fa7e8944945b1a2770f6416bbf0b"
  },
  "kernelspec": {
   "display_name": "Python 3.8.10 64-bit ('static-typing': conda)",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.8.10"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 4
}