1
============================
2
Guidelines for modifying bzr
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)
13
* New functionality should have test cases. Preferably write the
14
test before writing the code.
16
In general, you can test at either the command-line level or the
17
internal API level. See Writing Tests below for more detail.
19
* Try to practice Test-Driven Development. before fixing a bug, write a
20
test case so that it does not regress. Similarly for adding a new
21
feature: write a test case for a small version of the new feature before
22
starting on the code itself. Check the test fails on the old code, then
23
add the feature or fix and check it passes.
25
* Exceptions should be defined inside bzrlib.errors, so that we can
26
see the whole tree at a glance.
28
* Imports should be done at the top-level of the file, unless there is
29
a strong reason to have them lazily loaded when a particular
30
function runs. Import statements have a cost, so try to make sure
31
they don't run inside hot functions.
33
* Module names should always be given fully-qualified,
34
i.e. ``bzrlib.hashcache`` not just ``hashcache``.
36
* Commands should return non-zero when they encounter circumstances that
37
the user should really pay attention to - which includes trivial shell
40
Recommended values are
42
1- Conflicts in merge-like operations, or changes are present in
44
2- Unrepresentable diff changes (i.e. binary files that we cannot show
46
3- An error or exception has occurred.
51
We have a commitment to 6 months API stability - any supported symbol in a
52
release of bzr MUST NOT be altered in any way that would result in
53
breaking existing code that uses it. That means that method names,
54
parameter ordering, parameter names, variable and attribute names etc must
55
not be changed without leaving a 'deprecated forwarder' behind. This even
56
applies to modules and classes.
58
If you wish to change the behaviour of a supported API in an incompatible
59
way, you need to change its name as well. For instance, if I add a optional keyword
60
parameter to branch.commit - that's fine. On the other hand, if I add a
61
keyword parameter to branch.commit which is a *required* transaction
62
object, I should rename the API - i.e. to 'branch.commit_transaction'.
64
When renaming such supported API's, be sure to leave a deprecated_method (or
65
_function or ...) behind which forwards to the new API. See the
66
bzrlib.symbol_versioning module for decorators that take care of the
67
details for you - such as updating the docstring, and issuing a warning
68
when the old api is used.
70
For unsupported API's, it does not hurt to follow this discipline, but its
71
not required. Minimally though, please try to rename things so that
72
callers will at least get an AttributeError rather than weird results.
75
Standard parameter types
76
------------------------
78
There are some common requirements in the library: some parameters need to be
79
unicode safe, some need byte strings, and so on. At the moment we have
80
only codified one specific pattern: Parameters that need to be unicode
81
should be check via 'bzrlib.osutils.safe_unicode'. This will coerce the
82
input into unicode in a consistent fashion, allowing trivial strings to be
83
used for programmer convenience, but not performing unpredictably in the
84
presence of different locales.
89
If you change the behaviour of a command, please update its docstring
90
in bzrlib/commands.py. This is displayed by the 'bzr help' command.
95
If you make a user-visible change, please add a note to the NEWS file.
96
The description should be written to make sense to someone who's just
97
a user of bzr, not a developer: new functions or classes shouldn't be
98
mentioned, but new commands, changes in behaviour or fixed nontrivial
99
bugs should be listed. See the existing entries for an idea of what
102
Within each release, entries in the news file should have the most
103
user-visible changes first. So the order should be approximately:
105
* changes to existing behaviour - the highest priority because the
106
user's existing knowledge is incorrect
107
* new features - should be brought to their attention
108
* bug fixes - may be of interest if the bug was affecting them, and
109
should include the bug number if any
110
* major documentation changes
111
* changes to internal interfaces
113
People who made significant contributions to each change are listed in
114
parenthesis. This can include reporting bugs (particularly with good
115
details or reproduction recipes), submitting patches, etc.
120
Functions, methods, classes and modules should have docstrings
121
describing how they are used.
123
The first line of the docstring should be a self-contained sentence.
125
For the special case of Command classes, this acts as the user-visible
126
documentation shown by the help command.
128
The docstrings should be formatted as reStructuredText_ (like this
129
document), suitable for processing using the epydoc_ tool into HTML
132
.. _reStructuredText: http://docutils.sourceforge.net/rst.html
133
.. _epydoc: http://epydoc.sourceforge.net/
140
Please write PEP-8__ compliant code.
142
One often-missed requirement is that the first line of docstrings
143
should be a self-contained one-sentence summary.
145
__ http://www.python.org/peps/pep-0008.html
152
Functions, methods or members that are in some sense "private" are given
153
a leading underscore prefix. This is just a hint that code outside the
154
implementation should probably not use that interface.
156
We prefer class names to be concatenated capital words (``TestCase``)
157
and variables, methods and functions to be lowercase words joined by
158
underscores (``revision_id``, ``get_revision``).
160
For the purposes of naming some names are treated as single compound
161
words: "filename", "revno".
163
Consider naming classes as nouns and functions/methods as verbs.
169
``revision_id`` not ``rev_id`` or ``revid``
171
Functions that transform one thing to another should be named ``x_to_y``
172
(not ``x2y`` as occurs in some old code.)
178
Python destructors (``__del__``) work differently to those of other
179
languages. In particular, bear in mind that destructors may be called
180
immediately when the object apparently becomes unreferenced, or at some
181
later time, or possibly never at all. Therefore we have restrictions on
182
what can be done inside them.
184
0. Never use a __del__ method without asking Martin/Robert first.
186
1. Never rely on a ``__del__`` method running. If there is code that
187
must run, do it from a ``finally`` block instead.
189
2. Never ``import`` from inside a ``__del__`` method, or you may crash the
192
3. In some places we raise a warning from the destructor if the object
193
has not been cleaned up or closed. This is considered OK: the warning
194
may not catch every case but it's still useful sometimes.
200
(The strategy described here is what we want to get to, but it's not
201
consistently followed in the code at the moment.)
203
bzrlib is intended to be a generically reusable library. It shouldn't
204
write messages to stdout or stderr, because some programs that use it
205
might want to display that information through a GUI or some other
208
We can distinguish two types of output from the library:
210
1. Structured data representing the progress or result of an
211
operation. For example, for a commit command this will be a list
212
of the modified files and the finally committed revision number
215
These should be exposed either through the return code or by calls
216
to a callback parameter.
218
A special case of this is progress indicators for long-lived
219
operations, where the caller should pass a ProgressBar object.
221
2. Unstructured log/debug messages, mostly for the benefit of the
222
developers or users trying to debug problems. This should always
223
be sent through ``bzrlib.trace`` and Python ``logging``, so that
224
it can be redirected by the client.
226
The distinction between the two is a bit subjective, but in general if
227
there is any chance that a library would want to see something as
228
structured data, we should make it so.
230
The policy about how output is presented in the text-mode client
231
should be only in the command-line tool.
236
In general tests should be placed in a file named test_FOO.py where
237
FOO is the logical thing under test. That file should be placed in the
238
tests subdirectory under the package being tested.
240
For example, tests for merge3 in bzrlib belong in bzrlib/tests/test_merge3.py.
241
See bzrlib/selftest/test_sampler.py for a template test script.
243
Tests can be written for the UI or for individual areas of the library.
244
Choose whichever is appropriate: if adding a new command, or a new command
245
option, then you should be writing a UI test. If you are both adding UI
246
functionality and library functionality, you will want to write tests for
247
both the UI and the core behaviours. We call UI tests 'blackbox' tests
248
and they are found in bzrlib/tests/blackbox/*.py.
250
When writing blackbox tests please honour the following conventions:
252
1. Place the tests for the command 'name' in
253
bzrlib/tests/blackbox/test_name.py. This makes it easy for developers
254
to locate the test script for a faulty command.
256
2. Use the 'self.run_bzr("name")' utility function to invoke the command
257
rather than running bzr in a subprocess or invoking the
258
cmd_object.run() method directly. This is a lot faster than
259
subprocesses and generates the same logging output as running it in a
260
subprocess (which invoking the method directly does not).
262
3. Only test the one command in a single test script. Use the bzrlib
263
library when setting up tests and when evaluating the side-effects of
264
the command. We do this so that the library api has continual pressure
265
on it to be as functional as the command line in a simple manner, and
266
to isolate knock-on effects throughout the blackbox test suite when a
267
command changes it name or signature. Ideally only the tests for a
268
given command are affected when a given command is changed.
272
Currently, bzr selftest is used to invoke tests.
273
You can provide a pattern argument to run a subset. For example,
274
to run just the blackbox tests, run::
276
./bzr selftest -v blackbox
279
Errors and exceptions
280
=====================
282
Errors are handled through Python exceptions. They can represent user
283
errors, environmental errors or program bugs. Sometimes we can't be sure
284
at the time it's raised which case applies. See bzrlib/errors.py for
285
details on the error-handling practices.
292
Integer identifier for a revision on the main line of a branch.
293
Revision 0 is always the null revision; others are 1-based
294
indexes into the branch's revision history.
300
If you'd like to propose a change, please post to the
301
bazaar-ng@lists.canonical.com list with a patch, bzr changeset, or link to a
302
branch. Please put '[patch]' in the subject so we can pick them out, and
303
include some text explaining the change. Remember to put an update to the NEWS
304
file in your diff, if it makes any changes visible to users or plugin
305
developers. Please include a diff against mainline if you're giving a link to
308
Please indicate if you think the code is ready to merge, or if it's just a
309
draft or for discussion. If you want comments from many developers rather than
310
to be merged, you can put '[rfc]' in the subject lines.
312
Anyone is welcome to review code. There are broadly three gates for
315
* Doesn't reduce test coverage: if it adds new methods or commands,
316
there should be tests for them. There is a good test framework
317
and plenty of examples to crib from, but if you are having trouble
318
working out how to test something feel free to post a draft patch
321
* Doesn't reduce design clarity, such as by entangling objects
322
we're trying to separate. This is mostly something the more
323
experienced reviewers need to help check.
325
* Improves bugs, features, speed, or code simplicity.
327
Code that goes in should pass all three.
329
If you read a patch please reply and say so. We can use a numeric scale
330
of -1, -0, +0, +1, meaning respectively "really don't want it in current
331
form", "somewhat uncomfortable", "ok with me", and "please put it in".
332
Anyone can "vote". (It's not really voting, just a terse expression.)
334
If something gets say two +1 votes from core reviewers, and no
335
vetos, then it's OK to come in. Any of the core developers can bring it
336
into their integration branch, which I'll merge regularly. (If you do
337
so, please reply and say so.)
added
removed
HACKING
