TweetFollow Us on Twitter

Mac in the Shell: Learning Python on the Mac: Classes

Volume Number: 25
Issue Number: 05
Column Tag: Mac in the Shell

Mac in the Shell: Learning Python on the Mac: Classes

Building a Basic Class

by Edward Marczak

Introduction

Last month, we covered conceptually what classes are, why they're useful and when you may use them. This was all done with no (real) code. None of the nitty-gritty. That's where we're headed this month. So, without further ado, let's get into some Python code!

Modeling the Real World

Traditionally, defining a class is the mechanism that allows the code author to create a "factory" for churning out (instantiating) objects. Python is a little different in that everything is treated as an object whether you are aware of that fact or not. As we discussed last month, you use a class when you have a model in the real world that you'd like to follow. In his Road to Code column, Dave Dribin has been using shapes as objects. A single shape class can be used to model shapes from the real world: a square, a rectangle, etc. We're going to use a different example that's just as grounded in the real world: a bank account.

Before getting into the code, it's wise to plan out a class: what is it's structure? A class can hold instance variables and methods. An instance variable is simply a variable that is specific to a given class. Similarly, a method is a function that resides internal to a class, and can act on instance variables stored in a class.

What do we need to plan out our bank account class? Well, the account should have some method of identifying it - a name or number, perhaps. Since this is a small example, and we're not worried about name conflicts, and we don't want to treat people like a number, let's just go with name. That's one, actually two, instance variables: First Name and Last Name. The account will also have a balance, our third instance variable.

What actions do we need to take these variables? Focusing on the balance, we certainly need to deposit money. That's our first method! We'll also want to withdraw this money at some point, which will be our second method. Let's start modeling the class from here.

Bank Account Class

First things first: create a directory for this project. I'm using "Bank_Class", but you're free to call it what you wish. Inside that directory, I'm creating a file named "Bank_Class.py". Use vi, BBEdit or whichever plain text editor makes you most comfortable.

First thing is first; the magic shebang line:

#!/usr/bin/env python

As shown last month, classes always begin with the class keyword to define them:

class account:

and we said we need three instance variables: balance, first name and last name. We can define them here (but please read on as we're going to refine this!):

class account:
  balance = 0
  fname = ''
  lname = ''

From here, we can actually use this class:

acct = Account()  # Instantiate a new Account
print 'Account balance is', acct.balance
print 'Depositing $50'
acct.balance = acct.balance + 50
print 'Balance is now', acct.balance

Which yields the output:

Account balance is 0
Depositing $50
Balance is now 50

Now, just because we can doesn't mean that we should! This code will work, but it has a few holes. One large issue being that we don't have to assign a name to this account, and this is what we hoped to be our identifier. If there are actions we want to take, including assignment, every time we create an instance, we can define a constructor. A constructor is just another function (or, method). What makes it special is that it will run every time the class is instantiated. Defining a method named "__init__" creates a constructor (that's two underscores and the word 'init' followed by two underscores. Instead of the small tangled mess shown above, we can define the following:

class Account:
  def __init__(self, fn, ln):
    self.balance=0
    self.fname=fn
    self.lname=ln

Now when we instantiate the class, we can call it like this:

acct1 = Account('Bill', 'Smith')

This will create the account with a zero balance and assign the first name as "Bill" and the last name as "Smith". If we forget one or both parameters, the class will raise an error.

What's with the "self"?

Python requires that there be an additional first parameter to a class method. While you could technically name it anything you like, it's canonically called self. The Python runtime will automatically supply the value for this parameter at runtime. The self parameter is an object reference used to pass instance values to the method. While you can call it anything you like, all of the Python documentation uses "self," along with, well, every Python author that I know or have seen. So, stick with the convention of "self." It'll help you, or anyone that needs to look at your code in the future.

Additional Methods

Now that we can instantiate a new bank account, we'll want to act on it. We've already decided that we need at least two methods: deposit and withdraw. Add the methods to the class (remember the right indentation!):

class Account:
  def __init__(self, fn, ln):
    self.balance = 0
    self.fname = fn
    self.lname = ln
    
  def Deposit(self,amount):
    self.balance += amount
  
  def Withdraw(self, amount):
    self.balance -= amount

Now we can create a new account, deposit and withdraw money. (Note the use of the += and -= operators. This is simple shorthand for repeating the left-hand variable. x = x + 1 can become x += 1). Unlike the first version of this code shown above, we don't have to set the variables ourselves, but rather we use a method to do it for us:

acct = Account('Joan', 'Smith')    # Create new account
print "Acct1 Balance = ", acct1.balance
print "Depositing $50 to acct1"
acct1.Deposit(50)       # Note use of class method here
print "Acct1 Balance =", acct1.balance

Naturally, there are some holes with this. There are no sanity checks to see if there's any money in the account before we withdraw it, for one. That is an improvement left to the reader.

How is this better?

Well, the examples given thus far haven't done much to improve on traditional procedural programming. However, now that we have the structure in place, it's easy to go beyond that. Creating multiple accounts, for instance is as simple as an assignment:

acct1 = Account('Joan', 'Smith')
acct2 = account('Bob', 'Smith')

And we can perform discreet actions on each:

acct1.Deposit(50)
acct2.Deposit(1000)
print "Acct1 Balance =", acct1.balance
print "Acct2 Balance =", acct2.balance

You should be able to visualize a dictionary structure filled with accounts. Or, the ability to find a record in a database and loading the found record(s) into an Account class.

Conclusion

Between last month and this month - please ensure that you also understand the material presented last month, too! - you should have a pretty good idea what classes are, how they work, and how to start building your own. Next month, we'll get into some OS X-specific functionality of Python and build some useful classes.

Media of the month: http://www.facebook.com. Seriously. OK, pick any social network, but Facebook seems to be the biggest. And then go say hello to someone you miss.

Hope to see everyone at WWDC next month! See you in San Francisco!


Ed Marczak is the Executive Editor of MacTech Magazine. He lives in New York with his wife, two daughters and various pets. He has been involved with technology since Atari sucked him in, and has followed Apple since the Apple I days. He spends his days on the Mac team at Google, and free time with his family and/or playing music. Ed is the author of the Apple Training Series book, "Advanced System Administration v10.5," and has written for MacTech since 2004.

 
AAPL
$105.22
Apple Inc.
+0.39
MSFT
$46.13
Microsoft Corpora
+1.11
GOOG
$539.78
Google Inc.
-4.20

MacTech Search:
Community Search:

Software Updates via MacUpdate

f.lux 34.0 - Adjusts the color of your d...
f.lux makes the color of your computer's display adapt to the time of day, warm at night and like sunlight during the day. Ever notice how people texting at night have that eerie blue glow? Or wake... Read more
Ember 1.8.2 - Versatile digital scrapboo...
Ember (formerly LittleSnapper) is your digital scrapbook of things that inspire you: websites, photos, apps or other things. Just drag in images that you want to keep, organize them into relevant... Read more
Tonality Pro 1.1.2 - Professional-grade...
Tonality Pro gives you the power to create stunning and dramatic black & white images. This is a complete monochrome image editor with more than 150 one-click style presets, totally unique... Read more
VueScan 9.4.49 - Scanner software with a...
VueScan is a scanning program that works with most high-quality flatbed and film scanners to produce scans that have excellent color fidelity and color balance. VueScan is easy to use, and has... Read more
OS X Server 4.0 - For OS X 10.10 Yosemit...
Designed for OS X and iOS devices, OS X Server makes it easy to share files, schedule meetings, synchronize contacts, develop software, host your own website, publish wikis, configure Mac, iPhone,... Read more
TotalFinder 1.6.12 - Adds tabs, hotkeys,...
TotalFinder is a universally acclaimed navigational companion for your Mac. Enhance your Mac's Finder with features so smart and convenient, you won't believe you ever lived without them. Tab-based... Read more
BusyCal 2.6.3 - Powerful calendar app wi...
BusyCal is an award-winning desktop calendar that combines personal productivity features for individuals with powerful calendar sharing capabilities for families and workgroups. BusyCal's unique... Read more
calibre 2.7 - Complete e-library managem...
Calibre is a complete e-book library manager. Organize your collection, convert your books to multiple formats, and sync with all of your devices. Let Calibre be your multi-tasking digital... Read more
Skitch 2.7.3 - Take screenshots, annotat...
With Skitch, taking, annotating, and sharing screenshots or images is as fun as it is simple.Communicate and collaborate with images using Skitch and its intuitive, engaging drawing and annotating... Read more
Delicious Library 3.3.2 - Import, browse...
Delicious Library allows you to import, browse, and share all your books, movies, music, and video games with Delicious Library. Run your very own library from your home or office using our... Read more

Latest Forum Discussions

See All

Rami Ismail Opens Up distribute​() for D...
Rami Ismail Opens Up distribute​() for Developers Posted by Jessica Fisher on October 24th, 2014 [ permalink ] Rami Ismail, Chief Executive of Business and Development at indie game studio | Read more »
Great Hitman GO Goes on Sale and Gets Ne...
Great Hitman GO Goes on Sale and Gets New Update – Say That Three Times Fast Posted by Jessica Fisher on October 24th, 2014 [ permalink ] | Read more »
Rival Stars Basketball Review
Rival Stars Basketball Review By Jennifer Allen on October 24th, 2014 Our Rating: :: RESTRICTIVE BUT FUNUniversal App - Designed for iPhone and iPad Rival Stars Basketball is a fun mixture of basketball and card collecting but its... | Read more »
Rubicon Development Makes Over a Dozen o...
Rubicon Development Makes Over a Dozen of Their Games Free For This Weekend Only Posted by Jessica Fisher on October 24th, 2014 [ permalink ] | Read more »
I Am Dolphin Review
I Am Dolphin Review By Jennifer Allen on October 24th, 2014 Our Rating: :: NEARLY FIN-TASTICUniversal App - Designed for iPhone and iPad Swim around and eat nearly everything that moves in I Am Dolphin, a fun Ecco-ish kind of game... | Read more »
nPlayer looks to be the ultimate choice...
Developed by Newin Inc, nPlayer may seem like your standard video player – but is aiming to be the best in its field by providing high quality video play performance and support for a huge number of video formats and codecs. User reviews include... | Read more »
Fighting Fantasy: Caverns of the Snow Wi...
Fighting Fantasy: Caverns of the Snow Witch Review By Jennifer Allen on October 24th, 2014 Our Rating: :: CLASSY STORYTELLINGUniversal App - Designed for iPhone and iPad Fighting Fantasy: Caverns of the Snow Witch is a sterling... | Read more »
A Few Days Left (Games)
A Few Days Left 1.01 Device: iOS Universal Category: Games Price: $3.99, Version: 1.01 (iTunes) Description: Screenshots are in compliance to App Store's 4+ age rating! Please see App Preview for real game play! **Important: Make... | Read more »
Toca Boo (Education)
Toca Boo 1.0.2 Device: iOS Universal Category: Education Price: $2.99, Version: 1.0.2 (iTunes) Description: BOO! Did I scare you!? My name is Bonnie and my family loves to spook! Do you want to scare them back? Follow me and I'll... | Read more »
Intuon (Games)
Intuon 1.1 Device: iOS Universal Category: Games Price: $.99, Version: 1.1 (iTunes) Description: Join the battle with your intuition in a new hardcore game Intuon! How well do you trust your intuition? Can you find a needle in a... | Read more »

Price Scanner via MacPrices.net

Weekend sale: 13-inch 128GB MacBook Air for $...
Best Buy has the 2014 13-inch 1.4GHz 128GB MacBook Air on sale for $849.99, or $150 off MSRP, on their online store. Choose free home shipping or free local store pickup (if available). Price valid... Read more
Nimbus Note Cross=Platform Notes Utility
Nimbus Note will make sure you never forget or lose your valuable data again. Create and edit notes, save web pages, screenshots and any other type of data – and share it all with your friends and... Read more
NewerTech’s Snuglet Makes MagSafe 2 Power Con...
NewerTech has introduced the Snuglet, a precision-manufactured ring designed to sit inside your MagSafe 2 connector port, providing a more snug fit to prevent your power cable from unintentional... Read more
Apple Planning To Sacrifice Gross Margins To...
Digitimes Research’s Jim Hsiao says its analysts believe Apple is planning to sacrifice its gross margins to save its tablet business, which has recently fallen into decline. They project that Apple’... Read more
Who’s On Now? – First Instant-Connect Search...
It’s nighttime and your car has broken down on the side of the highway. You need a tow truck right away, so you open an app on your iPhone, search for the closest tow truck and send an instant... Read more
13-inch 2.5GHz MacBook Pro on sale for $949,...
Best Buy has the 13″ 2.5GHz MacBook Pro available for $949.99 on their online store. Choose free shipping or free instant local store pickup (if available). Their price is $150 off MSRP. Price is... Read more
Save up to $125 on Retina MacBook Pros
B&H Photo has the new 2014 13″ and 15″ Retina MacBook Pros on sale for up to $125 off MSRP. Shipping is free, and B&H charges NY sales tax only. They’ll also include free copies of Parallels... Read more
Apple refurbished Time Capsules available sta...
The Apple Store has certified refurbished Time Capsules available for up to $60 off MSRP. Apple’s one-year warranty is included with each Time Capsule, and shipping is free: - 2TB Time Capsule: $255... Read more
Textilus New Word, Notes and PDF Processor fo...
Textilus is new word-crunching, notes, and PDF processor designed exclusively for the iPad. I haven’t had time to thoroughly check it out yet, but it looks great and early reviews are positive.... Read more
WD My Passport Pro Bus-Powered Thunderbolt RA...
WD’s My Passport Pro RAID solution is powered by an integrated Thunderbolt cable for true portability and speeds as high as 233 MB/s. HighlightsOverviewSpecifications Transfer, Back Up And Edit In... Read more

Jobs Board

*Apple* Solutions Consultant - Apple Inc. (U...
…important role that the ASC serves is that of providing an excellent Apple Customer Experience. Responsibilities include: * Promoting Apple products and solutions Read more
*Apple* Solutions Consultant - Apple Inc. (U...
…important role that the ASC serves is that of providing an excellent Apple Customer Experience. Responsibilities include: * Promoting Apple products and solutions Read more
Senior Event Manager, *Apple* Retail Market...
…This senior level position is responsible for leading and imagining the Apple Retail Team's global event strategy. Delivering an overarching brand story; in-store, Read more
*Apple* Solutions Consultant (ASC) - Apple (...
**Job Summary** The ASC is an Apple employee who serves as an Apple brand ambassador and influencer in a Reseller's store. The ASC's role is to grow Apple Read more
Project Manager / Business Analyst, WW *Appl...
…a senior project manager / business analyst to work within our Worldwide Apple Fulfillment Operations and the Business Process Re-engineering team. This role will work Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.