Book Image

Modular Programming with Python

By : Erik Westra
Book Image

Modular Programming with Python

By: Erik Westra

Overview of this book

Python has evolved over the years and has become the primary choice of developers in various fields. The purpose of this book is to help readers develop readable, reliable, and maintainable programs in Python. Starting with an introduction to the concept of modules and packages, this book shows how you can use these building blocks to organize a complex program into logical parts and make sure those parts are working correctly together. Using clearly written, real-world examples, this book demonstrates how you can use modular techniques to build better programs. A number of common modular programming patterns are covered, including divide-and-conquer, abstraction, encapsulation, wrappers and extensibility. You will also learn how to test your modules and packages, how to prepare your code for sharing with other people, and how to publish your modules and packages on GitHub and the Python Package Index so that other people can use them. Finally, you will learn how to use modular design techniques to be a more effective programmer.
Table of Contents (16 chapters)
Modular Programming with Python
Credits
About the Author
About the Reviewer
www.PacktPub.com
Preface
Index

What makes a good reusable module?


In the previous section, we looked at the minimum requirements for a reusable module. Let's now examine the ideal requirements for reusability. What would a perfect reusable module look like?

There are three things that distinguish an excellent reusable module from a poor one:

  • It attempts to solve a general problem (or range of problems), rather than just performing a specific task

  • It follows standard conventions that make it easier to use the module elsewhere

  • The module is clearly documented so that other people can easily understand and use it

Let's take a closer look at each of these points.

Solving a general problem

Often when you are programming, you will find that you need a specific task performed, and so you write a function to perform this task. For example, consider the following:

  • You need to convert from inches into centimeters, so you write an inch_to_cm() function to perform this task.

  • You need to read a list of place names from a text file, which uses...