← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/__init__.py

  • Committer: Martin
  • Date: 2010-05-16 15:18:43 UTC
  • mfrom: (5235 +trunk)
  • mto: This revision was merged to the branch mainline in revision 5239.
  • Revision ID: gzlist@googlemail.com-20100516151843-lu53u7caehm3ie3i
Merge bzr.dev to resolve conflicts in NEWS and _chk_map_pyx

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/__init__.py
1
 
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
 
1
# Copyright (C) 2005-2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
31
31
    import bzrlib.lazy_regex
32
32
    bzrlib.lazy_regex.install_lazy_compile()
33
33
 
34
 
from bzrlib.osutils import get_user_encoding
35
 
 
36
34
 
37
35
IGNORE_FILENAME = ".bzrignore"
38
36
 
39
37
 
40
 
# XXX: Compatibility. This should probably be deprecated
41
 
user_encoding = get_user_encoding()
42
 
 
43
 
 
44
 
__copyright__ = "Copyright 2005, 2006, 2007, 2008, 2009 Canonical Ltd."
 
38
__copyright__ = "Copyright 2005-2010 Canonical Ltd."
45
39
 
46
40
# same format as sys.version_info: "A tuple containing the five components of
47
41
# the version number: major, minor, micro, releaselevel, and serial. All
50
44
# Python version 2.0 is (2, 0, 0, 'final', 0)."  Additionally we use a
51
45
# releaselevel of 'dev' for unreleased under-development code.
52
46
 
53
 
version_info = (1, 14, 0, 'dev', 0)
 
47
version_info = (2, 2, 0, 'dev', 1)
54
48
 
55
 
# API compatibility version: bzrlib is currently API compatible with 1.13.
56
 
api_minimum_version = (1, 13, 0)
 
49
# API compatibility version
 
50
api_minimum_version = (2, 2, 0)
57
51
 
58
52
 
59
53
def _format_version_tuple(version_info):
66
60
    zero for final releases.
67
61
 
68
62
    >>> print _format_version_tuple((1, 0, 0, 'final', 0))
69
 
    1.0
 
63
    1.0.0
70
64
    >>> print _format_version_tuple((1, 2, 0, 'dev', 0))
71
 
    1.2dev
 
65
    1.2.0dev
 
66
    >>> print bzrlib._format_version_tuple((1, 2, 0, 'dev', 1))
 
67
    1.2.0dev1
72
68
    >>> print _format_version_tuple((1, 1, 1, 'candidate', 2))
73
69
    1.1.1rc2
 
70
    >>> print bzrlib._format_version_tuple((2, 1, 0, 'beta', 1))
 
71
    2.1b1
74
72
    >>> print _format_version_tuple((1, 4, 0))
75
 
    1.4
 
73
    1.4.0
76
74
    >>> print _format_version_tuple((1, 4))
77
75
    1.4
 
76
    >>> print bzrlib._format_version_tuple((2, 1, 0, 'final', 1))
 
77
    Traceback (most recent call last):
 
78
    ...
 
79
    ValueError: version_info (2, 1, 0, 'final', 1) not valid
78
80
    >>> print _format_version_tuple((1, 4, 0, 'wibble', 0))
79
81
    Traceback (most recent call last):
80
82
    ...
81
83
    ValueError: version_info (1, 4, 0, 'wibble', 0) not valid
82
84
    """
83
 
    if len(version_info) == 2 or version_info[2] == 0:
 
85
    if len(version_info) == 2:
84
86
        main_version = '%d.%d' % version_info[:2]
85
87
    else:
86
88
        main_version = '%d.%d.%d' % version_info[:3]
95
97
        sub_string = ''
96
98
    elif release_type == 'dev' and sub == 0:
97
99
        sub_string = 'dev'
 
100
    elif release_type == 'dev':
 
101
        sub_string = 'dev' + str(sub)
98
102
    elif release_type in ('alpha', 'beta'):
 
103
        if version_info[2] == 0:
 
104
            main_version = '%d.%d' % version_info[:2]
99
105
        sub_string = release_type[0] + str(sub)
100
106
    elif release_type == 'candidate':
101
107
        sub_string = 'rc' + str(sub)
102
108
    else:
103
109
        raise ValueError("version_info %r not valid" % (version_info,))
104
110
 
105
 
    version_string = '%d.%d.%d.%s.%d' % version_info
106
111
    return main_version + sub_string
107
112
 
108
113
 
113
118
def test_suite():
114
119
    import tests
115
120
    return tests.test_suite()
 
121
 
 
122
 
 
123
def initialize(
 
124
    setup_ui=True,
 
125
    stdin=None, stdout=None, stderr=None):
 
126
    """Set up everything needed for normal use of bzrlib.
 
127
 
 
128
    Most applications that embed bzrlib, including bzr itself, should call
 
129
    this function to initialize various subsystems.  
 
130
 
 
131
    More options may be added in future so callers should use named arguments.
 
132
 
 
133
    :param setup_ui: If true (default) use a terminal UI; otherwise 
 
134
        something else must be put into `bzrlib.ui.ui_factory`.
 
135
    :param stdin, stdout, stderr: If provided, use these for terminal IO;
 
136
        otherwise use the files in `sys`.
 
137
    """
 
138
    # TODO: mention this in a guide to embedding bzrlib
 
139
    #
 
140
    # NB: This function tweaks so much global state it's hard to test it in
 
141
    # isolation within the same interpreter.  It's not reached on normal
 
142
    # in-process run_bzr calls.  If it's broken, we expect that
 
143
    # TestRunBzrSubprocess may fail.
 
144
    
 
145
    import atexit
 
146
    import bzrlib.trace
 
147
 
 
148
    bzrlib.trace.enable_default_logging()
 
149
    atexit.register(bzrlib.trace._flush_stdout_stderr)
 
150
    atexit.register(bzrlib.trace._flush_trace)
 
151
 
 
152
    import bzrlib.ui
 
153
    if stdin is None:
 
154
        stdin = sys.stdin
 
155
    if stdout is None:
 
156
        stdout = sys.stdout
 
157
    if stderr is None:
 
158
        stderr = sys.stderr
 
159
 
 
160
    if setup_ui:
 
161
        bzrlib.ui.ui_factory = bzrlib.ui.make_ui_for_terminal(
 
162
            stdin, stdout, stderr)
 
163
 
 
164
    if bzrlib.version_info[3] == 'final':
 
165
        from bzrlib.symbol_versioning import suppress_deprecation_warnings
 
166
        suppress_deprecation_warnings(override=True)
 
167
 
 
168
    import bzrlib.osutils
 
169
    atexit.register(osutils.report_extension_load_failures)