Book Image

Test-Driven Python Development

By : Siddharta Govindaraj
Book Image

Test-Driven Python Development

By: Siddharta Govindaraj

Overview of this book

This book starts with a look at the test-driven development process, and how it is different from the traditional way of writing code. All the concepts are presented in the context of a real application that is developed in a step-by-step manner over the course of the book. While exploring the common types of smelly code, we will go back into our example project and clean up the smells that we find. Additionally, we will use mocking to implement the parts of our example project that depend on other systems. Towards the end of the book, we'll take a look at the most common patterns and anti-patterns associated with test-driven development, including integration of test results into the development process.
Table of Contents (20 chapters)
Test-Driven Python Development
Credits
About the Author
Acknowledgments
About the Reviewers
www.PacktPub.com
Preface
Index

Our first doctest


The following is the current version of the price method in the Stock class:

    def price(self):
        try:
            return self.history[-1].value
        except IndexError:
            return None

Now, in the docstring, we add an example of how this method might be used. The examples are basically a copy-paste of a Python interactive shell. Hence, the lines containing input to be executed are prefixed with >>> prompt, and the lines without the prompt indicate output, as shown in the following:

    def price(self):
        """Returns the current price of the Stock

        >>> from datetime import datetime
        >>> stock = Stock("GOOG")
        >>> stock.update(datetime(2011, 10, 3), 10)
        >>> stock.price
        10
        """
        try:
            return self.history[-1].value
        except IndexError:
            return None

Now that we have the docstring, we need a way to execute it. Add the following lines...