1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
|
The following standards are used in all source files:
The first two lines must be:
#!/usr/bin/env python <-- Only in files meant to be directly executed!
# -*- coding: utf-8 -*-
A blank line, then:
################################################################################
# <file name>: <description>.
# Copyright (C) 2008 <your name>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
################################################################################
Do not do "from module import *" at all.
Code Style:
* In general, follow PEP 8 (http://www.python.org/dev/peps/pep-0008/).
However, the following guidelines supplement and/or take precedence over
PEP 8.
* All indents must be *4 spaces*.
* If you use an editor that does automatic changes, don't use that editor or
change the settings. Only have changes you did or are beneficial. Don't
have confusing diffs!
* While line length should in general be limited to 80 characters, small
overages are acceptable if they improve readability. Examples (taken from
Core as it existed at the time of writing; indentation is as in original,
since it's relevant to line wrapping):
-- Code ------------------------------------------------------------------
| directory = self._restore_point_path(restore_directory=restore_directory)
------------------------------------------------------------------- End --
is more readable than
-- Code ------------------------------------------------------------------
| directory = self._restore_point_path(restore_directory=
| restore_directory)
------------------------------------------------------------------- End --
Another example:
-- Code ------------------------------------------------------------------
|# 100 characters, but easier to read
| points = [(get_name(i),get_date(i),i) for i in os.listdir(directory) if i.endswith('.srp')]
|
|# vs.:
| points = [(get_name(i),get_date(i),i) for i in os.listdir(directory)
| if i.endswith('.srp')]
------------------------------------------------------------------- End --
|