← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/__init__.py

  • Committer: mbp at sourcefrog
  • Date: 2005-03-09 04:51:05 UTC
  • Revision ID: mbp@sourcefrog.net-20050309045105-d02cd410a115da2c
import all docs from arch

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/__init__.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
2
 
#
 
1
#! /usr/bin/env python
 
2
# -*- coding: UTF-8 -*-
 
3
 
3
4
# This program is free software; you can redistribute it and/or modify
4
5
# it under the terms of the GNU General Public License as published by
5
6
# the Free Software Foundation; either version 2 of the License, or
6
7
# (at your option) any later version.
7
 
#
 
8
 
8
9
# This program is distributed in the hope that it will be useful,
9
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
12
# GNU General Public License for more details.
12
 
#
 
13
 
13
14
# You should have received a copy of the GNU General Public License
14
15
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
17
 
17
18
"""bzr library"""
18
19
 
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
 
 
 
20
from inventory import Inventory, InventoryEntry
 
21
from branch import Branch, ScratchBranch
 
22
from osutils import format_date
 
23
from tree import Tree
 
24
from diff import diff_trees
 
25
 
 
26
BZRDIR = ".bzr"
 
27
 
 
28
DEFAULT_IGNORE = ['.*', '*~', '#*#', '*.tmp', '*.o', '*.a', '*.py[oc]',
 
29
                  '{arch}']
34
30
 
35
31
IGNORE_FILENAME = ".bzrignore"
36
32
 
37
33
 
38
 
__copyright__ = "Copyright 2005, 2006, 2007, 2008, 2009 Canonical Ltd."
39
 
 
40
 
# same format as sys.version_info: "A tuple containing the five components of
41
 
# the version number: major, minor, micro, releaselevel, and serial. All
42
 
# values except releaselevel are integers; the release level is 'alpha',
43
 
# 'beta', 'candidate', or 'final'. The version_info value corresponding to the
44
 
# Python version 2.0 is (2, 0, 0, 'final', 0)."  Additionally we use a
45
 
# releaselevel of 'dev' for unreleased under-development code.
46
 
 
47
 
version_info = (2, 2, 0, 'dev', 1)
48
 
 
49
 
# API compatibility version: bzrlib is currently API compatible with 1.15.
50
 
api_minimum_version = (2, 1, 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.1.0b1
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
 
        sub_string = release_type[0] + str(sub)
104
 
    elif release_type == 'candidate':
105
 
        sub_string = 'rc' + str(sub)
106
 
    else:
107
 
        raise ValueError("version_info %r not valid" % (version_info,))
108
 
 
109
 
    return main_version + sub_string
110
 
 
111
 
 
112
 
__version__ = _format_version_tuple(version_info)
113
 
version_string = __version__
114
 
 
115
 
 
116
 
def test_suite():
117
 
    import tests
118
 
    return tests.test_suite()