Muffinresearch Labs by Stuart Colville

Titlecase.py: Titlecase in python | Comments (11)

Posted in Code on 27th May 2008, 8:29 am by Stuart

John Gruber recently published a perl script to convert strings into title case avoiding capitalizing small words based on rules from the New York Times Manual of style as well as catering for several special cases.

Before porting the perl script I tried out Python’s inbuilt title string method to see how well it handled text according to the various rules:

>>> test="this is zed's favorite outburst"
>>> test.title()
"This Is Zed'S Favorite Outburst"

As you can see it really can’t cope with anything remotely complicated.

I originally knocked up a direct port of the script, but I found it a tad unwieldy and so I decided on a fresh approach which processes the text after splitting the strings on whitespace characters.

Before I started both approaches I wrote test cases for all of the examples John gave in his post, and added a few of my own some based on John’s archive of posts later. This made coding a lot easier as it meant once the tests stopped failing I could stop coding. Of course with something like this there’s likely to be more cases that need to be catered for, if you have some ideas as to new test cases please add them in the comments.

The script is flexible from the point of view that you can either import it and use the function itself directly e.g:

>>> from titlecase import titlecase
>>> titlecase('a thing')
'A Thing'

You can pass a file of text to stdin:

$ ./titlecase.py  < ~/title-case-examples
Q&A With Steve Jobs: 'That's What Happens in Technology'
What Is AT&T's Problem?
Apple Deal With AT&T Falls Through 

This v That
This vs That
This v. That
This vs. That 

The SEC's Apple Probe: What You Need to Know 

'By the Way, Small Word at the Start but Within Quotes.' 

Small Word at End Is Nothing to Be Afraid of 

Starting Sub-Phrase With a Small Word: A Trick, Perhaps?
Sub-Phrase With a Small Word in Quotes: 'A Trick, Perhaps?'
Sub-Phrase With a Small Word in Quotes: "A Trick, Perhaps?" 

"Nothing to Be Afraid Of?"
"Nothing to Be Afraid Of?" 

A Thing 

2lmc Spool: 'Gruber on OmniFocus and Vapo(u)rware'

Finally running the script from the command line without args results in the tests being run:

$ ./titlecase.py
Testing: a thing ... ok
Testing: Apple Deal With AT&T Falls Through ... ok
Testing: The SEC's Apple Probe: What You Need to Know ... ok
Testing: What Is AT&T's Problem? ... ok
Testing: this is just an example.com ... ok
Testing: this is something listed on an del.icio.us ... ok
Testing: Generalissimo Francisco Franco: Still Dead; Kieren McCarthy: Still a Jackass ... ok
Testing: iTunes should be unmolested ... ok
Testing: "Nothing to Be Afraid of?" ... ok
Testing: "Nothing to Be Afraid Of?" ... ok
Testing: Q&A With Steve Jobs: 'That's What Happens In ... ok
Testing: Seriously, ‘Repair Permissions’ Is Voodoo ... ok
Testing: Sub-Phrase With a Small Word in Quotes: "a Trick, ... ok
Testing: Small word at end is nothing to be afraid of ... ok
Testing: 'by the Way, small word at the start but within ... ok
Testing: Sub-Phrase With a Small Word in Quotes: 'a Trick, ... ok
Testing: Starting Sub-Phrase With a Small Word: a Trick, ... ok
Testing: this v that ... ok
Testing: this v. that ... ok
Testing: this vs that ... ok
Testing: this vs. that ... ok
Testing: Reading Between the Lines of Steve Jobs’s ‘Thoughts on ... ok
Testing: 2lmc Spool: 'Gruber on OmniFocus and Vapo(u)rware' ... ok

----------------------------------------------------------------------
Ran 23 tests in 0.019s

To get the code check it out with bzr with the command:

bzr branch lp:titlecase.py

OR:

easy_install titlecase

Or download it from here: https://launchpad.net/titlecase.py/trunk/0.2

Post Tools

Comments: Add yours

1. On August 15th, 2008 at 1:30 am ≈ Relations › links for 2008-08-14 said:

[...] Titlecase.py: Titlecase in python by Stuart Colville John Gruber recently published a perl script to convert strings into title case avoiding capitalizing small words based on rules from the New York Times Manual of style as well as catering for several special cases. (tags: software opensource python titlecase) [...]

2. On August 16th, 2008 at 2:57 am Tom Watson said:

Very cool! Do you know of a Django filter version of this script anywhere?

3. On October 30th, 2008 at 2:47 am James said:

I’m somewhat of a novice but I seem to observe that the tests pass because the inputs are already in title case. If i add text=text.lower() at the start of the function the test cases fail.

4. On October 30th, 2008 at 9:31 am Stuart Colville said:

@James: It’s not quite that simple as lowering all of the text at input is likely to break quite a lot of tests as some of the functionality takes into account the case of the input.

However you do have a point that a few of the test cases had the same input as the expected output and in the process of addressing that I found a small bug where a special quote was missing from the punct regex.

I’ve updated the tests, cleaned up the code and released it as version 0.2.

https://launchpad.net/titlecase.py/trunk/0.2

Thanks for your comment — it was definitely a worthwile observation!

5. On November 7th, 2008 at 5:50 pm Ben Spaulding said:

@Tom Watson: Have a look at Christian MettsTypogrify library. He recently added support for Titlecase.py.

6. On July 1st, 2009 at 8:45 pm Todd E. Bryant said:

Sweet! I’ve been looking for this…

Two questions: (1) If I pass in unicode strings, is any damage done to the unicode characters? (2) Is titling logic applied to the unicode characters where capitalization makes sense?

7. On July 20th, 2009 at 4:04 pm nerkles said:

Please put this in the cheese shop.

8. On July 24th, 2009 at 12:26 am Stuart Colville said:

@nerkles: Done – you can now get it from the cheese shop with:

easy_install titlecase

9. On September 9th, 2009 at 8:48 am Tony Williams said:

Stuart,

You might want to add my name is o'brien to you test, since at the moment it’s a fail :-)

// Tony

10. On October 13th, 2009 at 5:02 am Diederik said:

Hi!

handy util! i was wondering, would it be possible to add support for cases like WASHINGTON D.C.?

the script has come very handy so far!
best,
Diederik

11. On December 11th, 2009 at 1:41 am brian said:

Seems like this script is missing things like 34Th Street (capitalizing the T)







XHTML: You can use these tags: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <strike> <strong>



Using Loggerhead with mod_wsgi|(0)

Here’s a post I wrote over on the Project Fondue Blog about our use of Loggerhead with mod_wsgi under Apache. Loggerhead is the rather nice branch viewer for bazaar branches as used on Launchpad.net.

If you’re not already subscribed to the Project Fondue blog feed then I can recommend it, as there should be some interesting posts coming out of there in the coming months (yes I’m unashamedly biased!).

Ubuntu: Turn off changing workspace with mouse wheel|(1)

I found the changing with the workspace with the mouse wheel really annoying. To disable it go to System => Preferences => CompizConfig (available if the compizconfig-settings-manager package is installed) and uncheck “Viewport Switcher” which is under the “Desktop” heading.

Photos on Flickr

© Copyright 2004-10 Stuart Colville, all rights reserved. May contain traces of Muffin. Powered by WordPress. Hosting by Slicehost.com This page was baked in 0.600s.