Reading Great CodeΒΆ

One of the core tenants behind the design of Python is creating readable code. The motivation behind this design is simple: The number one thing that Python programmers do is read code.

One of the secrets of becoming a great Python programmer is to read, understand, and comprehend excellent code.

Excellent code typically follows the guidelines outlined in Code Style, and does its best to express a clear and concise intent to the reader.

Included below is a list of recommended Python projects for reading. Each one of these projects is a paragon of Python coding.

  • Howdoi Howdoi is a code search tool, written in Python.
  • Flask Flask is a microframework for Python based on Werkzeug and Jinja2. It’s intended for getting started very quickly and was developed with best intentions in mind.
  • Werkzeug Werkzeug started as simple collection of various utilities for WSGI applications and has become one of the most advanced WSGI utility modules. It includes a powerful debugger, full-featured request and response objects, HTTP utilities to handle entity tags, cache control headers, HTTP dates, cookie handling, file uploads, a powerful URL routing system and a bunch of community-contributed addon modules.
  • Requests Requests is an Apache2 Licensed HTTP library, written in Python, for human beings.
  • Tablib Tablib is a format-agnostic tabular dataset library, written in Python.

Todo

Embed and explain YouTube video showing python code reading: http://www.youtube.com/watch?v=Jc8M9-LoEuo This may require installing a Sphinx plugin. https://bitbucket.org/birkenfeld/sphinx-contrib/src/a09f29fc16970f34350ca36ac7f229e00b1b1674/youtube?at=default

Todo

Include code examples of exemplary code from each of the projects listed. Explain why it is excellent code. Use complex examples.

Todo

Explain techniques to rapidly identify data structures, algorithms and determine what the code is doing.

Python Guide.

This opinionated guide exists to provide both novice and expert Python developers a best-practice handbook to the installation, configuration, and usage of Python on a daily basis.

Get Updates

Receive updates on new releases and upcoming projects.

Subscribe to Newsletter

Donate

If you enjoy this guide, consider supporting the author on Gittip:

Related Topics

This Page

Fork me on GitHub