1
1
============================
2
guidelines for modifying bzr
2
Guidelines for modifying bzr
3
3
============================
7
(The current version of this document is available in the file ``HACKING``
8
in the source tree, or at http://bazaar-ng.org/hacking.html)
5
13
* New functionality should have test cases. Preferably write the
6
14
test before writing the code.
8
16
In general, you can test at either the command-line level or the
9
17
internal API level. Choose whichever is appropriate: if adding a
10
18
new command, or a new command option, then call through run_bzr().
11
It is not necessary to do both.
19
It is not necessary to do both. Tests that test the command line level
20
are appropriate for checking the UI behaves well - bug fixes and
21
core improvements should be tested closer to the code that is doing the
22
work. Command line level tests should be placed in 'blackbox.py'.
13
24
* Before fixing a bug, write a test case so that it does not regress.
20
31
function runs. Import statements have a cost, so try to make sure
21
32
they don't run inside hot functions.
23
* Please write PEP-8__ compliant code.
25
One often-missed requirement is that the first line of docstrings
26
should be a self-contained one-sentence summary.
28
__ http://www.python.org/peps/pep-0008.html
30
34
* Module names should always be given fully-qualified,
31
35
i.e. ``bzrlib.hashcache`` not just ``hashcache``.
40
If you change the behaviour of an API in an incompatible way, please
41
be sure to change its name as well. For instance, if I add a keyword
42
parameter to branch.commit - that's fine. On the other hand, if I add
43
a keyword parameter to branch.commit which is a *required* transaction
44
object, I should rename the api - i.e. to 'branch.commit_transaction'.
46
This will prevent users of the old api getting surprising results.
47
Instead, they will get an Attribute error as the api is missing, and
48
will know to update their code. If in doubt, just ask on #bzr.
67
Functions, methods, classes and modules should have docstrings
68
describing how they are used.
70
The first line of the docstring should be a self-contained sentence.
72
For the special case of Command classes, this acts as the user-visible
73
documentation shown by the help command.
75
The docstrings should be formatted as reStructuredText_ (like this
76
document), suitable for processing using the epydoc_ tool into HTML
79
.. _reStructuredText: http://docutils.sourceforge.net/rst.html
80
.. _epydoc: http://epydoc.sourceforge.net/
87
Please write PEP-8__ compliant code.
89
One often-missed requirement is that the first line of docstrings
90
should be a self-contained one-sentence summary.
92
__ http://www.python.org/peps/pep-0008.html
99
Functions, methods or members that are in some sense "private" are given
100
a leading underscore prefix. This is just a hint that code outside the
101
implementation should probably not use that interface.
103
We prefer class names to be concatenated capital words (``TestCase``)
104
and variables, methods and functions to be lowercase words joined by
105
underscores (``revision_id``, ``get_revision``).
107
For the purposes of naming some names are treated as single compound
108
words: "filename", "revno".
110
Consider naming classes as nouns and functions/methods as verbs.
116
``revision_id`` not ``rev_id`` or ``revid``
118
Functions that transform one thing to another should be named ``x_to_y``
119
(not ``x2y`` as occurs in some old code.)
83
155
The policy about how output is presented in the text-mode client
84
156
should be only in the command-line tool.
88
In general tests should be placed in a file named test_FOO.py where
161
In general tests should be placed in a file named testFOO.py where
89
162
FOO is the logical thing under test. That file should be placed in the
90
163
tests subdirectory under the package being tested.
92
For example, tests for merge3 in bzrlib belong in bzrlib/tests/test_merge3.py.
165
For example, tests for merge3 in bzrlib belong in bzrlib/tests/testmerge3.py.
166
See bzrlib/selftest/testsampler.py for a template test script.
96
171
Currently, bzr selftest is used to invoke tests.
97
172
You can provide a pattern argument to run a subset. For example,
98
to run just the whitebox tests, run bzr selftest --pattern .*whitebox.*
173
to run just the whitebox tests, run::
175
bzr selftest -v whitebox
178
Errors and exceptions
179
=====================
188
Integer identifier for a revision on the main line of a branch.
189
Revision 0 is always the null revision; others are 1-based
190
indexes into the branch's revision history.
added
removed
HACKING
