PyLucid CMS - Our used python code style

Our used python code style

Our source code style based on PEP-8.

Some points:

No Python shebang! (Only needed in the dispatcher files)
Source code encoding always utf-8 (lower)
copyleft info:

copyleft not copyright ;)
always by "the PyLucid team" (New authors should be inserted in AUTHORS file!)
you can insert author info (like "based on sourcecode by..." or "created by...") into the normal header DocString.

We use GPL v3 or above
no TABs, use only 4 spaced to indent
Lineendings

We use linux like line endings: "
n"
SVN property svn:eol-style should be set to LF

The source code header should look like this:

Python

# -*- coding: utf-8 -*-



"""
    sort Headline
    ~~~~~~~~~~~~~



    Some Info about the file.



    Last commit info:
    ~~~~~~~~~~~~~~~~~
    $LastChangedDate$
    $Rev$
    $Author:$



    :copyleft: 2008 by the PyLucid team, see AUTHORS for more details.
    :license: GNU GPL v3 or above, see LICENSE for more details.
"""


...

(Note: There exist a source highlighting bug, you see too much empty lines!)

permalink

Menu:

Our used python code style