← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/transport/__init__.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2006-09-14 04:53:15 UTC
  • mfrom: (1910.7.21 cosmetic)
  • Revision ID: pqm@pqm.ubuntu.com-20060914045315-d646c86b3f4722f2
(Andrew Bennetts, Robert Collins, Martin Pool) Various cosmetic improvements to docstrings and comments throughout bzrlib.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/transport/__init__.py
198
198
    implementations can do pipelining.
199
199
    In general implementations should support having a generator or a list
200
200
    as an argument (ie always iterate, never index)
 
201
 
 
202
    :ivar base: Base URL for the transport; should always end in a slash.
201
203
    """
202
204
 
203
205
    # implementations can override this if it is more efficient
342
344
        Note that some transports MAY allow querying on directories, but this
343
345
        is not part of the protocol.  In other words, the results of 
344
346
        t.has("a_directory_name") are undefined.
 
347
 
 
348
        :rtype: bool
345
349
        """
346
350
        raise NotImplementedError(self.has)
347
351
 
634
638
        return self.append_file(relpath, f, mode=mode)
635
639
 
636
640
    def append_file(self, relpath, f, mode=None):
637
 
        """Append the text in the file-like object to the supplied location.
638
 
 
639
 
        returns the length of relpath before the content was written to it.
640
 
        
641
 
        If the file does not exist, it is created with the supplied mode.
 
641
        """Append bytes from a file-like object to a file at relpath.
 
642
 
 
643
        The file is created if it does not already exist.
 
644
 
 
645
        :param f: a file-like object of the bytes to append.
 
646
        :param mode: Unix mode for newly created files.  This is not used for
 
647
            existing files.
 
648
 
 
649
        :returns: the length of relpath before the content was written to it.
642
650
        """
643
651
        symbol_versioning.warn('Transport %s should implement append_file,'
644
652
                               ' rather than implementing append() as of'
648
656
        return self.append(relpath, f, mode=mode)
649
657
 
650
658
    def append_bytes(self, relpath, bytes, mode=None):
651
 
        """Append the text in the string object to the supplied location.
652
 
 
653
 
        returns the length of relpath before the content was written to it.
654
 
        
655
 
        If the file does not exist, it is created with the supplied mode.
 
659
        """Append bytes to a file at relpath.
 
660
 
 
661
        The file is created if it does not already exist.
 
662
 
 
663
        :type f: str
 
664
        :param f: a string of the bytes to append.
 
665
        :param mode: Unix mode for newly created files.  This is not used for
 
666
            existing files.
 
667
 
 
668
        :returns: the length of relpath before the content was written to it.
656
669
        """
657
670
        assert isinstance(bytes, str), \
658
671
            'bytes must be a plain string, not %s' % type(bytes)