← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/__init__.py

  • Committer: Alexander Belchenko
  • Date: 2006-07-30 16:43:12 UTC
  • mto: (1711.2.111 jam-integration)
  • mto: This revision was merged to the branch mainline in revision 1906.
  • Revision ID: bialix@ukr.net-20060730164312-b025fd3ff0cee59e
rename  gpl.txt => COPYING.txt

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/__init__.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
2
 
#
 
1
# Copyright (C) 2005, 2006 Canonical Development Ltd
 
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
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
#
 
7
 
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
12
 
#
 
12
 
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""bzr library"""
18
18
 
19
 
import time
20
 
 
21
 
# Keep track of when bzrlib was first imported, so that we can give rough
22
 
# timestamps relative to program start in the log file kept by bzrlib.trace.
23
 
_start_time = time.time()
24
 
 
 
19
 
 
20
IGNORE_FILENAME = ".bzrignore"
 
21
 
 
22
import os
25
23
import sys
26
 
if getattr(sys, '_bzr_lazy_regex', False):
27
 
    # The 'bzr' executable sets _bzr_lazy_regex.  We install the lazy regex
28
 
    # hack as soon as possible so that as much of the standard library can
29
 
    # benefit, including the 'string' module.
30
 
    del sys._bzr_lazy_regex
31
 
    import bzrlib.lazy_regex
32
 
    bzrlib.lazy_regex.install_lazy_compile()
33
 
 
34
 
 
35
 
IGNORE_FILENAME = ".bzrignore"
36
 
 
37
 
 
38
 
__copyright__ = "Copyright 2005-2010 Canonical Ltd."
 
24
if sys.platform == 'darwin':
 
25
    # work around egregious python 2.4 bug
 
26
    sys.platform = 'posix'
 
27
    import locale
 
28
    sys.platform = 'darwin'
 
29
else:
 
30
    import locale
 
31
# XXX: This probably belongs in osutils instead
 
32
user_encoding = locale.getpreferredencoding() or 'ascii'
 
33
del locale
 
34
 
 
35
__copyright__ = "Copyright 2005, 2006 Canonical Development Ltd."
 
36
__version__ = version_string = '0.9'
39
37
 
40
38
# same format as sys.version_info: "A tuple containing the five components of
41
39
# the version number: major, minor, micro, releaselevel, and serial. All
44
42
# Python version 2.0 is (2, 0, 0, 'final', 0)."  Additionally we use a
45
43
# releaselevel of 'dev' for unreleased under-development code.
46
44
 
47
 
version_info = (2, 2, 0, 'dev', 1)
48
 
 
49
 
# API compatibility version
50
 
api_minimum_version = (2, 2, 0)
51
 
 
52
 
 
53
 
def _format_version_tuple(version_info):
54
 
    """Turn a version number 2, 3 or 5-tuple into a short string.
55
 
 
56
 
    This format matches <http://docs.python.org/dist/meta-data.html>
57
 
    and the typical presentation used in Python output.
58
 
 
59
 
    This also checks that the version is reasonable: the sub-release must be
60
 
    zero for final releases.
61
 
 
62
 
    >>> print _format_version_tuple((1, 0, 0, 'final', 0))
63
 
    1.0.0
64
 
    >>> print _format_version_tuple((1, 2, 0, 'dev', 0))
65
 
    1.2.0dev
66
 
    >>> print bzrlib._format_version_tuple((1, 2, 0, 'dev', 1))
67
 
    1.2.0dev1
68
 
    >>> print _format_version_tuple((1, 1, 1, 'candidate', 2))
69
 
    1.1.1rc2
70
 
    >>> print bzrlib._format_version_tuple((2, 1, 0, 'beta', 1))
71
 
    2.1b1
72
 
    >>> print _format_version_tuple((1, 4, 0))
73
 
    1.4.0
74
 
    >>> print _format_version_tuple((1, 4))
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
80
 
    >>> print _format_version_tuple((1, 4, 0, 'wibble', 0))
81
 
    Traceback (most recent call last):
82
 
    ...
83
 
    ValueError: version_info (1, 4, 0, 'wibble', 0) not valid
84
 
    """
85
 
    if len(version_info) == 2:
86
 
        main_version = '%d.%d' % version_info[:2]
87
 
    else:
88
 
        main_version = '%d.%d.%d' % version_info[:3]
89
 
    if len(version_info) <= 3:
90
 
        return main_version
91
 
 
92
 
    release_type = version_info[3]
93
 
    sub = version_info[4]
94
 
 
95
 
    # check they're consistent
96
 
    if release_type == 'final' and sub == 0:
97
 
        sub_string = ''
98
 
    elif release_type == 'dev' and sub == 0:
99
 
        sub_string = 'dev'
100
 
    elif release_type == 'dev':
101
 
        sub_string = 'dev' + str(sub)
102
 
    elif release_type in ('alpha', 'beta'):
103
 
        if version_info[2] == 0:
104
 
            main_version = '%d.%d' % version_info[:2]
105
 
        sub_string = release_type[0] + str(sub)
106
 
    elif release_type == 'candidate':
107
 
        sub_string = 'rc' + str(sub)
108
 
    else:
109
 
        raise ValueError("version_info %r not valid" % (version_info,))
110
 
 
111
 
    return main_version + sub_string
112
 
 
113
 
 
114
 
__version__ = _format_version_tuple(version_info)
115
 
version_string = __version__
116
 
 
117
 
 
 
45
version_info = (0, 9, 0, 'dev', 0)
 
46
 
 
47
if version_info[3] == 'final':
 
48
    version_string = '%d.%d.%d' % version_info[:3]
 
49
else:
 
50
    version_string = '%d.%d.%d%s%d' % version_info
 
51
__version__ = version_string
 
52
 
 
53
from bzrlib.symbol_versioning import (deprecated_function,
 
54
                                      zero_seven,
 
55
                                      zero_nine,
 
56
                                      deprecated_list,
 
57
                                     )
 
58
 
 
59
# Kept for compatibility with 0.8, it is considered deprecated to modify it
 
60
DEFAULT_IGNORE = deprecated_list(zero_nine, 'DEFAULT_IGNORE', [],
 
61
                    'Consider using bzrlib.ignores.add_unique_user_ignores'
 
62
                    ' or bzrlib.ignores.add_runtime_ignores')
 
63
 
 
64
 
 
65
@deprecated_function(zero_seven)
 
66
def get_bzr_revision():
 
67
    """If bzr is run from a branch, return (revno,revid) or None."""
 
68
    import bzrlib.errors
 
69
    from bzrlib.branch import Branch
 
70
    
 
71
    try:
 
72
        branch = Branch.open(os.path.dirname(__path__[0]))
 
73
        rh = branch.revision_history()
 
74
        if rh:
 
75
            return len(rh), rh[-1]
 
76
        else:
 
77
            return None
 
78
    except bzrlib.errors.BzrError:
 
79
        return None
 
80
    
118
81
def test_suite():
119
82
    import tests
120
83
    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)