CODECONVENTIONS.md 2.77 KB
Newer Older
1
2
Python code conventions
=======================
3

4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
Python code follows [PEP 8](http://legacy.python.org/dev/peps/pep-0008/).

Naming conventions:
- Module names are short and all lowercase; eg pyb, stm.
- Class names are CamelCase, with abreviations all uppercase; eg I2C, not
  I2c.
- Function and method names are all lowercase with words separated by
  a single underscore as necessary to improve readability; eg mem_read.
- Constants are all uppercase with words separated by a single underscore;
  eg GPIO_IDR.

C code conventions
==================

When writing new C code, please adhere to the following conventions.
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

White space:
- Expand tabs to 4 spaces.
- Don't leave trailing whitespace at the end of a line.
- For control blocks (if, for, while), put 1 space between the
  keyword and the opening parenthesis.
- Put 1 space after a comma, and 1 space around operators.

Braces: 
- Use braces for all blocks, even no-line and single-line pieces of
  code.
- Put opening braces on the end of the line it belongs to, not on
  a new line.
- For else-statements, put the else on the same line as the previous
  closing brace.

35
Header files:
36
37
- Header files should be protected from multiple inclusion with #if
  directives. See an existing header for naming convention.
38

39
Names:
40
- Use underscore_case, not camelCase for all names.
41
42
- Use CAPS_WITH_UNDERSCORE for enums and macros.
- When defining a type use underscore_case and put '_t' after it.
43

44
Integer types: MicroPython runs on 16, 32, and 64 bit machines, so it's
45
46
important to use the correctly-sized (and signed) integer types.  The
general guidelines are:
47
48
- For most cases use mp_int_t for signed and mp_uint_t for unsigned
  integer values.  These are guaranteed to be machine-word sized and
49
  therefore big enough to hold the value from a MicroPython small-int
50
51
52
53
54
  object.
- Use size_t for things that count bytes / sizes of objects.
- You can use int/uint, but remember that they may be 16-bits wide.
- If in doubt, use mp_int_t/mp_uint_t.

55
56
57
58
Comments:
- Be concise and only write comments for things that are not obvious.
- Use `// ` prefix, NOT `/* ... */`. No extra fluff.

59
60
61
62
Memory allocation:
- Use m_new, m_renew, m_del (and friends) to allocate and free heap memory.
  These macros are defined in py/misc.h.

63
64
65
Examples
--------

66
Braces, spaces, names and comments:
67

68
69
    #define TO_ADD (123)

70
71
    // This function will always recurse indefinitely and is only used to show
    // coding style
72
73
74
    int foo_function(int x, int some_value) {
        if (x < some_value) {
            foo(some_value, x);
75
        } else {
76
            foo(x + TO_ADD, some_value - 1);
77
78
        }

79
        for (int my_counter = 0; my_counter < x; my_counter++) {
80
81
82
83
84
85
86
87
88
        }
    }

Type declarations:

    typedef struct _my_struct_t {
        int member;
        void *data;
    } my_struct_t;