← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/__init__.py

  • Committer: Robey Pointer
  • Date: 2006-07-01 19:03:33 UTC
  • mfrom: (1829 +trunk)
  • mto: This revision was merged to the branch mainline in revision 1830.
  • Revision ID: robey@lag.net-20060701190333-f58465aec4bd3412
merge from bzr.dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/__init__.py
1
 
# Copyright (C) 2005-2011 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
16
 
 
17
 
"""All of bzr.
18
 
 
19
 
Developer documentation is available at
20
 
http://doc.bazaar.canonical.com/bzr.dev/developers/
21
 
 
22
 
The project website is at http://bazaar.canonical.com/
23
 
 
24
 
Some particularly interesting things in bzrlib are:
25
 
 
26
 
 * bzrlib.initialize -- setup the library for use
27
 
 * bzrlib.plugin.load_plugins -- load all installed plugins
28
 
 * bzrlib.branch.Branch.open -- open a branch
29
 
 * bzrlib.workingtree.WorkingTree.open -- open a working tree
30
 
 
31
 
We hope you enjoy this library.
32
 
"""
33
 
 
34
 
import time
35
 
 
36
 
# Keep track of when bzrlib was first imported, so that we can give rough
37
 
# timestamps relative to program start in the log file kept by bzrlib.trace.
38
 
_start_time = time.time()
39
 
 
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
"""bzr library"""
 
18
 
 
19
 
 
20
# please keep these sorted (in C locale order) to aid merging
 
21
DEFAULT_IGNORE = [
 
22
                  '#*#',
 
23
                  '*$',
 
24
                  '*,v',
 
25
                  '*.BAK',
 
26
                  '*.a',
 
27
                  '*.bak',
 
28
                  '*.elc',
 
29
                  '*.exe',
 
30
                  '*.la',
 
31
                  '*.lo',
 
32
                  '*.o',
 
33
                  '*.o',
 
34
                  '*.obj',
 
35
                  '*.orig',
 
36
                  '*.py[oc]',
 
37
                  '*.so',
 
38
                  '*.tmp',
 
39
                  '.*.tmp',
 
40
                  '*~',
 
41
                  '.#*',
 
42
                  '.*.sw[nop]',
 
43
                  '.sw[nop]',    # vim editing nameless file
 
44
                  '.DS_Store',
 
45
                  '.arch-ids',
 
46
                  '.arch-inventory',
 
47
                  '.bzr.log',
 
48
                  '.del-*',
 
49
                  '.hg',
 
50
                  '.git',
 
51
                  '.jamdeps'
 
52
                  '.libs',
 
53
                  '.make.state',
 
54
                  '.sconsign*',
 
55
                  '.svn',
 
56
                  '.tmp*',
 
57
                  'BitKeeper',
 
58
                  'CVS',
 
59
                  'CVS.adm',
 
60
                  'RCS',
 
61
                  'SCCS',
 
62
                  'TAGS',
 
63
                  '_darcs',
 
64
                  'aclocal.m4',
 
65
                  'autom4te*',
 
66
                  'config.h',
 
67
                  'config.h.in',
 
68
                  'config.log',
 
69
                  'config.status',
 
70
                  'config.sub',
 
71
                  'stamp-h',
 
72
                  'stamp-h.in',
 
73
                  'stamp-h1',
 
74
                  '{arch}',
 
75
                  # Our setup tests dump .python-eggs in the bzr source tree
 
76
                  # root
 
77
                  './.python-eggs',
 
78
                  ]
 
79
 
 
80
IGNORE_FILENAME = ".bzrignore"
 
81
 
 
82
import os
40
83
import sys
41
 
 
42
 
 
43
 
IGNORE_FILENAME = ".bzrignore"
44
 
 
45
 
 
46
 
__copyright__ = "Copyright 2005-2011 Canonical Ltd."
 
84
if sys.platform == 'darwin':
 
85
    # work around egregious python 2.4 bug
 
86
    sys.platform = 'posix'
 
87
    import locale
 
88
    sys.platform = 'darwin'
 
89
else:
 
90
    import locale
 
91
# XXX: This probably belongs in osutils instead
 
92
user_encoding = locale.getpreferredencoding() or 'ascii'
 
93
del locale
 
94
 
 
95
__copyright__ = "Copyright 2005, 2006 Canonical Development Ltd."
 
96
__version__ = version_string = '0.9'
47
97
 
48
98
# same format as sys.version_info: "A tuple containing the five components of
49
99
# the version number: major, minor, micro, releaselevel, and serial. All
52
102
# Python version 2.0 is (2, 0, 0, 'final', 0)."  Additionally we use a
53
103
# releaselevel of 'dev' for unreleased under-development code.
54
104
 
55
 
version_info = (2, 4, 0, 'dev', 4)
56
 
 
57
 
# API compatibility version
58
 
api_minimum_version = (2, 4, 0)
59
 
 
60
 
 
61
 
def _format_version_tuple(version_info):
62
 
    """Turn a version number 2, 3 or 5-tuple into a short string.
63
 
 
64
 
    This format matches <http://docs.python.org/dist/meta-data.html>
65
 
    and the typical presentation used in Python output.
66
 
 
67
 
    This also checks that the version is reasonable: the sub-release must be
68
 
    zero for final releases.
69
 
 
70
 
    >>> print _format_version_tuple((1, 0, 0, 'final', 0))
71
 
    1.0.0
72
 
    >>> print _format_version_tuple((1, 2, 0, 'dev', 0))
73
 
    1.2.0dev
74
 
    >>> print _format_version_tuple((1, 2, 0, 'dev', 1))
75
 
    1.2.0dev1
76
 
    >>> print _format_version_tuple((1, 1, 1, 'candidate', 2))
77
 
    1.1.1rc2
78
 
    >>> print _format_version_tuple((2, 1, 0, 'beta', 1))
79
 
    2.1b1
80
 
    >>> print _format_version_tuple((1, 4, 0))
81
 
    1.4.0
82
 
    >>> print _format_version_tuple((1, 4))
83
 
    1.4
84
 
    >>> print _format_version_tuple((2, 1, 0, 'final', 42))
85
 
    2.1.0.42
86
 
    >>> print _format_version_tuple((1, 4, 0, 'wibble', 0))
87
 
    1.4.0.wibble.0
88
 
    """
89
 
    if len(version_info) == 2:
90
 
        main_version = '%d.%d' % version_info[:2]
91
 
    else:
92
 
        main_version = '%d.%d.%d' % version_info[:3]
93
 
    if len(version_info) <= 3:
94
 
        return main_version
95
 
 
96
 
    release_type = version_info[3]
97
 
    sub = version_info[4]
98
 
 
99
 
    if release_type == 'final' and sub == 0:
100
 
        sub_string = ''
101
 
    elif release_type == 'final':
102
 
        sub_string = '.' + str(sub)
103
 
    elif release_type == 'dev' and sub == 0:
104
 
        sub_string = 'dev'
105
 
    elif release_type == 'dev':
106
 
        sub_string = 'dev' + str(sub)
107
 
    elif release_type in ('alpha', 'beta'):
108
 
        if version_info[2] == 0:
109
 
            main_version = '%d.%d' % version_info[:2]
110
 
        sub_string = release_type[0] + str(sub)
111
 
    elif release_type == 'candidate':
112
 
        sub_string = 'rc' + str(sub)
113
 
    else:
114
 
        return '.'.join(map(str, version_info))
115
 
 
116
 
    return main_version + sub_string
117
 
 
118
 
 
119
 
# lazy_regex import must be done after _format_version_tuple definition
120
 
# to avoid "no attribute '_format_version_tuple'" error when using
121
 
# deprecated_function in the lazy_regex module.
122
 
if getattr(sys, '_bzr_lazy_regex', False):
123
 
    # The 'bzr' executable sets _bzr_lazy_regex.  We install the lazy regex
124
 
    # hack as soon as possible so that as much of the standard library can
125
 
    # benefit, including the 'string' module.
126
 
    del sys._bzr_lazy_regex
127
 
    import bzrlib.lazy_regex
128
 
    bzrlib.lazy_regex.install_lazy_compile()
129
 
 
130
 
 
131
 
__version__ = _format_version_tuple(version_info)
132
 
version_string = __version__
133
 
 
134
 
# bzr has various bits of global state that are slowly being eliminated.
135
 
# This variable is intended to permit any new state-like things to be attached
136
 
# to a library_state.BzrLibraryState object rather than getting new global
137
 
# variables that need to be hunted down. Accessing the current BzrLibraryState
138
 
# through this variable is not encouraged: it is better to pass it around as
139
 
# part of the context of an operation than to look it up directly, but when
140
 
# that is too hard, it is better to use this variable than to make a branch new
141
 
# global variable.
142
 
# If using this variable by looking it up (because it can't be easily obtained)
143
 
# it is important to store the reference you get, rather than looking it up
144
 
# repeatedly; that way your code will behave properly in the bzrlib test suite
145
 
# and from programs that do use multiple library contexts.
146
 
global_state = None
147
 
 
148
 
 
149
 
def initialize(setup_ui=True, stdin=None, stdout=None, stderr=None):
150
 
    """Set up everything needed for normal use of bzrlib.
151
 
 
152
 
    Most applications that embed bzrlib, including bzr itself, should call
153
 
    this function to initialize various subsystems.  
154
 
 
155
 
    More options may be added in future so callers should use named arguments.
156
 
 
157
 
    The object returned by this function can be used as a contex manager
158
 
    through the 'with' statement to automatically shut down when the process
159
 
    is finished with bzrlib.  However (from bzr 2.4) it's not necessary to
160
 
    separately enter the context as well as starting bzr: bzrlib is ready to
161
 
    go when this function returns.
162
 
 
163
 
    :param setup_ui: If true (default) use a terminal UI; otherwise 
164
 
        some other ui_factory must be assigned to `bzrlib.ui.ui_factory` by
165
 
        the caller.
166
 
    :param stdin, stdout, stderr: If provided, use these for terminal IO;
167
 
        otherwise use the files in `sys`.
168
 
    :return: A context manager for the use of bzrlib. The __exit__
169
 
        should be called by the caller before exiting their process or
170
 
        otherwise stopping use of bzrlib. Advanced callers can use
171
 
        BzrLibraryState directly.
172
 
    """
173
 
    from bzrlib import library_state, trace
174
 
    if setup_ui:
175
 
        import bzrlib.ui
176
 
        stdin = stdin or sys.stdin
177
 
        stdout = stdout or sys.stdout
178
 
        stderr = stderr or sys.stderr
179
 
        ui_factory = bzrlib.ui.make_ui_for_terminal(stdin, stdout, stderr)
180
 
    else:
181
 
        ui_factory = None
182
 
    tracer = trace.DefaultConfig()
183
 
    state = library_state.BzrLibraryState(ui=ui_factory, trace=tracer)
184
 
    # Start automatically in case people don't realize this returns a context.
185
 
    state._start()
186
 
    return state
187
 
 
188
 
 
 
105
version_info = (0, 9, 0, 'dev', 0)
 
106
 
 
107
if version_info[3] == 'final':
 
108
    version_string = '%d.%d.%d' % version_info[:3]
 
109
else:
 
110
    version_string = '%d.%d.%d%s%d' % version_info
 
111
__version__ = version_string 
 
112
 
 
113
from bzrlib.symbol_versioning import deprecated_function, zero_seven
 
114
 
 
115
@deprecated_function(zero_seven)
 
116
def get_bzr_revision():
 
117
    """If bzr is run from a branch, return (revno,revid) or None."""
 
118
    import bzrlib.errors
 
119
    from bzrlib.branch import Branch
 
120
    
 
121
    try:
 
122
        branch = Branch.open(os.path.dirname(__path__[0]))
 
123
        rh = branch.revision_history()
 
124
        if rh:
 
125
            return len(rh), rh[-1]
 
126
        else:
 
127
            return None
 
128
    except bzrlib.errors.BzrError:
 
129
        return None
 
130
    
189
131
def test_suite():
190
132
    import tests
191
133
    return tests.test_suite()