~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/dirstate.py

  • Committer: Ian Clatworthy
  • Date: 2009-03-18 02:03:22 UTC
  • mto: (4159.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 4161.
  • Revision ID: ian.clatworthy@canonical.com-20090318020322-75tdtdapmjbadbup
feedback from poolie - use SHA, not Sha, in class names

Show diffs side-by-side

added added

removed removed

Lines of Context:
263
263
        # return '%X.%X' % (int(st.st_mtime), st.st_mode)
264
264
 
265
265
 
266
 
class Sha1Provider(object):
 
266
class SHA1Provider(object):
267
267
    """An interface for getting sha1s of a file."""
268
268
 
269
269
    def sha1(self, abspath):
279
279
        raise NotImplementedError(self.stat_and_sha1)
280
280
 
281
281
 
282
 
class DefaultSha1Provider(Sha1Provider):
283
 
    """A Sha1Provider that reads directly from the filesystem."""
 
282
class DefaultSHA1Provider(SHA1Provider):
 
283
    """A SHA1Provider that reads directly from the filesystem."""
284
284
 
285
285
    def sha1(self, abspath):
286
 
        """Return the sha1 of a file given it's absolute path."""
 
286
        """Return the sha1 of a file given its absolute path."""
287
287
        return osutils.sha_file_by_name(abspath)
288
288
 
289
289
    def stat_and_sha1(self, abspath):
290
 
        """Return the stat and sha1 of a file given it's absolute path."""
 
290
        """Return the stat and sha1 of a file given its absolute path."""
291
291
        file_obj = file(abspath, 'rb')
292
292
        try:
293
293
            statvalue = os.fstat(file_obj.fileno())
359
359
        """Create a  DirState object.
360
360
 
361
361
        :param path: The path at which the dirstate file on disk should live.
362
 
        :param sha1_provider: an object meeting the Sha1Provider interface.
 
362
        :param sha1_provider: an object meeting the SHA1Provider interface.
363
363
        """
364
364
        # _header_state and _dirblock_state represent the current state
365
365
        # of the dirstate metadata and the per-row data respectiely.
1237
1237
 
1238
1238
        :param tree: The tree which should provide parent information and
1239
1239
            inventory ids.
1240
 
        :param sha1_provider: an object meeting the Sha1Provider interface.
1241
 
            If None, a DefaultSha1Provider is used.
 
1240
        :param sha1_provider: an object meeting the SHA1Provider interface.
 
1241
            If None, a DefaultSHA1Provider is used.
1242
1242
        :return: a DirState object which is currently locked for writing.
1243
1243
            (it was locked by DirState.initialize)
1244
1244
        """
1877
1877
        and only a root node - which has id ROOT_ID.
1878
1878
 
1879
1879
        :param path: The name of the file for the dirstate.
1880
 
        :param sha1_provider: an object meeting the Sha1Provider interface.
1881
 
            If None, a DefaultSha1Provider is used.
 
1880
        :param sha1_provider: an object meeting the SHA1Provider interface.
 
1881
            If None, a DefaultSHA1Provider is used.
1882
1882
        :return: A write-locked DirState object.
1883
1883
        """
1884
1884
        # This constructs a new DirState object on a path, sets the _state_file
1887
1887
        # and no parents. Finally it calls save() to ensure that this data will
1888
1888
        # persist.
1889
1889
        if sha1_provider is None:
1890
 
            sha1_provider = DefaultSha1Provider()
 
1890
            sha1_provider = DefaultSHA1Provider()
1891
1891
        result = cls(path, sha1_provider)
1892
1892
        # root dir and root dir contents with no children.
1893
1893
        empty_tree_dirblocks = [('', []), ('', [])]
2031
2031
        """Construct a DirState on the file at path path.
2032
2032
 
2033
2033
        :param path: The path at which the dirstate file on disk should live.
2034
 
        :param sha1_provider: an object meeting the Sha1Provider interface.
2035
 
            If None, a DefaultSha1Provider is used.
 
2034
        :param sha1_provider: an object meeting the SHA1Provider interface.
 
2035
            If None, a DefaultSHA1Provider is used.
2036
2036
        :return: An unlocked DirState object, associated with the given path.
2037
2037
        """
2038
2038
        if sha1_provider is None:
2039
 
            sha1_provider = DefaultSha1Provider()
 
2039
            sha1_provider = DefaultSHA1Provider()
2040
2040
        result = DirState(path, sha1_provider)
2041
2041
        return result
2042
2042