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
$517.96
Apple Inc.
-3.72
MSFT
$39.75
Microsoft Corpora
+0.57
GOOG
$536.44
Google Inc.
+3.92

MacTech Search:
Community Search:

Software Updates via MacUpdate

Starcraft II: Wings of Liberty 1.1.1.180...
Download the patch by launching the Starcraft II game and downloading it through the Battle.net connection within the app. Starcraft II: Wings of Liberty is a strategy game played in real-time. You... Read more
Sibelius 7.5.0 - Music notation solution...
Sibelius is the world's best-selling music notation software for Mac. It is as intuitive to use as a pen, yet so powerful that it does most things in less than the blink of an eye. The demo includes... Read more
Typinator 5.9 - Speedy and reliable text...
Typinator turbo-charges your typing productivity. Type a little. Typinator does the rest. We've all faced projects that require repetitive typing tasks. With Typinator, you can store commonly used... Read more
MYStuff Pro 2.0.16 - Create inventories...
MYStuff Pro is the most flexible way to create detail-rich inventories for your home or small business. Add items to MYStuff by dragging and dropping existing information, uploading new images, or... Read more
TurboTax 2013.r17.002 - Manage your 2013...
TurboTax guides you through your tax return step by step, does all the calculations, and checks your return for errors and overlooked deductions. It lets you file your return electronically to get... Read more
TrailRunner 3.8.769 - Route planning for...
Note: While the software is classified as freeware, it is actually donationware. Please consider making a donation to help support development. TrailRunner is the perfect companion for runners,... Read more
Flavours 1.1.10 - Create and apply theme...
Flavours is a Mac application that allow users to create, apply and share beautifully designed themes. Classy Give your Mac a gorgeous new look by applying delicious themes! Easy Unleash your... Read more
Spotify 0.9.8.296. - Stream music, creat...
Spotify is a streaming music service that gives you on-demand access to millions of songs. Whether you like driving rock, silky R&B, or grandiose classical music, Spotify's massive catalogue... Read more
SlingPlayer Plugin 3.3.20.475 - Browser...
SlingPlayer is the screen interface software that works hand-in-hand with the hardware inside the Slingbox to make your TV viewing experience just like that at home. It features an array of... Read more
S.M.A.R.T. for USB and FireWire Drives 0...
S.M.A.R.T. for USB and FireWire Drives is a kernel driver for OS X external usb or firewire drives. It extends the standard driver behaviour by providing access to drive smart data. The interface to... Read more

Latest Forum Discussions

See All

148Apps Live on Twitch: Pivvot’s Looper...
On our latest Twitch stream, we’ll be playing a pair of minimalist arcade games, one that just got a big content update in Pivvot, and another that was inspired by it in 15 Coins. Whitaker Trebella, creator of Pivvot, will discuss the new modes... | Read more »
Word Cubes Review
Word Cubes Review By Jordan Minor on April 15th, 2014 Our Rating: :: SQUARESVILLEUniversal App - Designed for iPhone and iPad Word Cubes is fine, but it is barely any different from any other word game.   | Read more »
PAX East 2014 – Desert Fox: The Battle o...
PAX East 2014 – Desert Fox: The Battle of El Alamein is Coming to iOS Soon Posted by Rob Rich on April 15th, 2014 [ permalink ] Shenandoah Studio has become one of the go-to developers for war games on iOS, with | Read more »
Tank of Tanks Review
Tank of Tanks Review By Carter Dotson on April 15th, 2014 Our Rating: :: TANKS A LOT!iPad Only App - Designed for the iPad This multiplayer game played on a single iPad is simple, chaotic fun.   | Read more »
PAX East 2014 – Dungeon of the Endless J...
PAX East 2014 – Dungeon of the Endless Just Might Have a Shot at an iPad Release Posted by Rob Rich on April 15th, 2014 [ permalink ] I think it’s fair to say that | Read more »
SideSwype Review
SideSwype Review By Carter Dotson on April 15th, 2014 Our Rating: :: ON YOUR SIDEUniversal App - Designed for iPhone and iPad SideSwype is a puzzler that takes inspiration from Threes, but becomes its own incredibly fun game.   | Read more »
PAX East 2014 – Bigfoot Hunter Invites P...
PAX East 2014 – Bigfoot Hunter Invites Players on a Wild and Wooly Photo Safari Posted by Rob Rich on April 15th, 2014 [ permalink ] Yeti. Sasquatch. Wendigo. | Read more »
Dungeon Quest Review
Dungeon Quest Review By Cata Modorcea on April 15th, 2014 Our Rating: :: NO STORY, BUT GOOD FUNUniversal App - Designed for iPhone and iPad Dungeon Quest does a lot of things right, but ultimately forgets about one of the core... | Read more »
Tempo AI and Speek Join Forces to “Kill...
Tempo AI and Speek Join Forces to “Kill the Conference Call PIN” Posted by Rob Rich on April 15th, 2014 [ permalink ] Today Tempo AI, makers of Tempo Smart Calendar, and | Read more »
Fighting Fantasy: Starship Traveller Rev...
Fighting Fantasy: Starship Traveller Review By Jennifer Allen on April 15th, 2014 Our Rating: :: A SIGNIFICANT VOYAGEUniversal App - Designed for iPhone and iPad Continuing the release of Fighting Fantasy titles, Starship Traveller... | Read more »

Price Scanner via MacPrices.net

Save $50 on Mac mini Server
B&H Photo has the 2012 Mac mini Server on sale for $949 including free shipping plus NY sales tax only. Their price is $50 off MSRP. Read more
PhatWare’s “Ultimate Writing App For iOS” Ren...
PhatWare Corp. has announced it has renamed its new WritePro word processing app for iPhone and iPad: WritePad Pro. The decision to change the app’s name to leverages the strong brand awareness and... Read more
Full Resolution Photo Editor Tint Mint 1.0 Re...
California based independent developer, Jeffrey Sun, creator of the iOS app Modern Editor, has released Tint Mint, a new photography app for editing enthusiasts. The app costs a dollar, and it packs... Read more
16GB iPad mini (Apple refurbished) available...
The Apple Store has refurbished 1st generation 16GB iPad minis available for $249 including free shipping. Both black and white models are available. Read more
Save $120 on the 27-inch 3.2GHz Haswell iMac
B&H Photo has the 27″ 3.2GHz iMac on sale for $1679.99 including free shipping plus NY sales tax only. Their price is about $120 off MSRP. Read more
Using a Mac Doesn’t Eliminate The Heartbleed...
Low End Mac’s Dan Knight notes that any time you visit a website with an https: prefix or see that secure lock icon on your browser, some type of security software is busy trying to protect your data... Read more
AirPrint Basics Tutorial Posted
A new Apple Knowledge Base article helps get you started using AirPrint, the Apple protocol that enables instant printing from iPad, iPhone, iPod touch, and Mac without the need to install drivers or... Read more
Speed Tips For Running LibreOffice On The Mac
LibreOffice is my favorite of several free, open-source application suites, and the one I have configured on my Mac as my default app for Word documents that one frequently has to deal with. It also... Read more
Snag a 15-inch Retina MacBook Pro for $115 of...
B&H Photo has 2013 15″ Retina MacBook Pros on sale for up to $115 off MSRP for a limited time. Shipping is free, and B&H charges NY sales tax only: - 15″ 2.3GHz Retina MacBook Pro: $2489.99... Read more
MacBook Airs on sale for $50 to $100 off MSRP
Several resellers are offering $50-$100 discounts on 11″ and 13″ MacBook Airs today, including Amazon, Best Buy, B&H, and others. See the breakdown of deals on our MacBook Air Price Tracker,... Read more

Jobs Board

Position Opening at *Apple* - Apple (United...
**Job Summary** Every day, business customers come to the Apple Store to discover what powerful, easy-to-use Apple products can do for them. As a Business Leader, Read more
Position Opening at *Apple* - Apple (United...
…challenges of developing individuals, building teams, and affecting growth across Apple Stores. You demonstrate successful leadership ability - focusing on excellence Read more
Position Opening at *Apple* - Apple (United...
…Summary** As a Specialist, you help create the energy and excitement around Apple products, providing the right solutions and getting products into customers' hands. You Read more
Position Opening at *Apple* - Apple (United...
**Job Summary** The Apple Store is a retail environment like no other - uniquely focused on delivering amazing customer experiences. As an Expert, you introduce people Read more
Position Opening at *Apple* - Apple (United...
**Job Summary** Being a Business Manager at an Apple Store means you're the catalyst for businesses to discover and leverage the power, ease, and flexibility of Apple Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.