Merge branch 'reflog'

Author: Byron

__init__.py

@@ -37,7 +37,8 @@ def _init_externals():
 from git.util import (
 						LockFile, 
 						BlockingLockFile, 
-						Stats
+						Stats,
+						Actor
 						)
 
 #} END imports

doc/source/changes.rst

@@ -2,16 +2,45 @@
 Changelog
 =========
 
-0.3.2 Beta 1
+0.3.1 Beta 2
 ============
-* Flattened directory structure to make development more convenient.
+* Added **reflog support** ( reading and writing )
+
+ * New types: ``RefLog`` and ``RefLogEntry``
+ * Reflog is maintained automatically when creating references and deleting them
+ * Non-intrusive changes to ``SymbolicReference``, these don't require your code to change. They allow to append messages to the reflog.
+ 
+     * ``abspath`` property added, similar to ``abspath`` of Object instances
+     * ``log()`` method added
+     * ``log_append(...)`` method added
+     * ``set_reference(...)`` method added (reflog support)
+     * ``set_commit(...)`` method added (reflog support)
+     * ``set_object(...)`` method added (reflog support)
+
+ * Intrusive Changes to ``Head`` type
+ 
+  * ``create(...)`` method now supports the reflog, but will not raise ``GitCommandError`` anymore as it is a pure python implementation now. Instead, it raises ``OSError``.
+     
+* Repo.rev_parse now supports the [ref]@{n} syntax, where n is the number of steps to look into the reference's past
+
+* **BugFixes**
+
+    * Removed incorrect ORIG_HEAD handling
+ 
+* **Flattened directory** structure to make development more convenient.
 
  * .. note:: This alters the way projects using git-python as a submodule have to adjust their sys.path to be able to import git-python successfully.
+ * Misc smaller changes and bugfixes
 
 0.3.1 Beta 1
 ============
 * Full Submodule-Support
 * Added unicode support for author names. Commit.author.name is now unicode instead of string.
+* Head Type changes
+
+ * config_reader() & config_writer() methods added for access to head specific options.
+ * tracking_branch() & set_tracking_branch() methods addded for easy configuration of tracking branches.
+
 
 0.3.0 Beta 2
 ============

doc/source/conf.py

@@ -20,7 +20,7 @@
 # is relative to the documentation root, use os.path.abspath to make it
 # absolute, like shown here.
 #sys.path.append(os.path.abspath('.'))
-sys.path.insert(0, os.path.abspath('../../lib'))
+sys.path.insert(0, os.path.abspath('../../../'))
 
 # General configuration
 # ---------------------

doc/source/reference.rst

@@ -131,13 +131,48 @@ Exceptions
    :undoc-members:
 
 
-Refs
-----
+Refs.symbolic
+-------------
+
+.. automodule:: git.refs.symbolic
+   :members:
+   :undoc-members:
+   
+Refs.reference
+--------------
 
-.. automodule:: git.refs
+.. automodule:: git.refs.reference
    :members:
    :undoc-members:
 
+Refs.head
+---------
+
+.. automodule:: git.refs.head
+   :members:
+   :undoc-members:
+   
+Refs.tag
+------------
+
+.. automodule:: git.refs.tag
+   :members:
+   :undoc-members:
+   
+Refs.remote
+------------
+
+.. automodule:: git.refs.remote
+   :members:
+   :undoc-members:
+   
+Refs.log
+------------
+
+.. automodule:: git.refs.log
+   :members:
+   :undoc-members:
+   
 Remote
 ------
 

doc/source/tutorial.rst

@@ -88,6 +88,14 @@ A symbolic reference is a special case of a reference as it points to another re
     head = repo.head            # the head points to the active branch/ref
     master = head.reference     # retrieve the reference the head points to
     master.commit               # from here you use it as any other reference
+    
+Access the reflog easily::
+    
+    log = master.log()
+    log[0]                      # first (i.e. oldest) reflog entry
+    log[-1]                     # last (i.e. most recent) reflog entry
+    
+For more information on the reflog, see the ``RefLog`` type's documentation.
 
 Modifying References
 ********************

index/base.py

@@ -3,8 +3,6 @@
 #
 # This module is part of GitPython and is released under
 # the BSD License: http://www.opensource.org/licenses/bsd-license.php
-"""Module containing Index implementation, allowing to perform all kinds of index
-manipulations such as querying and merging."""
 import tempfile
 import os
 import sys

index/fun.py

@@ -1,7 +1,6 @@
-"""
-Contains standalone functions to accompany the index implementation and make it
-more versatile
-"""
+# Contains standalone functions to accompany the index implementation and make it
+# more versatile
+# NOTE: Autodoc hates it if this is a docstring
 from stat import (
 					S_IFDIR,
 					S_IFLNK,

objects/__init__.py

@@ -7,6 +7,7 @@
 # imported by the submodule.base
 import submodule.util
 submodule.util.IndexObject = IndexObject
+submodule.util.Object = Object
 from submodule.base import *
 from submodule.root import *
 
@@ -15,7 +16,6 @@
 from blob import *
 from commit import *
 from tree import *
-from util import Actor
 
 __all__ = [ name for name, obj in locals().items()
             if not (name.startswith('_') or inspect.ismodule(obj)) ]

objects/base.py

@@ -57,6 +57,10 @@ def new_from_sha(cls, repo, sha1):
 		:return: new object instance of a type appropriate to represent the given 
 			binary sha1
 		:param sha1: 20 byte binary sha1"""
+		if sha1 == cls.NULL_BIN_SHA:
+			# the NULL binsha is always the root commit
+			return get_object_type_by_name('commit')(repo, sha1)
+		#END handle special case
 		oinfo = repo.odb.info(sha1)
 		inst = get_object_type_by_name(oinfo.type)(repo, oinfo.binsha)
 		inst.size = oinfo.size

objects/commit.py

@@ -4,7 +4,8 @@
 # This module is part of GitPython and is released under
 # the BSD License: http://www.opensource.org/licenses/bsd-license.php
 
-from git.util import (
+from git.util import 		(
+							Actor,
 							Iterable,
 							Stats,
 						)
@@ -20,9 +21,7 @@
 from util import (
 						Traversable,
 						Serializable,
-						get_user_id,
 						parse_date,
-						Actor,
 						altz_to_utctz_str,
 						parse_actor_and_date
 					)
@@ -43,17 +42,10 @@ class Commit(base.Object, Iterable, Diffable, Traversable, Serializable):
 
 	# ENVIRONMENT VARIABLES
 	# read when creating new commits
-	env_author_name = "GIT_AUTHOR_NAME"
-	env_author_email = "GIT_AUTHOR_EMAIL"
 	env_author_date = "GIT_AUTHOR_DATE"
-	env_committer_name = "GIT_COMMITTER_NAME"
-	env_committer_email = "GIT_COMMITTER_EMAIL"
 	env_committer_date = "GIT_COMMITTER_DATE"
-	env_email = "EMAIL"
 
 	# CONFIGURATION KEYS
-	conf_name = 'name'
-	conf_email = 'email'
 	conf_encoding = 'i18n.commitencoding'
 
 	# INVARIANTS
@@ -306,17 +298,9 @@ def create_from_tree(cls, repo, tree, message, parent_commits=None, head=False):
 		# COMMITER AND AUTHOR INFO
 		cr = repo.config_reader()
 		env = os.environ
-		default_email = get_user_id()
-		default_name = default_email.split('@')[0]
 
-		conf_name = cr.get_value('user', cls.conf_name, default_name)
-		conf_email = cr.get_value('user', cls.conf_email, default_email)
-		
-		author_name = env.get(cls.env_author_name, conf_name)
-		author_email = env.get(cls.env_author_email, conf_email)
-		
-		committer_name = env.get(cls.env_committer_name, conf_name)
-		committer_email = env.get(cls.env_committer_email, conf_email)
+		committer = Actor.committer(cr)
+		author = Actor.author(cr)
 
 		# PARSE THE DATES
 		unix_time = int(time())
@@ -340,9 +324,6 @@ def create_from_tree(cls, repo, tree, message, parent_commits=None, head=False):
 		enc_section, enc_option = cls.conf_encoding.split('.')
 		conf_encoding = cr.get_value(enc_section, enc_option, cls.default_encoding)
 
-		author = Actor(author_name, author_email)
-		committer = Actor(committer_name, committer_email)
-		
 
 		# if the tree is no object, make sure we create one - otherwise
 		# the created commit object is invalid

objects/submodule/base.py

@@ -14,6 +14,7 @@
 						join_path_native, 
 						to_native_path_linux
 					)
+
 from git.config import SectionConstraint
 from git.exc import (
 					InvalidGitRepositoryError, 
@@ -339,14 +340,7 @@ def update(self, recursive=False, init=True, to_latest_revision=False):
 
 				# have a valid branch, but no checkout - make sure we can figure
 				# that out by marking the commit with a null_sha
-				# have to write it directly as .commit = NULLSHA tries to resolve the sha
-				# This will bring the branch into existance
-				refpath = join_path_native(mrepo.git_dir, local_branch.path)
-				refdir = os.path.dirname(refpath)
-				if not os.path.isdir(refdir):
-					os.makedirs(refdir)
-				#END handle directory
-				open(refpath, 'w').write(self.NULL_HEX_SHA)
+				local_branch.set_object(util.Object(mrepo, self.NULL_BIN_SHA))
 				# END initial checkout + branch creation
 
 				# make sure HEAD is not detached

objects/submodule/root.py

@@ -48,8 +48,7 @@ def update(self, previous_commit=None, recursive=True, force_remove=False, init=
 		
 		:param previous_commit: If set to a commit'ish, the commit we should use 
 			as the previous commit the HEAD pointed to before it was set to the commit it points to now. 
-			If None, it defaults to ORIG_HEAD otherwise, or the parent of the current
-			commit if it is not given
+			If None, it defaults to HEAD@{1} otherwise
 		:param recursive: if True, the children of submodules will be updated as well
 			using the same technique
 		:param force_remove: If submodules have been deleted, they will be forcibly removed.

objects/util.py

@@ -4,19 +4,21 @@
 # This module is part of GitPython and is released under
 # the BSD License: http://www.opensource.org/licenses/bsd-license.php
 """Module for general utility functions"""
-from git.util import IterableList
+from git.util import (
+						IterableList, 
+						Actor
+					)
 
 import re
 from collections import deque as Deque
-import platform
 
 from string import digits
 import time
 import os
 
-__all__ = ('get_object_type_by_name', 'get_user_id', 'parse_date', 'parse_actor_and_date', 
+__all__ = ('get_object_type_by_name', 'parse_date', 'parse_actor_and_date', 
 			'ProcessStreamAdapter', 'Traversable', 'altz_to_utctz_str', 'utctz_to_altz', 
-			'verify_utctz')
+			'verify_utctz', 'Actor')
 
 #{ Functions
 
@@ -57,21 +59,9 @@ def get_object_type_by_name(object_type_name):
 	else:
 		raise ValueError("Cannot handle unknown object type: %s" % object_type_name)
 
-
-def get_user_id():
-	""":return: string identifying the currently active system user as name@node
-	:note: user can be set with the 'USER' environment variable, usually set on windows"""
-	ukn = 'UNKNOWN'
-	username = os.environ.get('USER', os.environ.get('USERNAME', ukn))
-	if username == ukn and hasattr(os, 'getlogin'):
-		username = os.getlogin()
-	# END get username from login
-	return "%s@%s" % (username, platform.node())
-		
-
 def utctz_to_altz(utctz):
 	"""we convert utctz to the timezone in seconds, it is the format time.altzone
-	returns. Git stores it as UTC timezon which has the opposite sign as well, 
+	returns. Git stores it as UTC timezone which has the opposite sign as well, 
 	which explains the -1 * ( that was made explicit here )
 	:param utctz: git utc timezone string, i.e. +0200"""
 	return -1 * int(float(utctz)/100*3600)
@@ -193,56 +183,6 @@ def parse_actor_and_date(line):
 
 
 #{ Classes 
-
-class Actor(object):
-    """Actors hold information about a person acting on the repository. They 
-    can be committers and authors or anything with a name and an email as 
-    mentioned in the git log entries."""
-    # precompiled regex
-    name_only_regex = re.compile( r'<(.+)>' )
-    name_email_regex = re.compile( r'(.*) <(.+?)>' ) 
-    
-    def __init__(self, name, email):
-        self.name = name
-        self.email = email
-
-    def __eq__(self, other):
-        return self.name == other.name and self.email == other.email
-        
-    def __ne__(self, other):
-        return not (self == other)
-        
-    def __hash__(self):
-        return hash((self.name, self.email))
-
-    def __str__(self):
-        return self.name
-
-    def __repr__(self):
-        return '<git.Actor "%s <%s>">' % (self.name, self.email)
-
-    @classmethod
-    def _from_string(cls, string):
-        """Create an Actor from a string.
-		:param string: is the string, which is expected to be in regular git format
-
-				John Doe <[email protected]>
-				
-		:return: Actor """
-        m = cls.name_email_regex.search(string)
-        if m:
-            name, email = m.groups()
-            return Actor(name, email)
-        else:
-            m = cls.name_only_regex.search(string)
-            if m:
-                return Actor(m.group(1), None)
-            else:
-                # assume best and use the whole string as name
-                return Actor(string, None)
-            # END special case name
-        # END handle name/email matching
-	
 
 class ProcessStreamAdapter(object):
 	"""Class wireing all calls to the contained Process instance.
@@ -359,6 +299,7 @@ def addToStack( stack, item, branch_first, depth ):
 
 class Serializable(object):
 	"""Defines methods to serialize and deserialize objects from and into a data stream"""
+	__slots__ = tuple()
 
 	def _serialize(self, stream):
 		"""Serialize the data of this object into the given data stream