56
56
applies to modules and classes.
58
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
59
way, you need to change its name as well. For instance, if I add an optional keyword
60
60
parameter to branch.commit - that's fine. On the other hand, if I add a
61
61
keyword parameter to branch.commit which is a *required* transaction
62
62
object, I should rename the API - i.e. to 'branch.commit_transaction'.
67
67
details for you - such as updating the docstring, and issuing a warning
68
68
when the old api is used.
70
For unsupported API's, it does not hurt to follow this discipline, but its
70
For unsupported API's, it does not hurt to follow this discipline, but it's
71
71
not required. Minimally though, please try to rename things so that
72
72
callers will at least get an AttributeError rather than weird results.
78
78
There are some common requirements in the library: some parameters need to be
79
79
unicode safe, some need byte strings, and so on. At the moment we have
80
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
81
should be checked via ``bzrlib.osutils.safe_unicode``. This will coerce the
82
82
input into unicode in a consistent fashion, allowing trivial strings to be
83
83
used for programmer convenience, but not performing unpredictably in the
84
84
presence of different locales.
90
The copyright policy for bzr was recently made clear in this email (edited
91
for grammatical correctness)::
93
The attached patch cleans up the copyright and license statements in
94
the bzr source. It also adds tests to help us remember to add them
95
with the correct text.
97
We had the problem that lots of our files were "Copyright Canonical
98
Development Ltd" which is not a real company, and some other variations
99
on this theme. Also, some files were missing the GPL statements.
101
I want to be clear about the intent of this patch, since copyright can
102
be a little controversial.
104
1) The big motivation for this is not to shut out the community, but
105
just to clean up all of the invalid copyright statements.
107
2) It has been the general policy for bzr that we want a single
108
copyright holder for all of the core code. This is following the model
109
set by the FSF, which makes it easier to update the code to a new
110
license in case problems are encountered. (For example, if we want to
111
upgrade the project universally to GPL v3 it is much simpler if there is
112
a single copyright holder). It also makes it clearer if copyright is
113
ever debated, there is a single holder, which makes it easier to defend
114
in court, etc. (I think the FSF position is that if you assign them
115
copyright, they can defend it in court rather than you needing to, and
116
I'm sure Canonical would do the same).
117
As such, Canonical has requested copyright assignments from all of the
120
3) If someone wants to add code and not attribute it to Canonical, there
121
is a specific list of files that are excluded from this check. And the
122
test failure indicates where that is, and how to update it.
124
4) If anyone feels that I changed a copyright statement incorrectly, just
125
let me know, and I'll be happy to correct it. Whenever you have large
126
mechanical changes like this, it is possible to make some mistakes.
128
Just to reiterate, this is a community project, and it is meant to stay
129
that way. Core bzr code is copyright Canonical for legal reasons, and
130
the tests are just there to help us maintain that.
227
286
from bzrlib import (
289
revision as _mod_revision,
232
291
import bzrlib.transport
233
292
import bzrlib.xml5
236
295
At this point, all of these exist as a ``ImportReplacer`` object, ready to
237
be imported once a member is accessed.
296
be imported once a member is accessed. Also, when importing a module into
297
the local namespace, which is likely to clash with variable names, it is
298
recommended to prefix it as ``_mod_<module>``. This makes it clean that
299
the variable is a module, and these object should be hidden anyway, since
300
they shouldn't be imported into other namespaces.
240
303
Modules versus Members
241
304
~~~~~~~~~~~~~~~~~~~~~~
243
306
While it is possible for ``lazy_import()`` to import members of a module
244
wehn using the ``from module import member`` syntax, it is recommended to
307
when using the ``from module import member`` syntax, it is recommended to
245
308
only use that syntax to load sub modules ``from module import submodule``.
246
309
This is because variables and classes can frequently be used without
247
310
needing a sub-member for example::
338
402
the command. We do this so that the library api has continual pressure
339
403
on it to be as functional as the command line in a simple manner, and
340
404
to isolate knock-on effects throughout the blackbox test suite when a
341
command changes it name or signature. Ideally only the tests for a
405
command changes its name or signature. Ideally only the tests for a
342
406
given command are affected when a given command is changed.
408
4. If you have a test which does actually require running bzr in a
409
subprocess you can use ``run_bzr_subprocess``. By default the spawned
410
process will not load plugins unless ``--allow-plugins`` is supplied.
371
440
Errors and exceptions
372
441
=====================
374
Errors are handled through Python exceptions. They can represent user
375
errors, environmental errors or program bugs. Sometimes we can't be sure
376
at the time it's raised which case applies. See bzrlib/errors.py for
377
details on the error-handling practices.
443
Errors are handled through Python exceptions.
445
We broadly classify errors as either being either internal or not,
446
depending on whether ``user_error`` is set or not. If we think it's our
447
fault, we show a backtrace, an invitation to report the bug, and possibly
448
other details. This is the default for errors that aren't specifically
449
recognized as being caused by a user error. Otherwise we show a briefer
450
message, unless -Derror was given.
452
Many errors originate as "environmental errors" which are raised by Python
453
or builtin libraries -- for example IOError. These are treated as being
454
our fault, unless they're caught in a particular tight scope where we know
455
that they indicate a user errors. For example if the repository format
456
is not found, the user probably gave the wrong path or URL. But if one of
457
the files inside the repository is not found, then it's our fault --
458
either there's a bug in bzr, or something complicated has gone wrong in
459
the environment that means one internal file was deleted.
461
Many errors are defined in ``bzrlib/errors.py`` but it's OK for new errors
462
to be added near the place where they are used.
464
Exceptions are formatted for the user by conversion to a string
465
(eventually calling their ``__str__`` method.) As a convenience the
466
``._fmt`` member can be used as a template which will be mapped to the
467
error's instance dict.
469
New exception classes should be defined when callers might want to catch
470
that exception specifically, or when it needs a substantially different
473
Exception strings should start with a capital letter and should not have a
474
final fullstop. If long, they may contain newlines to break the text.
added
removed
HACKING
