PY0101EN-3-4-Classes.ipynb

{"cells":[{"cell_type":"markdown","metadata":{},"source":["<center>\n","    <img src=\"https://cf-courses-data.s3.us.cloud-object-storage.appdomain.cloud/IBMDeveloperSkillsNetwork-PY0101EN-SkillsNetwork/IDSNlogo.png\" width=\"300\" alt=\"cognitiveclass.ai logo\"  />\n","</center>\n","\n","# Classes and Objects in Python\n","\n","Estimated time needed: **40** minutes\n","\n","## Objectives\n","\n","After completing this lab you will be able to:\n","\n","*   Work with classes and objects\n","*   Identify and define attributes and methods\n"]},{"cell_type":"markdown","metadata":{},"source":["<h2>Table of Contents</h2>\n","<div class=\"alert alert-block alert-info\" style=\"margin-top: 20px\">\n","    <ul>\n","        <li>\n","            <a href=\"https://#intro\">Introduction to Classes and Objects</a>\n","            <ul>\n","                <li><a href=\"https://create/?utm_medium=Exinfluencer&utm_source=Exinfluencer&utm_content=000026UJ&utm_term=10006555&utm_id=NA-SkillsNetwork-Channel-SkillsNetworkCoursesIBMDeveloperSkillsNetworkPY0101ENSkillsNetwork19487395-2021-01-01\">Creating a class</a></li>\n","                <li><a href=\"https://instance/?utm_medium=Exinfluencer&utm_source=Exinfluencer&utm_content=000026UJ&utm_term=10006555&utm_id=NA-SkillsNetwork-Channel-SkillsNetworkCoursesIBMDeveloperSkillsNetworkPY0101ENSkillsNetwork19487395-2021-01-01\">Instances of a Class: Objects and Attributes</a></li>\n","                <li><a href=\"https://method/?utm_medium=Exinfluencer&utm_source=Exinfluencer&utm_content=000026UJ&utm_term=10006555&utm_id=NA-SkillsNetwork-Channel-SkillsNetworkCoursesIBMDeveloperSkillsNetworkPY0101ENSkillsNetwork19487395-2021-01-01\">Methods</a></li>\n","            </ul>\n","        </li>\n","        <li><a href=\"https://creating/?utm_medium=Exinfluencer&utm_source=Exinfluencer&utm_content=000026UJ&utm_term=10006555&utm_id=NA-SkillsNetwork-Channel-SkillsNetworkCoursesIBMDeveloperSkillsNetworkPY0101ENSkillsNetwork19487395-2021-01-01\">Creating a class</a></li>\n","        <li><a href=\"https://circle/?utm_medium=Exinfluencer&utm_source=Exinfluencer&utm_content=000026UJ&utm_term=10006555&utm_id=NA-SkillsNetwork-Channel-SkillsNetworkCoursesIBMDeveloperSkillsNetworkPY0101ENSkillsNetwork19487395-2021-01-01\">Creating an instance of a class Circle</a></li>\n","        <li><a href=\"https://rect/?utm_medium=Exinfluencer&utm_source=Exinfluencer&utm_content=000026UJ&utm_term=10006555&utm_id=NA-SkillsNetwork-Channel-SkillsNetworkCoursesIBMDeveloperSkillsNetworkPY0101ENSkillsNetwork19487395-2021-01-01\">The Rectangle Class</a></li>\n","    </ul>\n","\n","</div>\n","\n","<hr>\n"]},{"cell_type":"markdown","metadata":{},"source":["<h2 id=\"intro\">Introduction to Classes and Objects</h2>\n"]},{"cell_type":"markdown","metadata":{},"source":["<h3>Creating a Class</h3>\n"]},{"cell_type":"markdown","metadata":{},"source":["The first step in creating a class is giving it a name. In this notebook, we will create two classes: Circle and Rectangle. We need to determine all the data that make up that class, which we call <em>attributes</em>. Think about this step as creating a blue print that we will use to create objects. In figure 1 we see two classes, Circle and Rectangle. Each has their attributes, which are variables. The class Circle has the attribute radius and color, while the Rectangle class has the attribute height and width. Let’s use the visual examples of these shapes before we get to the code, as this will help you get accustomed to the vocabulary.\n"]},{"cell_type":"markdown","metadata":{},"source":["<img src=\"https://cf-courses-data.s3.us.cloud-object-storage.appdomain.cloud/IBMDeveloperSkillsNetwork-PY0101EN-SkillsNetwork/labs/Module%203/images/ClassesClass.png\" width=\"500\" />\n"]},{"cell_type":"markdown","metadata":{},"source":["<i>Figure 1: Classes circle and rectangle, and each has their own attributes. The class Circle has the attribute radius and colour, the class Rectangle has the attributes height and width.</i>\n"]},{"cell_type":"markdown","metadata":{},"source":["<h3 id=\"instance\">Instances of a Class: Objects and Attributes</h3>\n"]},{"cell_type":"markdown","metadata":{},"source":["An instance of an object is the realisation of a class, and in Figure 2 we see three instances of the class circle. We give each object a name: red circle, yellow circle, and green circle. Each object has different attributes, so let's focus on the color attribute for each object.\n"]},{"cell_type":"markdown","metadata":{},"source":["<img src=\"https://cf-courses-data.s3.us.cloud-object-storage.appdomain.cloud/IBMDeveloperSkillsNetwork-PY0101EN-SkillsNetwork/labs/Module%203/images/ClassesObj.png\" width=\"500\" />\n"]},{"cell_type":"markdown","metadata":{},"source":["<i>Figure 2: Three instances of the class Circle, or three objects of type Circle.</i>\n"]},{"cell_type":"markdown","metadata":{},"source":["The colour attribute for the red Circle is the colour red, for the green Circle object the colour attribute is green, and for the yellow Circle the colour attribute is yellow.\n"]},{"cell_type":"markdown","metadata":{},"source":["<h3 id=\"method\">Methods</h3>\n"]},{"cell_type":"markdown","metadata":{},"source":["Methods give you a way to change or interact with the object; they are functions that interact with objects. For example, let’s say we would like to increase the radius of a circle by a specified amount. We can create a method called **add_radius(r)** that increases the radius by **r**. This is shown in figure 3, where after applying the method to the \"orange circle object\", the radius of the object increases accordingly. The “dot” notation means to apply the method to the object, which is essentially applying a function to the information in the object.\n"]},{"cell_type":"markdown","metadata":{},"source":["<img src=\"https://cf-courses-data.s3.us.cloud-object-storage.appdomain.cloud/IBMDeveloperSkillsNetwork-PY0101EN-SkillsNetwork/labs/Module%203/images/ClassesMethod.png\" width=\"500\" /> \n"]},{"cell_type":"markdown","metadata":{},"source":["<i>Figure 3: Applying the method “add_radius” to the object orange circle object.</i>\n"]},{"cell_type":"markdown","metadata":{},"source":["<hr>\n"]},{"cell_type":"markdown","metadata":{},"source":["<h2 id=\"creating\">Creating a Class</h2>\n"]},{"cell_type":"markdown","metadata":{},"source":["Now we are going to create a class Circle, but first, we are going to import a library to draw the objects:\n"]},{"cell_type":"code","execution_count":null,"metadata":{"jupyter":{"outputs_hidden":true}},"outputs":[],"source":["# Import the library\n","\n","import matplotlib.pyplot as plt\n","%matplotlib inline  "]},{"cell_type":"markdown","metadata":{},"source":["The first step in creating your own class is to use the <code>class</code> keyword, then the name of the class as shown in Figure 4. In this course the class parent will always be object:\n"]},{"cell_type":"markdown","metadata":{},"source":["<img src=\"https://cf-courses-data.s3.us.cloud-object-storage.appdomain.cloud/IBMDeveloperSkillsNetwork-PY0101EN-SkillsNetwork/labs/Module%203/images/ClassesDefine.png\" width=\"400\" />\n"]},{"cell_type":"markdown","metadata":{},"source":["<i>Figure 4: Creating a class Circle.</i>\n"]},{"cell_type":"markdown","metadata":{},"source":["The next step is a special method called a constructor <code>\\__init\\_\\_</code>, which is used to initialize the object. The inputs are data attributes. The term <code>self</code> contains all the attributes in the set. For example the <code>self.color</code> gives the value of the attribute color and <code>self.radius</code> will give you the radius of the object. We also have the method <code>add_radius()</code> with the parameter <code>r</code>, the method adds the value of <code>r</code> to the attribute radius. To access the radius we use the syntax <code>self.radius</code>. The labeled syntax is summarized in Figure 5:\n"]},{"cell_type":"markdown","metadata":{},"source":["<img src=\"https://cf-courses-data.s3.us.cloud-object-storage.appdomain.cloud/IBMDeveloperSkillsNetwork-PY0101EN-SkillsNetwork/labs/Module%203/images/ClassesCircle.png\" width=\"600\" />\n"]},{"cell_type":"markdown","metadata":{},"source":["<i>Figure 5: Labeled syntax of the object circle.</i>\n"]},{"cell_type":"markdown","metadata":{},"source":["The actual object is shown below. We include the method <code>drawCircle</code> to display the image of a circle. We set the default radius to 3 and the default colour to blue:\n"]},{"cell_type":"code","execution_count":null,"metadata":{},"outputs":[],"source":["# Create a class Circle\n","\n","class Circle(object):\n","    \n","    # Constructor\n","    def __init__(self, radius=3, color='blue'):\n","        self.radius = radius\n","        self.color = color \n","    \n","    # Method\n","    def add_radius(self, r):\n","        self.radius = self.radius + r\n","        return(self.radius)\n","    \n","    # Method\n","    def drawCircle(self):\n","        plt.gca().add_patch(plt.Circle((0, 0), radius=self.radius, fc=self.color))\n","        plt.axis('scaled')\n","        plt.show()  "]},{"cell_type":"markdown","metadata":{},"source":["<hr>\n"]},{"cell_type":"markdown","metadata":{},"source":["<h2 id=\"circle\">Creating an instance of a class Circle</h2>\n"]},{"cell_type":"markdown","metadata":{},"source":["Let’s create the object <code>RedCircle</code> of type Circle to do the following:\n"]},{"cell_type":"code","execution_count":null,"metadata":{},"outputs":[],"source":["# Create an object RedCircle\n","\n","RedCircle = Circle(10, 'red')"]},{"cell_type":"markdown","metadata":{},"source":["We can use the <code>dir</code> command to get a list of the object's methods. Many of them are default Python methods.\n"]},{"cell_type":"code","execution_count":null,"metadata":{},"outputs":[],"source":["# Find out the methods can be used on the object RedCircle\n","\n","dir(RedCircle)"]},{"cell_type":"markdown","metadata":{},"source":["We can look at the data attributes of the object:\n"]},{"cell_type":"code","execution_count":null,"metadata":{},"outputs":[],"source":["# Print the object attribute radius\n","\n","RedCircle.radius"]},{"cell_type":"code","execution_count":null,"metadata":{},"outputs":[],"source":["# Print the object attribute color\n","\n","RedCircle.color"]},{"cell_type":"markdown","metadata":{},"source":["We can change the object's data attributes:\n"]},{"cell_type":"code","execution_count":null,"metadata":{},"outputs":[],"source":["# Set the object attribute radius\n","\n","RedCircle.radius = 1\n","RedCircle.radius"]},{"cell_type":"markdown","metadata":{},"source":["We can draw the object by using the method <code>drawCircle()</code>:\n"]},{"cell_type":"code","execution_count":null,"metadata":{},"outputs":[],"source":["# Call the method drawCircle\n","\n","RedCircle.drawCircle()"]},{"cell_type":"markdown","metadata":{},"source":["We can increase the radius of the circle by applying the method <code>add_radius()</code>. Let's increases the radius by 2 and then by 5:\n"]},{"cell_type":"code","execution_count":null,"metadata":{},"outputs":[],"source":["# Use method to change the object attribute radius\n","\n","print('Radius of object:',RedCircle.radius)\n","RedCircle.add_radius(2)\n","print('Radius of object of after applying the method add_radius(2):',RedCircle.radius)\n","RedCircle.add_radius(5)\n","print('Radius of object of after applying the method add_radius(5):',RedCircle.radius)"]},{"cell_type":"markdown","metadata":{},"source":["Let’s create a blue circle. As the default colour is blue, all we have to do is specify what the radius is:\n"]},{"cell_type":"code","execution_count":null,"metadata":{},"outputs":[],"source":["# Create a blue circle with a given radius\n","\n","BlueCircle = Circle(radius=100)"]},{"cell_type":"markdown","metadata":{},"source":["As before, we can access the attributes of the instance of the class by using the dot notation:\n"]},{"cell_type":"code","execution_count":null,"metadata":{},"outputs":[],"source":["# Print the object attribute radius\n","\n","BlueCircle.radius"]},{"cell_type":"code","execution_count":null,"metadata":{},"outputs":[],"source":["# Print the object attribute color\n","\n","BlueCircle.color"]},{"cell_type":"markdown","metadata":{},"source":["We can draw the object by using the method <code>drawCircle()</code>:\n"]},{"cell_type":"code","execution_count":null,"metadata":{},"outputs":[],"source":["# Call the method drawCircle\n","\n","BlueCircle.drawCircle()"]},{"cell_type":"markdown","metadata":{},"source":["Compare the x and y axis of the figure to the figure for <code>RedCircle</code>; they are different.\n"]},{"cell_type":"markdown","metadata":{},"source":["<hr>\n"]},{"cell_type":"markdown","metadata":{},"source":["<h2 id=\"rect\">The Rectangle Class</h2>\n"]},{"cell_type":"markdown","metadata":{},"source":["Let's create a class rectangle with the attributes of height, width, and color. We will only add the method to draw the rectangle object:\n"]},{"cell_type":"code","execution_count":null,"metadata":{"jupyter":{"outputs_hidden":true}},"outputs":[],"source":["# Create a new Rectangle class for creating a rectangle object\n","\n","class Rectangle(object):\n","    \n","    # Constructor\n","    def __init__(self, width=2, height=3, color='r'):\n","        self.height = height \n","        self.width = width\n","        self.color = color\n","    \n","    # Method\n","    def drawRectangle(self):\n","        plt.gca().add_patch(plt.Rectangle((0, 0), self.width, self.height ,fc=self.color))\n","        plt.axis('scaled')\n","        plt.show()\n","        "]},{"cell_type":"markdown","metadata":{},"source":["Let’s create the object <code>SkinnyBlueRectangle</code> of type Rectangle. Its width will be 2 and height will be 3, and the color will be blue:\n"]},{"cell_type":"code","execution_count":null,"metadata":{},"outputs":[],"source":["# Create a new object rectangle\n","\n","SkinnyBlueRectangle = Rectangle(2, 10, 'blue')"]},{"cell_type":"markdown","metadata":{},"source":["As before we can access the attributes of the instance of the class by using the dot notation:\n"]},{"cell_type":"code","execution_count":null,"metadata":{},"outputs":[],"source":["# Print the object attribute height\n","\n","SkinnyBlueRectangle.height "]},{"cell_type":"code","execution_count":null,"metadata":{},"outputs":[],"source":["# Print the object attribute width\n","\n","SkinnyBlueRectangle.width"]},{"cell_type":"code","execution_count":null,"metadata":{},"outputs":[],"source":["# Print the object attribute color\n","\n","SkinnyBlueRectangle.color"]},{"cell_type":"markdown","metadata":{},"source":["We can draw the object:\n"]},{"cell_type":"code","execution_count":null,"metadata":{"scrolled":true},"outputs":[],"source":["# Use the drawRectangle method to draw the shape\n","\n","SkinnyBlueRectangle.drawRectangle()"]},{"cell_type":"markdown","metadata":{},"source":["Let’s create the object <code>FatYellowRectangle</code> of type Rectangle:\n"]},{"cell_type":"code","execution_count":null,"metadata":{"jupyter":{"outputs_hidden":true}},"outputs":[],"source":["# Create a new object rectangle\n","\n","FatYellowRectangle = Rectangle(20, 5, 'yellow')"]},{"cell_type":"markdown","metadata":{},"source":["We can access the attributes of the instance of the class by using the dot notation:\n"]},{"cell_type":"code","execution_count":null,"metadata":{},"outputs":[],"source":["# Print the object attribute height\n","\n","FatYellowRectangle.height "]},{"cell_type":"code","execution_count":null,"metadata":{},"outputs":[],"source":["# Print the object attribute width\n","\n","FatYellowRectangle.width"]},{"cell_type":"code","execution_count":null,"metadata":{},"outputs":[],"source":["# Print the object attribute color\n","\n","FatYellowRectangle.color"]},{"cell_type":"markdown","metadata":{},"source":["We can draw the object:\n"]},{"cell_type":"code","execution_count":null,"metadata":{},"outputs":[],"source":["# Use the drawRectangle method to draw the shape\n","\n","FatYellowRectangle.drawRectangle()"]},{"cell_type":"markdown","metadata":{},"source":["<hr>\n"]},{"cell_type":"markdown","metadata":{},"source":["<h2 id=\"rect\">Exercises</h2>\n"]},{"cell_type":"markdown","metadata":{},"source":["<h4> Text Analysis </h4>\n"]},{"cell_type":"markdown","metadata":{},"source":["You have been recruited by your friend, a linguistics enthusiast, to create a utility tool that can perform analysis on a given piece of text. Complete the class\n","'analysedText' with the following methods -\n","\n","<ul>\n","    <li> Constructor - Takes argument 'text',makes it lower case and removes all punctuation. Assume only the following punctuation is used - period (.), exclamation mark (!), comma (,) and question mark (?). Store the argument in \"fmtText\"      \n","    <li> freqAll - returns a dictionary of all unique words in the text along with the number of their occurences.\n","    <li> freqOf - returns the frequency of the word passed in argument.\n","</ul>\n"," The skeleton code has been given to you. Docstrings can be ignored for the purpose of the exercise. <br>\n"," <i> Hint: Some useful functions are <code>replace()</code>, <code>lower()</code>, <code>split()</code>, <code>count()</code> </i><br>\n"]},{"cell_type":"code","execution_count":null,"metadata":{},"outputs":[],"source":["class analysedText(object):\n","    \n","    def __init__ (self, text):\n","        pass\n","    \n","    def freqAll(self):        \n","        pass\n","    \n","    def freqOf(self,word):\n","        pass\n","        "]},{"cell_type":"markdown","metadata":{},"source":["Execute the block below to check your progress.\n"]},{"cell_type":"code","execution_count":null,"metadata":{},"outputs":[],"source":["import sys\n","\n","sampleMap = {'eirmod': 1,'sed': 1, 'amet': 2, 'diam': 5, 'consetetur': 1, 'labore': 1, 'tempor': 1, 'dolor': 1, 'magna': 2, 'et': 3, 'nonumy': 1, 'ipsum': 1, 'lorem': 2}\n","\n","def testMsg(passed):\n","    if passed:\n","       return 'Test Passed'\n","    else :\n","       return 'Test Failed'\n","\n","print(\"Constructor: \")\n","try:\n","    samplePassage = analysedText(\"Lorem ipsum dolor! diam amet, consetetur Lorem magna. sed diam nonumy eirmod tempor. diam et labore? et diam magna. et diam amet.\")\n","    print(testMsg(samplePassage.fmtText == \"lorem ipsum dolor diam amet consetetur lorem magna sed diam nonumy eirmod tempor diam et labore et diam magna et diam amet\"))\n","except:\n","    print(\"Error detected. Recheck your function \" )\n","print(\"freqAll: \")\n","try:\n","    wordMap = samplePassage.freqAll()\n","    print(testMsg(wordMap==sampleMap))\n","except:\n","    print(\"Error detected. Recheck your function \" )\n","print(\"freqOf: \")\n","try:\n","    passed = True\n","    for word in sampleMap:\n","        if samplePassage.freqOf(word) != sampleMap[word]:\n","            passed = False\n","            break\n","    print(testMsg(passed))\n","    \n","except:\n","    print(\"Error detected. Recheck your function  \" )\n","    "]},{"cell_type":"markdown","metadata":{},"source":["<details><summary>Click here for the solution</summary>\n","\n","```python\n","class analysedText(object):\n","    \n","    def __init__ (self, text):\n","        # remove punctuation\n","        formattedText = text.replace('.','').replace('!','').replace('?','').replace(',','')\n","        \n","        # make text lowercase\n","        formattedText = formattedText.lower()\n","        \n","        self.fmtText = formattedText\n","        \n","    def freqAll(self):        \n","        # split text into words\n","        wordList = self.fmtText.split(' ')\n","        \n","        # Create dictionary\n","        freqMap = {}\n","        for word in set(wordList): # use set to remove duplicates in list\n","            freqMap[word] = wordList.count(word)\n","        \n","        return freqMap\n","    \n","    def freqOf(self,word):\n","        # get frequency map\n","        freqDict = self.freqAll()\n","        \n","        if word in freqDict:\n","            return freqDict[word]\n","        else:\n","            return 0\n","    \n","```\n","\n","</details>\n"]},{"cell_type":"markdown","metadata":{},"source":["<hr>\n","<h2>The last exercise!</h2>\n","<p>Congratulations, you have completed your first lesson and hands-on lab in Python. However, there is one more thing you need to do. The Data Science community encourages sharing work. The best way to share and showcase your work is to share it on GitHub. By sharing your notebook on GitHub you are not only building your reputation with fellow data scientists, but you can also show it off when applying for a job. Even though this was your first piece of work, it is never too early to start building good habits. So, please read and follow <a href=\"https://cognitiveclass.ai/blog/data-scientists-stand-out-by-sharing-your-notebooks/?utm_medium=Exinfluencer&utm_source=Exinfluencer&utm_content=000026UJ&utm_term=10006555&utm_id=NA-SkillsNetwork-Channel-SkillsNetworkCoursesIBMDeveloperSkillsNetworkPY0101ENSkillsNetwork19487395-2021-01-01\" target=\"_blank\">this article</a> to learn how to share your work.\n","<hr>\n"]},{"cell_type":"markdown","metadata":{},"source":["## Author\n","\n","<a href=\"https://www.linkedin.com/in/joseph-s-50398b136/?utm_medium=Exinfluencer&utm_source=Exinfluencer&utm_content=000026UJ&utm_term=10006555&utm_id=NA-SkillsNetwork-Channel-SkillsNetworkCoursesIBMDeveloperSkillsNetworkPY0101ENSkillsNetwork19487395-2021-01-01\" target=\"_blank\">Joseph Santarcangelo</a>\n","\n","## Other contributors\n","\n","<a href=\"https://www.linkedin.com/in/jiahui-mavis-zhou-a4537814a?utm_medium=Exinfluencer&utm_source=Exinfluencer&utm_content=000026UJ&utm_term=10006555&utm_id=NA-SkillsNetwork-Channel-SkillsNetworkCoursesIBMDeveloperSkillsNetworkPY0101ENSkillsNetwork19487395-2021-01-01\">Mavis Zhou</a>\n","\n","## Change Log\n","\n","| Date (YYYY-MM-DD) | Version | Changed By | Change Description                 |\n","| ----------------- | ------- | ---------- | ---------------------------------- |\n","| 2020-08-26        | 2.0     | Lavanya    | Moved lab to course repo in GitLab |\n","|                   |         |            |                                    |\n","|                   |         |            |                                    |\n","\n","<hr/>\n","\n","## <h3 align=\"center\"> © IBM Corporation 2020. All rights reserved. <h3/>\n"]}],"metadata":{"kernelspec":{"display_name":"Python 3","language":"python","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.7.6"}},"nbformat":4,"nbformat_minor":4}