~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to HACKING

  • Committer: Robert Collins
  • Date: 2006-05-24 08:14:45 UTC
  • mfrom: (1725.1.1 benchmark)
  • mto: (1725.2.6 commit)
  • mto: This revision was merged to the branch mainline in revision 1729.
  • Revision ID: robertc@robertcollins.net-20060524081445-c046b4406ffc8dfa
(rbc)Merge in benchmark --lsprof-timed lsprofiling feature. (Robert Collins, Martin Pool).

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
============================
 
2
Guidelines for modifying bzr
 
3
============================
 
4
 
 
5
.. contents::
 
6
 
 
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)
 
9
 
 
10
Overall
 
11
=======
 
12
 
 
13
* New functionality should have test cases.  Preferably write the
 
14
  test before writing the code.
 
15
 
 
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.
 
18
 
 
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.
 
24
 
 
25
* Exceptions should be defined inside bzrlib.errors, so that we can
 
26
  see the whole tree at a glance.
 
27
 
 
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.
 
32
 
 
33
* Module names should always be given fully-qualified,
 
34
  i.e. ``bzrlib.hashcache`` not just ``hashcache``.
 
35
 
 
36
* Commands should return non-zero when they encounter circumstances that
 
37
  the user should really pay attention to - which includes trivial shell
 
38
  pipelines.
 
39
 
 
40
  Recommended values are 
 
41
    0- OK, 
 
42
    1- Conflicts in merge-like operations, or changes are present in
 
43
       diff-like operations. 
 
44
    2- Unrepresentable diff changes (i.e. binary files that we cannot show 
 
45
       a diff of).
 
46
    3- An error or exception has occurred.
 
47
 
 
48
Evolving interfaces
 
49
-------------------
 
50
 
 
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.
 
57
 
 
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'. 
 
63
 
 
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.
 
69
 
 
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.
 
73
 
 
74
 
 
75
Standard parameter types
 
76
------------------------
 
77
 
 
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.
 
85
 
 
86
Documentation
 
87
=============
 
88
 
 
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.
 
91
 
 
92
NEWS file
 
93
---------
 
94
 
 
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
 
100
should be done.
 
101
 
 
102
Within each release, entries in the news file should have the most
 
103
user-visible changes first.  So the order should be approximately:
 
104
 
 
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
 
112
 
 
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.
 
116
 
 
117
API documentation
 
118
-----------------
 
119
 
 
120
Functions, methods, classes and modules should have docstrings
 
121
describing how they are used. 
 
122
 
 
123
The first line of the docstring should be a self-contained sentence.
 
124
 
 
125
For the special case of Command classes, this acts as the user-visible
 
126
documentation shown by the help command.
 
127
 
 
128
The docstrings should be formatted as reStructuredText_ (like this
 
129
document), suitable for processing using the epydoc_ tool into HTML
 
130
documentation.
 
131
 
 
132
.. _reStructuredText: http://docutils.sourceforge.net/rst.html
 
133
.. _epydoc: http://epydoc.sourceforge.net/
 
134
 
 
135
 
 
136
 
 
137
Coding style
 
138
============
 
139
 
 
140
Please write PEP-8__ compliant code.  
 
141
 
 
142
One often-missed requirement is that the first line of docstrings
 
143
should be a self-contained one-sentence summary.
 
144
 
 
145
__ http://www.python.org/peps/pep-0008.html
 
146
 
 
147
 
 
148
 
 
149
Naming
 
150
------
 
151
 
 
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.
 
155
 
 
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``).
 
159
 
 
160
For the purposes of naming some names are treated as single compound
 
161
words: "filename", "revno".
 
162
 
 
163
Consider naming classes as nouns and functions/methods as verbs.
 
164
 
 
165
 
 
166
Standard names
 
167
--------------
 
168
 
 
169
``revision_id`` not ``rev_id`` or ``revid``
 
170
 
 
171
Functions that transform one thing to another should be named ``x_to_y``
 
172
(not ``x2y`` as occurs in some old code.)
 
173
 
 
174
 
 
175
Destructors
 
176
-----------
 
177
 
 
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.
 
183
 
 
184
 0. Never use a __del__ method without asking Martin/Robert first.
 
185
 
 
186
 1. Never rely on a ``__del__`` method running.  If there is code that
 
187
    must run, do it from a ``finally`` block instead.
 
188
 
 
189
 2. Never ``import`` from inside a ``__del__`` method, or you may crash the
 
190
    interpreter!!
 
191
 
 
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.
 
195
 
 
196
 
 
197
Writing output
 
198
==============
 
199
 
 
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.)
 
202
 
 
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
 
206
mechanism.
 
207
 
 
208
We can distinguish two types of output from the library:
 
209
 
 
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
 
213
    and id.
 
214
 
 
215
    These should be exposed either through the return code or by calls
 
216
    to a callback parameter.
 
217
 
 
218
    A special case of this is progress indicators for long-lived
 
219
    operations, where the caller should pass a ProgressBar object.
 
220
 
 
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.
 
225
 
 
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.
 
229
 
 
230
The policy about how output is presented in the text-mode client
 
231
should be only in the command-line tool.
 
232
 
 
233
 
 
234
Writing tests
 
235
=============
 
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.
 
239
 
 
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.
 
242
 
 
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. 
 
249
 
 
250
When writing blackbox tests please honour the following conventions:
 
251
 
 
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.
 
255
 
 
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).
 
261
 
 
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.
 
269
 
 
270
Running tests
 
271
=============
 
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::
 
275
 
 
276
  ./bzr selftest -v blackbox
 
277
 
 
278
 
 
279
Errors and exceptions
 
280
=====================
 
281
 
 
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.
 
286
 
 
287
 
 
288
Jargon
 
289
======
 
290
 
 
291
revno
 
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.
 
295
 
 
296
 
 
297
Transport
 
298
=========
 
299
 
 
300
The ``Transport`` layer handles access to local or remote directories.
 
301
Each Transport object acts like a logical connection to a particular
 
302
directory, and it allows various operations on files within it.  You can
 
303
*clone* a transport to get a new Transport connected to a subdirectory or
 
304
parent directory.
 
305
 
 
306
Transports are not used for access to the working tree.  At present
 
307
working trees are always local and they are accessed through the regular
 
308
Python file io mechanisms.
 
309
 
 
310
filenames vs URLs
 
311
-----------------
 
312
 
 
313
Transports work in URLs.  Take note that URLs are by definition only
 
314
ASCII - the decision of how to encode a Unicode string into a URL must be
 
315
taken at a higher level, typically in the Store.  (Note that Stores also
 
316
escape filenames which cannot be safely stored on all filesystems, but
 
317
this is a different level.)
 
318
 
 
319
The main reason for this is that it's not possible to safely roundtrip a
 
320
URL into Unicode and then back into the same URL.  The URL standard
 
321
gives a way to represent non-ASCII bytes in ASCII (as %-escapes), but
 
322
doesn't say how those bytes represent non-ASCII characters.  (They're not
 
323
guaranteed to be UTF-8 -- that is common but doesn't happen everywhere.)
 
324
 
 
325
For example if the user enters the url ``http://example/%e0`` there's no
 
326
way to tell whether that character represents "latin small letter a with
 
327
grave" in iso-8859-1, or "latin small letter r with acute" in iso-8859-2
 
328
or malformed UTF-8.  So we can't convert their URL to Unicode reliably.
 
329
 
 
330
Equally problematic if we're given a url-like string containing non-ascii
 
331
characters (such as the accented a) we can't be sure how to convert that
 
332
to the correct URL, because we don't know what encoding the server expects
 
333
for those characters.  (Although this is not totally reliable we might still
 
334
accept these and assume they should be put into UTF-8.)
 
335
 
 
336
A similar edge case is that the url ``http://foo/sweet%2Fsour" contains
 
337
one directory component whose name is "sweet/sour".  The escaped slash is
 
338
not a directory separator.  If we try to convert URLs to regular Unicode
 
339
paths this information will be lost.
 
340
 
 
341
This implies that Transports must natively deal with URLs; for simplicity
 
342
they *only* deal with URLs and conversion of other strings to URLs is done
 
343
elsewhere.  Information they return, such as from ``list_dir``, is also in
 
344
the form of URL components.
 
345
 
 
346
 
 
347
Merge/review process
 
348
====================
 
349
 
 
350
If you'd like to propose a change, please post to the
 
351
bazaar-ng@lists.canonical.com list with a patch, bzr changeset, or link to a
 
352
branch.  Please put '[patch]' in the subject so we can pick them out, and
 
353
include some text explaining the change.  Remember to put an update to the NEWS
 
354
file in your diff, if it makes any changes visible to users or plugin
 
355
developers.  Please include a diff against mainline if you're giving a link to
 
356
a branch.
 
357
 
 
358
Please indicate if you think the code is ready to merge, or if it's just a
 
359
draft or for discussion.  If you want comments from many developers rather than
 
360
to be merged, you can put '[rfc]' in the subject lines.
 
361
 
 
362
Anyone is welcome to review code.  There are broadly three gates for
 
363
code to get in:
 
364
 
 
365
 * Doesn't reduce test coverage: if it adds new methods or commands,
 
366
   there should be tests for them.  There is a good test framework
 
367
   and plenty of examples to crib from, but if you are having trouble
 
368
   working out how to test something feel free to post a draft patch
 
369
   and ask for help.
 
370
 
 
371
 * Doesn't reduce design clarity, such as by entangling objects
 
372
   we're trying to separate.  This is mostly something the more
 
373
   experienced reviewers need to help check.
 
374
 
 
375
 * Improves bugs, features, speed, or code simplicity.
 
376
 
 
377
Code that goes in should pass all three.
 
378
 
 
379
If you read a patch please reply and say so.  We can use a numeric scale
 
380
of -1, -0, +0, +1, meaning respectively "really don't want it in current
 
381
form", "somewhat uncomfortable", "ok with me", and "please put it in".
 
382
Anyone can "vote".   (It's not really voting, just a terse expression.)
 
383
 
 
384
If something gets say two +1 votes from core reviewers, and no
 
385
vetos, then it's OK to come in.  Any of the core developers can bring it
 
386
into their integration branch, which I'll merge regularly.  (If you do
 
387
so, please reply and say so.)
 
388
 
 
389
 
 
390
:: vim:tw=74:ai