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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
|
---
short-description: Writing code that looks consistent
...
# Coding Style Guide
The code must be easy to understand, so it should look consistent.
When entering the development environment, a [git pre-commit
hook](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks) is set
up on your local repo. When you create a commit, the
[hook](https://gitlab.gnome.org/GNOME/pitivi/blob/master/pre-commit.hook)
runs the `pre-commit` tool which:
- performs some [lightweight
checks](https://gitlab.gnome.org/GNOME/pitivi/blob/master/.pre-commit-config.yaml)
- runs [flake8](https://gitlab.com/pycqa/flake8) to check the code style
- runs
[pylint](https://gitlab.gnome.org/GNOME/pitivi/blob/master/pylint.rc) in
the sandbox to check for all kinds of errors.
We rely on the [Python Style Guide PEP-8](https://www.python.org/dev/peps/pep-0008/)
## Line length
When deciding whether or not you should split your line when it exceeds
79 characters, ask yourself: "Does it truly improve legibility?"
What this translates to is:
- Avoid having very long lines.
- When the contents only slightly exceeds the 80 chars limit,
consider keeping it on one line. Otherwise it just hurts legibility and
gives a weird "shape" to the code.
## Names
The function names, method names and other class attributes should be
small_caps_with_underscore. For example:
``` python
def some_function():
return ""
class MyClass:
def a_really_important_method(self):
self.do_something()
@property
def water_level(self):
"""The level of the water in meters."""
return self.__water_level
```
To illustrate how private a method or other class field is, prepend
one or two underscores:
``` python
class MyClass:
def public_method(self):
...
def _protected_method(self):
...
def __private_method(self):
...
```
Unused arguments in methods should be prefixed with `unused_`.
The most common place where this would happen is in callbacks from
gobject signals. For example, below we don't use the second argument,
but we do use `pad`.
``` python
def __pad_added_cb(self, unused_element, pad):
self.do_something_with(pad)
```
The name of a callback method should:
- be prepended with two underscores since it's private
- be appended with `cb`
``` python
class MyClass:
def some_method(self):
self.someobject.connect("event", self.__some_object_event_cb)
def __some_object_event_cb(self, object, arg):
print "our callback was called"
```
## Docstrings
We follow the [Google Python Style Guide](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings)
for docstrings.
|
