Now on Github

HousewifeHacker is now on Github. To avoid further formatting problems with pasting my code on the blog, I will be using github to embed my code. For those who are unfamiliar with Github, the site allows programmers to follow open source contributions from different authors and contribute to full projects (Repositories) or small code snippets (Gists) by creating your own code or making changes to other user's work (forking). Users can determine whether their repositories and gists are public or private. The objective of Github is to serve as a social coding resource as well as a revision control. Because I want to be able to contribute to open source projects as I become more knowledgeable of Python, Github will become an increasingly valuable resource.

maketrans Python and Improved Caesar's Shift

Maketrans is used to translate strings, character for character. The characters can be symbols, letters, or numbers. The following short example is a Caesar's Shift moving backwards by two letters.

#first we need to import maketrans
>>> from string import maketrans
#now define the translation
#parameters are strings, not lists
#first parameter defines what will be found in the string
#second parameter defines what each will be changed to
>>> trans = maketrans('cdefg','abcde')
#define our string and translate
>>> s = 'deg'
>>> s.translate(trans)
'bce'

Now using maketrans and a few other suggestions from the comments, I have written a newly improved Caesar's Shift. Encode and decode use the same code, because a shift of 4 in one direction of a 26 character alphabet is equivalent to a shift of 22 in the other direction. I also used ascii_letters to shift my translation, which is 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'. The letter w may be encoded to be a A by a shift of 4, but the decoding will return the lowercase w. There was an error in my exception handling, which is now corrected.

Caesar Cipher in Python Using ASCII

ASCII is how American computers store numbers, letters, certain commands, and symbols as numbers. A binary byte is eight digits long, consisting of only 1 and 0. When ASCII was developed, there were 2^8, or 256 possible characters for 8-bit (1 byte) personal computers. Unicode is used more commonly and extensively, but ASCII is sufficient or this exercise. Consult an ASCII Table or play with python's default functions to determine the encoding of a character such as 'a', 'A' or '&'.

In python, we can find the ascii value using ord of a string

>>> ord('a')
97
>>> ord('A')
65
>>> ord('b')
98
>>> ord('1')
49
>>> ord('2')
50
>>> 3-0
3
>>> ord('3')-ord('0')
3

Notice how the lower case and upper case are unique. Also, the ASCII numeric value and the character increase by the same amount. The same trend is true for the continuation of the alphabet, if lower case or upper case characteristic is preserved. The string length must be 1 when using ord, because each index has its own ASCII value.For a multiple digit number or a word, you can use a for loop to go through the string.

The reverse of ord is chr, for character.

>>> chr(97)
'a'
>>> i=97
>>> while i<104:
...   print chr(i)
...   i+=1
... 
a
b
c
d
e
f
g
>>> alpha=[]
>>> i=97
>>> while i<104:
...   alpha.append(chr(i))
...   i+=1
... 
>>> print alpha
['a', 'b', 'c', 'd', 'e', 'f', 'g']

Caesar's shift was how Caesar communicated with his generals, in which each letter in the plaintext is replaced by a letter some fixed number of positions down the alphabet. For example, if an 'a' is encoded by a 'c' with a shift of 2, then a 'b' would be encoded by a 'd.' Reversely, an 'a' in the encoded text would be a 'y' in the plaintext. The following program was inspired by thepythonchallenge.com. My husband and I had a lot of fun testing and debugging by sending each other messages over email. The code only changes letters so that spaces, smilies, brackets, and other punctuations and characters will be preserved. string.maketrans would be very useful and less code for a one time application, but the following code is highly reusable.

#string will later allow us to test for ascii letters
import string

def encode(input,shift):
  #create an empty string
  foo = ''
  #a for loop to shift the letters by the shift input 
  for x in input:
    #changes only ascii letters
    if x in string.ascii_letters:
      #upper case end of alphabet, to loop back to A
      if ord(x) > ord("Z") - shift and ord(x) <= ord("Z"):
        new_ord = ord(x) + shift - 26
      #lower case end of alphabet
      elif ord(x) > ord("z") - shift and ord(x) <= ord("z"):
        new_ord = ord(x) + shift - 26
      else:
        new_ord = ord(x) + shift
    #other characters will remain unchanged
    else:
      new_ord = ord(x)

    new_chr = chr(new_ord)
    foo += new_chr

  print "Your encoded message is ", foo

def decode(input,shift):
  #create an empty string
  foo = ''
  #a for loop to shift the leters by the shift input 
  for x in input:
    #changes only ascii letters
    if x in string.ascii_letters:
      #upper case start of alphabet, to loop back to Z
      if ord(x) - shift < ord("A")  and ord(x) >= ord("A"):
        new_ord = ord(x) - shift + 26
      #lower case end of alphabet
      elif ord(x) - shift < ord("a") and ord(x) >= ord("a"):
        new_ord = ord(x) - shift + 26
      else:
        new_ord = ord(x) - shift
    #other characters will remain unchanged
    else:
      new_ord = ord(x)
    new_chr = chr(new_ord)
    foo += new_chr
  print "Your decoded message is ", foo


def get_shift():
  try:
    shift = int(raw_input("How many characters do you want to\
 shift?\n"))
  except:
    print 'Shift must be a number'
    shift = get_shift()
  if not (shift > 0 and shift <= 25):
    print 'Shift must be between 1 and 25'
    shift = get_shift()
  return shift

def main():
  try:
    action=raw_input("Welcome to Caeser's Shifter! Would you \
like to encode or decode a message today?\n")
  except:
    print 'Please type encode or decode'
    main()
  shift = get_shift()

  print "Ok, let's %s your message with a shift of %d." % (action, shift)
  input=raw_input("What would you like to be translated?\n")

  if action=='encode':
    encode(input,shift)
  elif action=='decode':
    decode(input,shift)

if __name__ == "__main__":
  main()

There are probably a few areas where redundancy can be reduced, but I am still learning as a developer. This was my first time trying exception handling, which I learned from my husband.

' \ ' Escapes in Python

I have previously mentioned that '\n' codes for a new line. The backslash is known in Python as an escape.

>>> print "\tThis is a tabbed line"
 This is a tabbed line
>>> print "This sentence \nis split on \nthree lines"
This sentence 
is split on 
three lines
>>> print "Type \\ for a backslash"
Type \ for a backslash
>>> print "Verticle \vTab"
Verticle 
         Tab
>>> print "Shopping List: \vPrenatal vitamins \vCocoa Butter \
... \vOrange juice"
Shopping List: 
               Prenatal vitamins 
                                 Cocoa Butter 
                                              Orange juice
>>> print "Shopping List: \n\t*Prenatal vitamins \  
...\n\t*Cocoa Butter \n\t*Orange juice"
Shopping List: 
 *Prenatal vitamins 
 *Cocoa Butter 
 *Orange juice
>>> print 'Prevent the single quote 5\'5" from ending the string'
Prevent the single quote 5'5" from ending the string
>>> print "Prevent the double quote 5'5\" from ending the string"
Prevent the double quote 5'5" from ending the string

Notice that I also used a backslash in my string so that I could continue onto the next ine without Python thinking my string was done. There are other escapes in Python you can read about. "Carriage return" is a term from type writers to mean that you move to the beginning of a line. Linefeed and formfeed are also typewriter terms. \n and \t will be the most frequently used, though you may also want to be familiar with other escapes for unique problems.

Guess the Number Game Python

With inspiration from InventWithPython.com, I wrote a game to guess a number between 1 and 20 with six attempts. This simple game is good practice for a beginner. My code is written in Python 2.6. The example from the link is written in Python 3 syntax.

import random

guessesTaken = 0

print 'Hello! What is your name?'
myName = raw_input() #get user name

number = random.randint(1,20) #random number between 1 and 20
print '%s I am thinking of a number between 1 and 20.' % myName

while guessesTaken < 6:
  print 'Take a guess.'
  guess = int(raw_input())
  guessesTaken += 1
  if guess < number:
    print 'Your guess is too low.'
  elif guess > number:
    print 'Your guess is too high.'
  else:
    break #breaks out of loop

if guess == number:
  if guessesTaken == 1:
    print 'Good Job, %s! You guessed my number in 1 guess!'
  else:
    print 'Good Job, %s! You guessed my number in %d guesses!' % \
(myName,guessesTaken) #actual format on previous line without '\'


if guess != number:
  print 'No. The number I was thinking of was %d' % number

Python Debugger Article by Sontek

My husband wrote a wonderful blog post about debugging Python. Read it here.

String Formatting in Python

An easy way to combine strings with non strings is to use commas:

>>>>>> print 'The value of pi is often rounded to',3.14
The value of pi is often rounded to 3.14

But what if you want to create a website that welcomes guests by their name after he or she logs in? What if you are pulling information from a list or a dictionary? For personalization or multiple use functionality, we will be using string formatting. Below are the different format characters. There are a few others, but they aren't necessary.

%s   string
%d   integers or decimals, but returns floor integer
%r   anything that is not a string, converts object to a string
%f   floating point, so we can control precision after decimal

Here is an example of using each of the formats:

>>> name='Anderson Silva'
>>> weight= 105 #integer
>>> height= 1.92 #decimal, but I only want 1.9 displayed
>>> home= 'Brazil' #string, watch what happens with %r 
>>> fighter1='''%s
... Nationality: %r
... Weight: %d kg
... Height %.1f m''' % (name,home,weight,height) #in order 
>>> print fighter1
Anderson Silva
Nationality: 'Brazil' #%r leaves quotes around strings
Weight: 105 kg
Height 1.9 m

Here is an example converting centimetres to inches

>>> def convert(cm):
...  inches=cm*.39370
...  print 'There are %.2f inches in %d centimetres' % (inches,cm)
... 
>>> convert(10)
There are 3.94 inches in 10 centimetres 
>>>#two places after decimal are shown
>>> convert(3.544445)
There are 1.40 inches in 3 centimetres

%f has a default to print six numbers after the decimal. By adding '.1', '.2', '.3', etc... between the '%' and 'f', you determine how many numbers are visible after the decimal. You can also add '+' or '-' before the '.x', such as showing a change

>>> print "Today's stock price changed %+.2f" % 1.4888
Today's stock price changed +1.49