Writing Perl Modules for CPAN

chromatic writes with the review below of Writing Perl Modules for CPAN, which explains at a level "between novice and intermediate user" (and in a minimum of space) how to contribute to Perl's own Library of Alexandria. Writing Perl Modules for CPAN author Sam Tregar pages 288 publisher Apress rating Recommended. reviewer chromatic ISBN 159059018X summary A guide to the use and production of Perl modules, from start to finish, in C and in Perl. The Scoop

Besides Perl's abilities as a rapid development language, it's widely believed that the CPAN is its most valuable feature. This network of freely distributable code allows competent developers to achieve great heights of productivity, reusing the work of a generous community of programmers.

Of course, just as some will argue that Perl's copious documentation (spread over two thousand pages) is not immediately obvious to beginners, neither is how to use and even to contribute to the CPAN. For every coder who's successfully published a module, how many more would jump at the chance? How many registered CPAN authors would like to improve their skills?

With that audience in mind, Sam Tregar's Writing Perl Modules for CPAN plants itself firmly in the gap between novice and intermediate user. While much of the book presents information present in a multitude of FAQs, manpages, and the bittersweet experiences of those of us who did things the hard way, he's collected much knowledge into a short and readable guide.

What's to Like?

Tregar starts by describing the history and usage of the CPAN itself. This includes the three most popular approaches to building modules: through the CPAN shell (including its configuration), by hand, and with ActiveState's PPM tool. Next, he explains module development in forty pages. This is pretty dense stuff for the intended audience and might require several passes by newer coders. Only after re-reviewing the chapter for this summary did I realize how much he covered. The next chapter covers design and style, from naming schemes to appropriate laziness through code reuse. It's more philosophical and more important.

The next two chapters cover bundling and submitting modules to the CPAN, as well as being a good author and maintainer. The general tone is quite similar to the impressive Open Source Development with CVS. While manpages usually describe the mechanics of making a distribution, for example, they rarely explain the reasons why things are done that way. As with previous chapters, several code examples illustrate the concepts under discussion.

After a brief chapter discussing a few very effective CPAN modules, Tregar dives into XS (the interface between Perl and C). In 60 pages, he describes just enough of XS and the Perl API to teach careful programmers how to be effective at extending Perl. This introduction compares favorably to the first few chapters of the new (and excellent) Extending and Embedding Perl. As expected in an overview, he provides links to more information. The writing and example style is clear enough that a decent coder with sufficient C knowledge should be able to write a Perl wrapper to a C library with relative ease.

The last two chapters describe Inline::C, an abstraction layer that makes XS much easier, and CGI::ApplicationC, a state machine framework for Perl CGI applications. It's not quite clear why the last chapter was included (besides Tregar's desire to see more CPAN modules extending CGI::Application), but it serves as an example of using and extending a CPAN module. Perhaps a future version of the book will elaborate further.

What's to Consider

The book's code samples are generally good. In the first half, they are all related parts of a larger project. The rest of the book moves away from this approach. Perhaps it would have been worthwhile to continue the theme, though the nature of the material makes it difficult to see exactly how to accomplish this.

Tregar also avoids the use of strictures and warnings in his code examples, claiming that they would make the examples too verbose. I disagree with the given reasoning -- teaching is the best time to enforce good habits, especially when encouraging the students to distribute their code to the world. This is a minor issue, though, as the code is readable and reasonable.

In the past few months, two projects have gained a great deal of momentum in Perl space. These are the CPANPLUS (disclaimer: I am contributing to this project and have contributed to CPAN.pm) and Module::Build. They may become the new standards, replacing CPAN.pm and MakeMaker as early as Perl 5.10. The book omits mention of these. This is understandable, given the time frame -- and the current tools will not be disappearing any time soon. Potential replacements for h2xs are described in a sidebar, though.

The Summary

This is a readable book. It took only a couple of hours to read (though I'm assuredly not the target audience), and is well packed with good advice. Fresher Perl programmers who aren't yet comfortable enough with packages and interfaces will get the most benefit, but there's plenty of information for intermediate hackers as well.

Table of Contents

1. CPAN
2. Perl Module Basics
3. Module Design and Implementation
4. CPAN Module Distribution
5. Submitting Your Module to CPAN
6. Module Maintenance
7. Great CPAN Modules
8. Programming Perl in C
9. Writing C Modules with XS
10. Writing C Modules with Inline::C
11. CGI Application Modules for CPAN

You can purchase Writing Perl Modules for CPAN from bn.com. Slashdot welcomes readers' book reviews -- to see your own review here, read the book review guidelines, then visit the submission page.

Comments

Will Apocalypse change Perl enough to hurt CPAN?

[Anonymous Coward]

Considering that the upcoming version of Perl will supposedly not be 100% backwards compatible with Perl 5, what happens to CPAN? Will it be ported en masse to Perl 5, or left the way it is as programmers embark on a new CPAN?

Test!

[PissingInTheWind]

If you don't know where to start, the best thing is to test and debug existing modules! It's the fastest way to get started on your way to Perl stardom.

See chromatic's How You (Yes You!) Can Get Involved.

The hardest part

[Ed Avis]

The most difficult part of writing a module for CPAN is getting past the bureaucracy: there are at least two different documents giving different instructions on how to submit modules, and the modules@perl.org mailing list is notorious for never replying to any messages sent to it, especially not those asking for help or 'what went wrong?'. It's not like registering a project on Sourceforge or Freshmeat; you have to send mail to register a namespace, then do an ftp upload and then send mail to have your upload 'noticed'. Sounds reasonable enough, except that it is easy to go wrong or fail to jump through a particular hoop, and if that happens you get no feedback at all. I'm sure the CPAN maintainers are busy and hard-working, but the current situation shows there are cases where an automated system (which at least gives error messages when stuff goes wrong) is better than manual administration.

Myself, I have managed to put modules on CPAN, after a few months of wondering why they didn't appear in the main listing. (It turned out I had forgotten to send an updated module list entry; my fault, but still it would have been friendlier for somebody to answer my question about what I did wrong rather than just ignore it.) But uploading newer versions of the same modules has sometimes been troublesome, with the update appearing in my home directory but not the main listing: again, any request for help or guidance on what part of the process I was doing wrong was studiously ignored.

Despite the troublesome upload procedure, CPAN is Perl's biggest asset and other language communities would do well to copy it (as some are). But please don't copy the management system; have some more structured way to submit code where it's clearer what to do at each stage, and there can be warning messages if you do something wrong, rather than just quietly failing to work.

Inline rules!

[Coppit]

Let me just say, in case you haven't heard it before, Inline kicks major ass. It allows you to seamlessly integrate C, Java, C++, Python, etc. into Perl modules. When you run the usual

perl Makefile.PL
make
make install

sequence, Inline automatically calls the compiler and linker for your C/etc code, and creates the right glue code between your Perl and C/etc code. For a simple example, see the C mailbox parser which comes with <shameless plug>grepmail</shameless plug>.

By the way, recent improvements to the Perl implementation mean that my Perl mailbox parser is now less than 5% slower than the C implementation. Just one data point for those of you who say Perl can't be fast. ;)