← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/__init__.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-02-11 04:02:41 UTC
  • mfrom: (5017.2.2 tariff)
  • Revision ID: pqm@pqm.ubuntu.com-20100211040241-w6n021dz0uus341n
(mbp) add import-tariff tests

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