/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to doc/python.txt

  • Committer: Robert Collins
  • Date: 2008-01-06 20:04:22 UTC
  • mto: (3221.11.1 StackableBranch)
  • mto: This revision was merged to the branch mainline in revision 3226.
  • Revision ID: robertc@robertcollins.net-20080106200422-x8yz6cxotlzltvwp
The bzrdir format registry now accepts an ``alias`` keyword to
register_metadir, used to indicate that a format name is an alias for
some other format and thus should not be reported when describing the
format. (Robert Collins)
-------------- This line and the fmllowing will be ignored --------------

modified:
  NEWS
  bzrlib/bzrdir.py
  bzrlib/info.py
  bzrlib/tests/test_bzrdir.py
  bzrlib/tests/test_info.py

=== modified file 'NEWS'
--- a/NEWS      2008-01-02 22:30:46 +0000
+++ b/NEWS      2008-01-06 20:04:15 +0000
@@ -135,6 +135,11 @@
     * Patience Diff now supports arbitrary python objects, as long as they
       support ``hash()``. (John Arbash Meinel)
 
+    * The bzrdir format registry now accepts an ``alias`` keyword to
+      register_metadir, used to indicate that a format name is an alias for
+      some other format and thus should not be reported when describing the
+      format. (Robert Collins)
+
   API BREAKS:
 
   TESTING:

=== modified file 'bzrlib/bzrdir.py'
--- a/bzrlib/bzrdir.py  2008-01-02 22:30:46 +0000
+++ b/bzrlib/bzrdir.py  2008-01-06 19:41:29 +0000
@@ -2447,12 +2447,22 @@
     e.g. BzrDirMeta1 with weave repository.  Also, it's more user-oriented.
     """
 
+    def __init__(self):
+        """Create a BzrDirFormatRegistry."""
+        self._aliases = set()
+        super(BzrDirFormatRegistry, self).__init__()
+
+    def aliases(self):
+        """Return a set of the format names which are aliases."""
+        return frozenset(self._aliases)
+
     def register_metadir(self, key,
              repository_format, help, native=True, deprecated=False,
              branch_format=None,
              tree_format=None,
              hidden=False,
-             experimental=False):
+             experimental=False,
+             alias=False):
         """Register a metadir subformat.
 
         These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
@@ -2491,10 +2501,10 @@
                 bd.repository_format = _load(repository_format)
             return bd
         self.register(key, helper, help, native, deprecated, hidden,
-            experimental)
+            experimental, alias)
 
     def register(self, key, factory, help, native=True, deprecated=False,
-                 hidden=False, experimental=False):
+                 hidden=False, experimental=False, alias=False):
         """Register a BzrDirFormat factory.
         
         The factory must be a callable that takes one parameter: the key.
@@ -2505,11 +2515,15 @@
         """
         registry.Registry.register(self, key, factory, help,
             BzrDirFormatInfo(native, deprecated, hidden, experimental))
+        if alias:
+            self._aliases.add(key)
 
     def register_lazy(self, key, module_name, member_name, help, native=True,
-                      deprecated=False, hidden=False, experimental=False):
+        deprecated=False, hidden=False, experimental=False, alias=False):
         registry.Registry.register_lazy(self, key, module_name, member_name,
             help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
+        if alias:
+            self._aliases.add(key)
 
     def set_default(self, key):
         """Set the 'default' key to be a clone of the supplied key.
@@ -2518,6 +2532,7 @@
         """
         registry.Registry.register(self, 'default', self.get(key),
             self.get_help(key), info=self.get_info(key))
+        self._aliases.add('default')
 
     def set_default_repository(self, key):
         """Set the FormatRegistry default and Repository default.
@@ -2670,6 +2685,7 @@
     tree_format='bzrlib.workingtree.WorkingTreeFormat4',
     hidden=False,
     )
+# The following two formats should always just be aliases.
 format_registry.register_metadir('development',
     'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment0',
     help='Current development format. Can convert data to and from pack-0.92 '
@@ -2681,6 +2697,7 @@
     branch_format='bzrlib.branch.BzrBranchFormat6',
     tree_format='bzrlib.workingtree.WorkingTreeFormat4',
     experimental=True,
+    alias=True,
     )
 format_registry.register_metadir('development-subtree',
     'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment0Subtree',
@@ -2693,7 +2710,9 @@
     branch_format='bzrlib.branch.BzrBranchFormat6',
     tree_format='bzrlib.workingtree.WorkingTreeFormat4',
     experimental=True,
+    alias=True,
     )
+# And the development formats which the will have aliased one of follow:
 format_registry.register_metadir('development0',
     'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment0',
     help='Trivial rename of pack-0.92 to provide a development format. '

=== modified file 'bzrlib/info.py'
--- a/bzrlib/info.py    2007-11-06 09:00:25 +0000
+++ b/bzrlib/info.py    2008-01-06 20:01:30 +0000
@@ -440,7 +440,9 @@
         tree.bzrdir.root_transport.base):
         branch = None
         repository = None
-    for key in bzrdir.format_registry.keys():
+    non_aliases = set(bzrdir.format_registry.keys())
+    non_aliases.difference_update(bzrdir.format_registry.aliases())
+    for key in non_aliases:
         format = bzrdir.format_registry.make_bzrdir(key)
         if isinstance(format, bzrdir.BzrDirMetaFormat1):
             if (tree and format.workingtree_format !=
@@ -457,11 +459,12 @@
         candidates.append(key)
     if len(candidates) == 0:
         return 'unnamed'
-    new_candidates = [c for c in candidates if c != 'default']
-    if len(new_candidates) > 0:
-        candidates = new_candidates
+    candidates.sort()
     new_candidates = [c for c in candidates if not
         bzrdir.format_registry.get_info(c).hidden]
     if len(new_candidates) > 0:
+        # If there are any non-hidden formats that match, only return those to
+        # avoid listing hidden formats except when only a hidden format will
+        # do.
         candidates = new_candidates
     return ' or '.join(candidates)

=== modified file 'bzrlib/tests/test_bzrdir.py'
--- a/bzrlib/tests/test_bzrdir.py       2007-12-21 20:32:22 +0000
+++ b/bzrlib/tests/test_bzrdir.py       2008-01-06 19:45:00 +0000
@@ -170,6 +170,16 @@
         finally:
             bzrdir.format_registry.set_default_repository(old_default)
 
+    def test_aliases(self):
+        a_registry = bzrdir.BzrDirFormatRegistry()
+        a_registry.register('weave', bzrdir.BzrDirFormat6,
+            'Pre-0.8 format.  Slower and does not support checkouts or shared'
+            ' repositories', deprecated=True)
+        a_registry.register('weavealias', bzrdir.BzrDirFormat6,
+            'Pre-0.8 format.  Slower and does not support checkouts or shared'
+            ' repositories', deprecated=True, alias=True)
+        self.assertEqual(frozenset(['weavealias']), a_registry.aliases())
+    
 
 class SampleBranch(bzrlib.branch.Branch):
     """A dummy branch for guess what, dummy use."""

=== modified file 'bzrlib/tests/test_info.py'
--- a/bzrlib/tests/test_info.py 2007-11-26 13:55:51 +0000
+++ b/bzrlib/tests/test_info.py 2008-01-06 20:02:10 +0000
@@ -126,16 +126,22 @@
 
     def test_describe_tree_format(self):
         for key in bzrdir.format_registry.keys():
-            if key == 'default':
+            if key in bzrdir.format_registry.aliases():
                 continue
             self.assertTreeDescription(key)
 
     def test_describe_checkout_format(self):
         for key in bzrdir.format_registry.keys():
-            if key in ('default', 'weave', 'experimental'):
-                continue
-            if key.startswith('experimental-'):
-                # these are typically hidden or aliases for other formats
+            if key in bzrdir.format_registry.aliases():
+                # Aliases will not describe correctly in the UI because the
+                # real format is found.
+                continue
+            # legacy: weave does not support checkouts
+            if key == 'weave':
+                continue
+            if bzrdir.format_registry.get_info(key).experimental:
+                # We don't require that experimental formats support checkouts
+                # or describe correctly in the UI.
                 continue
             expected = None
             if key in ('dirstate', 'dirstate-tags', 'dirstate-with-subtree',
@@ -149,7 +155,7 @@
 
     def test_describe_branch_format(self):
         for key in bzrdir.format_registry.keys():
-            if key == 'default':
+            if key in bzrdir.format_registry.aliases():
                 continue
             expected = None
             if key in ('dirstate', 'knit'):
@@ -158,7 +164,7 @@
 
     def test_describe_repo_format(self):
         for key in bzrdir.format_registry.keys():
-            if key == 'default':
+            if key in bzrdir.format_registry.aliases():
                 continue
             expected = None
             if key in ('dirstate', 'knit', 'dirstate-tags'):

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/python.txt
1
 
Choice of Python
2
 
----------------
3
 
 
4
 
This will be written in Python, at least for the first cut, just for
5
 
ease of development -- I think I am at least 2-3 times faster than in
6
 
C or C++, and bugs may be less severe.  I am open to the idea of
7
 
switching to C at some time in the future, but because that is
8
 
enormously expensive I want to avoid it until it's clearly necessary.
9
 
Python is also a good platform to handle cross-platform portability.
10
 
 
11
 
Possible reasons to go to C:
12
 
 
13
 
Audience acceptance
14
 
  If Linus says "I'd use it if it were written in
15
 
  C" that would be persuasive.  I think the good developers we want to
16
 
  do not consider implementation language as a dominant factor.  A few
17
 
  related but separate questions are important to them: modest
18
 
  dependencies, easy installation, presence in distributions (or as
19
 
  packages), active support, etc.  A few queries show that Python is
20
 
  seen as relatively safe and acceptable even by people who don't
21
 
  actually use it.
22
 
 
23
 
Speed
24
 
  Having scalable designs is much more important.
25
 
  Secondly, we will do most of the heavy lifting in external
26
 
  C programs in the first cut, and perhaps move these into native
27
 
  libraries later.  (Subversion people had trouble in relying on GNU
28
 
  diff on legacy platforms and they had to integrate the code eventually.)
29
 
 
30
 
Bindings to other languages
31
 
  If we have only a Python interpretation then it can be run as a
32
 
  shell script from emacs or similar tools.  It can also be natively
33
 
  called from Python scripts, which would allow GUI bindings to almost
34
 
  every toolkit, and it can possibly be called from Java and
35
 
  .NET/Mono.    By the time this is
36
 
  mature, it's possible that Python code will be able to cross-call
37
 
  Perl and other languages through Parrot.  
38
 
  There should be enough options there to support a good
39
 
  infrastructure there of additional tools.
40
 
  If it was necessary to provide a C API that can perhaps be wrapped around a 
41
 
  Python library.
42
 
 
43
 
Reuse of tla code
44
 
  That may be useful, if there are substantial sections that approach
45
 
  or meet our goals for both design and implementation (e.g. being
46
 
  good to use from a library.)
47
 
 
48
 
  This does not necessarily mean doing the whole thing in C; we could
49
 
  call out to tla or could wrap particular bits into libraries.
50
 
 
51
 
 
52
 
----
53
 
 
54
 
Erik B�gfors:
55
 
 
56
 
  However, I think it's very important that a VCS can be wrapped in other
57
 
  languages so that it can be integrated in IDE's and have tools written
58
 
  for them.
59
 
  
60
 
  A library written in c would be simple to wrap in other languages and
61
 
  therefore could be used from for example monodevelop and friends. I
62
 
  really believe this is important for a VCS.
63
 
 
64
 
I agree; this is a more important argument against Python than speed,
65
 
where I think we can be entirely adequate just using smart design.
66
 
But there are some partial answers:
67
 
 
68
 
We can design bzr to be easily called as an external process -- not
69
 
depending on interactive input, having systematically parsed output,
70
 
--format=xml output, etc.  This is the only mode CVS supports, and
71
 
people have built many interesting tools on top of it, and it's still
72
 
popular for svn and tla.  For things like editor integration this is
73
 
often the easiest way.
74
 
 
75
 
Secondly, there is a good chance of calling into Python from other
76
 
languages.  There are projects like Jython, IronPython, Parrot and so
77
 
on that may well fix this.
78
 
 
79
 
Thirdly, we can present a Python library through a C interface; this
80
 
might seem a bit weird but I think it will work fine.  Python is
81
 
easily embeddable; this might be the best way for Windows IDE
82
 
integration.
83
 
 
84
 
Finally, if none of these work, then we can always recode in C,
85
 
treating Python only as a prototype.
86
 
 
87
 
I think working in Python I can develop it at least twice as fast as
88
 
in C, particularly in this early phase where the design is still being
89
 
worked out.  Although all other things being equal it might be nice to
90
 
be in pure C, but I don't think it's worth paying that price.
91
 
 
92
 
  One of the problems with darcs is that it's such a mess wrapping it.
93
 
 
94
 
Yes.
95
 
 
96
 
----
97
 
 
98
 
Experiments to date on large trees show that even with little
99
 
optimization, bzr is mostly disk-bound, and the CPU time usage is only
100
 
a few seconds.  That supports the position that Python performance
101
 
will be adequate.