-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathSTYLE
More file actions
36 lines (24 loc) · 1.04 KB
/
STYLE
File metadata and controls
36 lines (24 loc) · 1.04 KB
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
Manifesto
---------
1. Make parts of package independent. So that when using templating system you
donot need use HTTP handlers. However some parts may rely on as few as possible
general utils (such as logging system - it's not part of standard library yet).
2. Make interchangeable modules for one problem but different implementations.
So that we can make script for plain CGI we can easy switch to mod_python -
changing the only base class for our application.
3. Do not make ready-to-use systems part of package. Their should be presented
as examples.
Naming convention
-----------------
FirstUpperMixedCase
public modules and classes
firstLowerMixedCase
public functions, methods, globals, modules used primarily as scripts
UPPER_CASE_WITH_UNDERSCORE
constants
lower_case_with_underscore
local variables (including arguments)
_first_underscore_lower_case_with_underscore
private globals and protected (useful in subclasses) class members
__first_double_underscore_lower_case_with_underscore
private (can be reused without clash) class members