← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/__init__.py

  • Committer: Martin Pool
  • Date: 2009-08-20 04:53:23 UTC
  • mto: This revision was merged to the branch mainline in revision 4632.
  • Revision ID: mbp@sourcefrog.net-20090820045323-4hsicfa87pdq3l29
Correction to xdg_cache_dir and add a simple test

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/__init__.py
1
 
# Copyright (C) 2005, 2006 Canonical Development Ltd
2
 
 
 
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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
 
 
25
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
from bzrlib.osutils import get_user_encoding
 
35
 
19
36
 
20
37
IGNORE_FILENAME = ".bzrignore"
21
38
 
22
 
import os
23
 
import sys
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."
 
39
 
 
40
# XXX: Deprecated as of bzr-1.17 use osutils.get_user_encoding() directly
 
41
user_encoding = get_user_encoding()
 
42
 
 
43
 
 
44
__copyright__ = "Copyright 2005, 2006, 2007, 2008, 2009 Canonical Ltd."
36
45
 
37
46
# same format as sys.version_info: "A tuple containing the five components of
38
47
# the version number: major, minor, micro, releaselevel, and serial. All
41
50
# Python version 2.0 is (2, 0, 0, 'final', 0)."  Additionally we use a
42
51
# releaselevel of 'dev' for unreleased under-development code.
43
52
 
44
 
version_info = (0, 10, 0, 'dev', 0)
45
 
 
46
 
if version_info[3] == 'final':
47
 
    version_string = '%d.%d.%d' % version_info[:3]
48
 
else:
49
 
    version_string = '%d.%d.%d%s%d' % version_info
50
 
__version__ = version_string
51
 
 
52
 
from bzrlib.symbol_versioning import (deprecated_function,
53
 
                                      zero_seven,
54
 
                                      zero_nine,
55
 
                                      deprecated_list,
56
 
                                     )
57
 
 
58
 
# Kept for compatibility with 0.8, it is considered deprecated to modify it
59
 
DEFAULT_IGNORE = deprecated_list(zero_nine, 'DEFAULT_IGNORE', [],
60
 
                    'Consider using bzrlib.ignores.add_unique_user_ignores'
61
 
                    ' or bzrlib.ignores.add_runtime_ignores')
62
 
 
63
 
 
64
 
@deprecated_function(zero_seven)
65
 
def get_bzr_revision():
66
 
    """If bzr is run from a branch, return (revno,revid) or None."""
67
 
    import bzrlib.errors
68
 
    from bzrlib.branch import Branch
69
 
    
70
 
    try:
71
 
        branch = Branch.open(os.path.dirname(__path__[0]))
72
 
        rh = branch.revision_history()
73
 
        if rh:
74
 
            return len(rh), rh[-1]
75
 
        else:
76
 
            return None
77
 
    except bzrlib.errors.BzrError:
78
 
        return None
79
 
    
 
53
version_info = (1, 18, 0, 'dev', 0)
 
54
 
 
55
# API compatibility version: bzrlib is currently API compatible with 1.15.
 
56
api_minimum_version = (1, 17, 0)
 
57
 
 
58
def _format_version_tuple(version_info):
 
59
    """Turn a version number 2, 3 or 5-tuple into a short string.
 
60
 
 
61
    This format matches <http://docs.python.org/dist/meta-data.html>
 
62
    and the typical presentation used in Python output.
 
63
 
 
64
    This also checks that the version is reasonable: the sub-release must be
 
65
    zero for final releases.
 
66
 
 
67
    >>> print _format_version_tuple((1, 0, 0, 'final', 0))
 
68
    1.0
 
69
    >>> print _format_version_tuple((1, 2, 0, 'dev', 0))
 
70
    1.2dev
 
71
    >>> print _format_version_tuple((1, 1, 1, 'candidate', 2))
 
72
    1.1.1rc2
 
73
    >>> print _format_version_tuple((1, 4, 0))
 
74
    1.4
 
75
    >>> print _format_version_tuple((1, 4))
 
76
    1.4
 
77
    >>> print _format_version_tuple((1, 4, 0, 'wibble', 0))
 
78
    Traceback (most recent call last):
 
79
    ...
 
80
    ValueError: version_info (1, 4, 0, 'wibble', 0) not valid
 
81
    """
 
82
    if len(version_info) == 2 or version_info[2] == 0:
 
83
        main_version = '%d.%d' % version_info[:2]
 
84
    else:
 
85
        main_version = '%d.%d.%d' % version_info[:3]
 
86
    if len(version_info) <= 3:
 
87
        return main_version
 
88
 
 
89
    release_type = version_info[3]
 
90
    sub = version_info[4]
 
91
 
 
92
    # check they're consistent
 
93
    if release_type == 'final' and sub == 0:
 
94
        sub_string = ''
 
95
    elif release_type == 'dev' and sub == 0:
 
96
        sub_string = 'dev'
 
97
    elif release_type in ('alpha', 'beta'):
 
98
        sub_string = release_type[0] + str(sub)
 
99
    elif release_type == 'candidate':
 
100
        sub_string = 'rc' + str(sub)
 
101
    else:
 
102
        raise ValueError("version_info %r not valid" % (version_info,))
 
103
 
 
104
    version_string = '%d.%d.%d.%s.%d' % tuple(version_info)
 
105
    return main_version + sub_string
 
106
 
 
107
 
 
108
__version__ = _format_version_tuple(version_info)
 
109
version_string = __version__
 
110
 
 
111
 
80
112
def test_suite():
81
113
    import tests
82
114
    return tests.test_suite()