agos / python_koans Goto Github PK

============
Python Koans
============

Python Koans is a port of Edgecase's "Ruby Koans".

Python Koans is an interactive tutorial for learning Python by making tests pass. 

Most tests are 'fixed' by filling the missing parts of assert functions. Eg:

    self.assertEqual(__, 1+2)

which can be fixed by replacing the __ part with the appropriate code:

    self.assertEqual(3, 1+2)

Occasionally you will encounter some failing tests that are already filled out. In these cases you will need to finish implementing some code to progress. For example, there is an exercise for writing some code that will tell you if a triangle is equilateral, isosceles or scalene.

As well as being a great way to learn some Python, it is also a good way to get a taste of Test Driven Development (TDD).


Downloading Python Koans
------------------------

Python Koans is available through Mercurial on bitbucket:

    http://bitbucket.org/gregmalcolm/python_koans

It is also mirrored on github for Git users :

    http://wiki.github.com/gregmalcolm/python_koans

Either site will allow you to download the source as a zip/gz/bz2.


Installing Python Koans
-----------------------

Aside from downloading or checking out the latest version of Python Koans, all you need to install is Python.

At this time of writing there are two versions of the koans, one for use with Python 2.6 and one for Python 3.1. You should be able to work with newer Python versions, but older ones will likely give you problems. 

You can download Python from here:

    http://www.python.org/download

On installing Python make sure the folder containing the python executable is in the system path. In other words, you need to be able to be able to run Python from a command console. With Python 2 it will be called 'python' or 'python.exe' depending on the operating system. For Python 3 it will either be 'python3' or for windows it will be 'python.exe'.

If you have problems, this may help:

    http://www.python.org/about/gettingstarted


Getting Started
---------------

From a *nix terminal or windows command prompt go to the python koans\python_<b>VERSION</b> folder and run: 

    python contemplate_koans.py

or

    python3 contemplate_koans.py

In my case I'm using Python 3 with windows, so I fire up my command shell (cmd.exe) and run this:

    C:\>cd "c:\hg\python_koans\python 3"
    C:\hg\python_koans\python 3_1>python contemplate_koans.py
  
    Thinking AboutAsserts
      test_assert_truth has damaged your karma.

    You have not yet reached enlightenment ...
      AssertionError: False is not True

    Please meditate on the following code:
      File "C:\hg\python_koans\python 3\koans\about_asserts.py", line 12, in test_
    assert_truth
        self.assertTrue(False) # This should be true


    Beautiful is better than ugly.
    C:\hg\python_koans\python 3>

Apparently a test failed:

    AssertionError: False is not True

It also tells me exactly where the problem in, its an assert on line 12 of .\koans\about_asserts.py. This one is easy, just change False to True to make the test pass.

Sooner or later you will likely encounter tests where you are not sure what the expected value should be. For example:

    class Dog:
        pass

    def test_objects_are_objects(self):
        fido = self.Dog()
        self.assertEqual(__, isinstance(fido, object))

This is where the Python Command Line can come in handy. in this case I can fire up the command line, recreate the scenario and run queries:

    C:\hg\python_koans\python 3>python
    Python 3.1.2 (r312:79149, Mar 21 2010, 00:41:52) [MSC v.1500 32 bit (Intel)] on
    win32
    Type "help", "copyright", "credits" or "license" for more information.
    >>> class Dog: pass
    ...
    >>> fido = Dog()
    >>> isinstance(fido, object)
    True
    >>>

Getting the Most From the Koans
-------------------------------

Quoting the Ruby Koans instructions:

    "In test-driven development the mantra has always been, red, green, refactor. Write a failing test and run it (red), make the test pass (green), then refactor it (that is look at the code and see if you can make it any better. In this case you will need to run the koan and see it fail (red), make the test pass (green), then take a moment and reflect upon the test to see what it is teaching you and improve the code to better communicate its intent (refactor)."


Content
-------

Python is a made up of about 2/3 Ruby Koans ported material and 1/3 Python specific tests. The content ported from Ruby Koans includes all the assignment projects.

Content for Python 3 is a little different to the Python 2 flavor due to big changes between the 2 different languages. For example in the Python 2 variant the differences between old and new style classes are covered. This loses relevance in in the Python 3 version, but there are some extra tests covering new functionality.


Finding More Koan Projects
--------------------------

Right now there are a lot of spinoff Koan projects out there for a great number of languages and frameworks. Many of them do not have that much content, but contributing to them is a great way to learn. At the moment most of them can be found by searching for 'koans' on github.

A couple of promising projects include DotNetKoans and TestMongoKoans.


Acknowledgments
---------------

Thanks go to Jim Weirich and Joe O'Brien for the original Ruby Koans that Python Koans is based on! Also the Ruby Koans in turn borrows from Metakoans so thanks also go to Ara Howard for that!


Also thanks to everyone who helped with the Python Koans conversion! In particular I got a great headstart on the project by forking from this Python Koans startup project:

    http://bitbucket.org/mcrute/python_koans/