/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to breezy/transport/log.py

  • Committer: Gustav Hartvigsson
  • Date: 2021-01-09 21:36:27 UTC
  • Revision ID: gustav.hartvigsson@gmail.com-20210109213627-h1xwcutzy9m7a99b
Added 'Case Preserving Working Tree Use Cases' from Canonical Wiki

* Addod a page from the Canonical Bazaar wiki
  with information on the scmeatics of case
  perserving filesystems an a case insensitive
  filesystem works.
  
  * Needs re-work, but this will do as it is the
    same inforamoton as what was on the linked
    page in the currint documentation.

Show diffs side-by-side

added added

removed removed

Lines of Context:
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
 
"""Transport decorator that logs transport operations to .bzr.log."""
18
 
 
 
17
"""Transport decorator that logs transport operations to brz.log."""
19
18
 
20
19
# see also the transportstats plugin, which gives you some summary information
21
20
# in a machine-readable dump
22
21
 
23
 
import StringIO
24
 
import cStringIO
25
22
import time
26
23
import types
27
24
 
28
 
from bzrlib.trace import mutter
29
 
from bzrlib.transport import decorator
 
25
from ..trace import mutter
 
26
from ..transport import decorator
30
27
 
31
28
 
32
29
class TransportLogDecorator(decorator.TransportDecorator):
33
 
    """Decorator for Transports that logs interesting operations to .bzr.log.
 
30
    """Decorator for Transports that logs interesting operations to brz.log.
34
31
 
35
32
    In general we want to log things that usually take a network round trip
36
33
    and may be slow.
37
34
 
38
35
    Not all operations are logged yet.
39
36
 
40
 
    See also TransportTraceDecorator, that records a machine-readable log in 
 
37
    See also TransportTraceDecorator, that records a machine-readable log in
41
38
    memory for eg testing.
42
39
    """
43
40
 
44
41
    def __init__(self, *args, **kw):
45
42
        super(TransportLogDecorator, self).__init__(*args, **kw)
 
43
 
46
44
        def _make_hook(hookname):
47
45
            def _hook(relpath, *args, **kw):
48
46
                return self._log_and_call(hookname, relpath, *args, **kw)
49
47
            return _hook
 
48
        # GZ 2017-05-21: Not all methods take relpath as first argument, for
 
49
        # instance copy_to takes list of relpaths. Also, unclear on url vs
 
50
        # filesystem path split. Needs tidying up.
50
51
        for methodname in (
51
 
            'append_bytes',
52
 
            'append_file',
53
 
            'copy_to',
54
 
            'delete',
55
 
            'get',
56
 
            'has',
57
 
            'open_write_stream',
58
 
            'mkdir',
59
 
            'move',
60
 
            'put_bytes', 'put_bytes_non_atomic', 'put_file put_file_non_atomic',
61
 
            'list_dir', 'lock_read', 'lock_write',
62
 
            'readv', 'rename', 'rmdir',
63
 
            'stat',
64
 
            'ulock',
65
 
            ):
 
52
                'append_bytes',
 
53
                'append_file',
 
54
                'copy_to',
 
55
                'delete',
 
56
                'get',
 
57
                'has',
 
58
                'open_write_stream',
 
59
                'mkdir',
 
60
                'move',
 
61
                'put_bytes', 'put_bytes_non_atomic', 'put_file put_file_non_atomic',
 
62
                'list_dir', 'lock_read', 'lock_write',
 
63
                'readv', 'rename', 'rmdir',
 
64
                'stat',
 
65
                'ulock',
 
66
                ):
66
67
            setattr(self, methodname, _make_hook(methodname))
67
68
 
68
69
    @classmethod
72
73
    def iter_files_recursive(self):
73
74
        # needs special handling because it does not have a relpath parameter
74
75
        mutter("%s %s"
75
 
            % ('iter_files_recursive', self._decorated.base))
 
76
               % ('iter_files_recursive', self._decorated.base))
76
77
        return self._call_and_log_result('iter_files_recursive', (), {})
77
78
 
78
79
    def _log_and_call(self, methodname, relpath, *args, **kwargs):
81
82
        else:
82
83
            kwargs_str = ''
83
84
        mutter("%s %s %s %s"
84
 
               % (methodname, self._decorated.abspath(relpath),
 
85
               % (methodname, relpath,
85
86
                  self._shorten(self._strip_tuple_parens(args)),
86
87
                  kwargs_str))
87
88
        return self._call_and_log_result(methodname, (relpath,) + args, kwargs)
90
91
        before = time.time()
91
92
        try:
92
93
            result = getattr(self._decorated, methodname)(*args, **kwargs)
93
 
        except Exception, e:
 
94
        except Exception as e:
94
95
            mutter("  --> %s" % e)
95
96
            mutter("      %.03fs" % (time.time() - before))
96
97
            raise
108
109
            return_result = iter(result)
109
110
        else:
110
111
            return_result = result
111
 
        if isinstance(result, (cStringIO.OutputType, StringIO.StringIO)):
112
 
            val = repr(result.getvalue())
 
112
        # Is this an io object with a getvalue() method?
 
113
        getvalue = getattr(result, 'getvalue', None)
 
114
        if getvalue is not None:
 
115
            val = repr(getvalue())
113
116
            result_len = len(val)
114
117
            shown_result = "%s(%s) (%d bytes)" % (result.__class__.__name__,
115
 
                self._shorten(val), result_len)
 
118
                                                  self._shorten(val), result_len)
116
119
        elif methodname == 'readv':
117
120
            num_hunks = len(result)
118
 
            total_bytes = sum((len(d) for o,d in result))
 
121
            total_bytes = sum((len(d) for o, d in result))
119
122
            shown_result = "readv response, %d hunks, %d total bytes" % (
120
123
                num_hunks, total_bytes)
121
124
            result_len = total_bytes
131
134
                # this is the rate of higher-level data, not the raw network
132
135
                # speed using base-10 units (see HACKING.txt).
133
136
                mutter("      %9.03fs %8dkB/s"
134
 
                       % (elapsed, result_len/elapsed/1000))
 
137
                       % (elapsed, result_len / elapsed / 1000))
135
138
            else:
136
139
                mutter("      %9.03fs" % (elapsed))
137
140
        return return_result
150
153
 
151
154
def get_test_permutations():
152
155
    """Return the permutations to be used in testing."""
153
 
    from bzrlib.tests import test_server
 
156
    from ..tests import test_server
154
157
    return [(TransportLogDecorator, test_server.LogDecoratorServer)]