HACKING.txt

   1 =========================================
   2 D-Bus Python bindings - notes for hackers
   3 =========================================
   4
   5 :Author: Simon McVittie
   6 :Date: 2006-09-26
   7
   8 Code organisation
   9 =================
  10
  11 Python wants everything except the init function to be declared static, so the
  12 whole of _dbus_bindings is a single translation unit - module.c #includes
  13 various files *-impl.h, which define static (sometimes static inline)
  14 functions. Even so, it compiles quicker than the old Pyrex implementation :-p
  15
  16 Threading/locking model
  17 =======================
  18
  19 All Python functions must be called with the GIL (obviously).
  20
  21 Before calling into any D-Bus function that can block, release the GIL;
  22 as well as the usual "be nice to other threads", D-Bus does its own
  23 locking and we don't want to deadlock with it. Most Connection methods
  24 can block.
  25
  26 Indentation and other holy wars
  27 ===============================
  28
  29 Python code is meant to follow PEP8, and has 4-space indentation, no hard tabs.
  30
  31 C code is meant to follow what PEP7 refers to as "Python 3000" style - 4-space
  32 indentation, no hard tabs, otherwise consistent with historical Python 2.x
  33 code.
  34
  35 Docstrings etc. are reStructuredText.