| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -10,5 +10,6 @@ Contributors are: | |||
| 10 | 10 | -Steve Frécinaux <code _at_ istique.net> | |
| 11 | 11 | -Kai Lautaportti <kai _at_ lautaportti.fi> | |
| 12 | 12 | -Paul Sowden <paul _at_ idontsmoke.co.uk> | |
| 13 | + -Sebastian Thiel http://www.linkedin.com/in/sebastianthiel | ||
| 13 | 14 | ||
| 14 | 15 | Portions derived from other open source works and are clearly marked. | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1,4 +1,4 @@ | |||
| 1 | - Copyright (C) 2008, 2009 Michael Trier and contributors | ||
| 1 | + Copyright (C) 2008-2010 Michael Trier and contributors | ||
| 2 | 2 | All rights reserved. | |
| 3 | 3 | ||
| 4 | 4 | Redistribution and use in source and binary forms, with or without | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -23,7 +23,7 @@ REQUIREMENTS | |||
| 23 | 23 | INSTALL | |
| 24 | 24 | ======= | |
| 25 | 25 | ||
| 26 | - python setup.py install | ||
| 26 | + python setup.py install | ||
| 27 | 27 | ||
| 28 | 28 | SOURCE | |
| 29 | 29 | ====== | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -4,32 +4,32 @@ TODO | |||
| 4 | 4 | ||
| 5 | 5 | General | |
| 6 | 6 | ------- | |
| 7 | - * Classes requiring repo actually only need the git command - this should be | ||
| 7 | + * Classes requiring repo actually only need the git command - this should be | ||
| 8 | 8 | changed to limit their access level and make things a little safer. | |
| 9 | - * Check for correct usage of id, ref and hexsha and define their meanings, | ||
| 10 | - currently its not so clear what id may be in cases or not - afaik its usually | ||
| 9 | + * Check for correct usage of id, ref and hexsha and define their meanings, | ||
| 10 | + currently its not so clear what id may be in cases or not - afaik its usually | ||
| 11 | 11 | a sha or ref unless cat-file is used where it must be a sha | |
| 12 | 12 | * Derive all Object like items like types such as Commit, Tag(Object), Tree, Blob | |
| 13 | - from a common base. This allows to easily add __eq__, __ne__, __hash__ method | ||
| 13 | + from a common base. This allows to easily add __eq__, __ne__, __hash__ method | ||
| 14 | 14 | to make their use more comfortable and reduces code duplication. | |
| 15 | 15 | * References like Tag(Reference), Heads and Remotes should have an own Base class | |
| 16 | - * Optimize type size by adding __slots__ ( at least ), which would also make sure | ||
| 16 | + * Optimize type size by adding __slots__ ( at least ), which would also make sure | ||
| 17 | 17 | no one accidentally adds attributes to classes. | |
| 18 | 18 | * Add more performance tests, see branch "performance_testing" | |
| 19 | 19 | ||
| 20 | 20 | Configuration | |
| 21 | 21 | ------------- | |
| 22 | - * Native configuration handling, ideally without using git-config for it to keep | ||
| 22 | + * Native configuration handling, ideally without using git-config for it to keep | ||
| 23 | 23 | handling fast | |
| 24 | - | ||
| 24 | + | ||
| 25 | 25 | Docs | |
| 26 | 26 | ---- | |
| 27 | 27 | Overhaul docs - check examples, check looks, improve existing docs | |
| 28 | 28 | ||
| 29 | 29 | Remotes | |
| 30 | 30 | ------- | |
| 31 | - * Remote handling should be rather easy to implement as it is 'just' another | ||
| 32 | - type of reference. It will be more work to do it right and allow convenient | ||
| 31 | + * Remote handling should be rather easy to implement as it is 'just' another | ||
| 32 | + type of reference. It will be more work to do it right and allow convenient | ||
| 33 | 33 | access to the most common operations on remotes though. | |
| 34 | 34 | ||
| 35 | 35 | Submodules | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -43,7 +43,7 @@ | |||
| 43 | 43 | ||
| 44 | 44 | # General information about the project. | |
| 45 | 45 | project = u'GitPython' | |
| 46 | - copyright = u'Copyright (C) 2008, 2009 Michael Trier and contributors' | ||
| 46 | + copyright = u'Copyright (C) 2008-2010 Michael Trier and contributors' | ||
| 47 | 47 | ||
| 48 | 48 | # The version info for the project you're documenting, acts as replacement for | |
| 49 | 49 | # |version| and |release|, also used in various other places throughout the | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1,5 +1,5 @@ | |||
| 1 | 1 | # __init__.py | |
| 2 | - # Copyright (C) 2008, 2009 Michael Trier (mtrier@gmail.com) and contributors | ||
| 2 | + # Copyright (C) 2008-2010 Michael Trier (mtrier@gmail.com) and contributors | ||
| 3 | 3 | # | |
| 4 | 4 | # This module is part of GitPython and is released under | |
| 5 | 5 | # the BSD License: http://www.opensource.org/licenses/bsd-license.php | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1,14 +1,14 @@ | |||
| 1 | 1 | # actor.py | |
| 2 | - # Copyright (C) 2008, 2009 Michael Trier (mtrier@gmail.com) and contributors | ||
| 2 | + # Copyright (C) 2008-2010 Michael Trier (mtrier@gmail.com) and contributors | ||
| 3 | 3 | # | |
| 4 | 4 | # This module is part of GitPython and is released under | |
| 5 | 5 | # the BSD License: http://www.opensource.org/licenses/bsd-license.php | |
| 6 | 6 | ||
| 7 | 7 | import re | |
| 8 | 8 | ||
| 9 | 9 | class Actor(object): | |
| 10 | - """Actors hold information about a person acting on the repository. They | ||
| 11 | - can be committers and authors or anything with a name and an email as | ||
| 10 | + """Actors hold information about a person acting on the repository. They | ||
| 11 | + can be committers and authors or anything with a name and an email as | ||
| 12 | 12 | mentioned in the git log entries.""" | |
| 13 | 13 | def __init__(self, name, email): | |
| 14 | 14 | self.name = name | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1,5 +1,5 @@ | |||
| 1 | 1 | # blob.py | |
| 2 | - # Copyright (C) 2008, 2009 Michael Trier (mtrier@gmail.com) and contributors | ||
| 2 | + # Copyright (C) 2008-2010 Michael Trier (mtrier@gmail.com) and contributors | ||
| 3 | 3 | # | |
| 4 | 4 | # This module is part of GitPython and is released under | |
| 5 | 5 | # the BSD License: http://www.opensource.org/licenses/bsd-license.php | |
@@ -49,7 +49,7 @@ def size(self): | |||
| 49 | 49 | ||
| 50 | 50 | Returns | |
| 51 | 51 | int | |
| 52 | - | ||
| 52 | + | ||
| 53 | 53 | NOTE | |
| 54 | 54 | The size will be cached after the first access | |
| 55 | 55 | """ | |
@@ -64,7 +64,7 @@ def data(self): | |||
| 64 | 64 | ||
| 65 | 65 | Returns | |
| 66 | 66 | str | |
| 67 | - | ||
| 67 | + | ||
| 68 | 68 | NOTE | |
| 69 | 69 | The data will be cached after the first access. | |
| 70 | 70 | """ | |
@@ -78,7 +78,7 @@ def mime_type(self): | |||
| 78 | 78 | ||
| 79 | 79 | Returns | |
| 80 | 80 | str | |
| 81 | - | ||
| 81 | + | ||
| 82 | 82 | NOTE | |
| 83 | 83 | Defaults to 'text/plain' in case the actual file type is unknown. | |
| 84 | 84 | """ | |
@@ -102,7 +102,7 @@ def blame(cls, repo, commit, file): | |||
| 102 | 102 | ||
| 103 | 103 | Returns | |
| 104 | 104 | list: [git.Commit, list: [<line>]] | |
| 105 | - A list of tuples associating a Commit object with a list of lines that | ||
| 105 | + A list of tuples associating a Commit object with a list of lines that | ||
| 106 | 106 | changed within the given commit. The Commit objects will be given in order | |
| 107 | 107 | of appearance. | |
| 108 | 108 | """ | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1,5 +1,5 @@ | |||
| 1 | 1 | # cmd.py | |
| 2 | - # Copyright (C) 2008, 2009 Michael Trier (mtrier@gmail.com) and contributors | ||
| 2 | + # Copyright (C) 2008-2010 Michael Trier (mtrier@gmail.com) and contributors | ||
| 3 | 3 | # | |
| 4 | 4 | # This module is part of GitPython and is released under | |
| 5 | 5 | # the BSD License: http://www.opensource.org/licenses/bsd-license.php | |
@@ -23,32 +23,32 @@ | |||
| 23 | 23 | class Git(object): | |
| 24 | 24 | """ | |
| 25 | 25 | The Git class manages communication with the Git binary. | |
| 26 | - | ||
| 26 | + | ||
| 27 | 27 | It provides a convenient interface to calling the Git binary, such as in:: | |
| 28 | - | ||
| 28 | + | ||
| 29 | 29 | g = Git( git_dir ) | |
| 30 | 30 | g.init() # calls 'git init' program | |
| 31 | 31 | rval = g.ls_files() # calls 'git ls-files' program | |
| 32 | - | ||
| 32 | + | ||
| 33 | 33 | ``Debugging`` | |
| 34 | - Set the GIT_PYTHON_TRACE environment variable print each invocation | ||
| 34 | + Set the GIT_PYTHON_TRACE environment variable print each invocation | ||
| 35 | 35 | of the command to stdout. | |
| 36 | 36 | Set its value to 'full' to see details about the returned values. | |
| 37 | 37 | """ | |
| 38 | 38 | def __init__(self, git_dir=None): | |
| 39 | 39 | """ | |
| 40 | 40 | Initialize this instance with: | |
| 41 | - | ||
| 41 | + | ||
| 42 | 42 | ``git_dir`` | |
| 43 | - Git directory we should work in. If None, we always work in the current | ||
| 43 | + Git directory we should work in. If None, we always work in the current | ||
| 44 | 44 | directory as returned by os.getcwd() | |
| 45 | 45 | """ | |
| 46 | 46 | super(Git, self).__init__() | |
| 47 | 47 | self.git_dir = git_dir | |
| 48 | 48 | ||
| 49 | 49 | def __getattr__(self, name): | |
| 50 | 50 | """ | |
| 51 | - A convenience method as it allows to call the command as if it was | ||
| 51 | + A convenience method as it allows to call the command as if it was | ||
| 52 | 52 | an object. | |
| 53 | 53 | Returns | |
| 54 | 54 | Callable object that will execute call _call_process with your arguments. | |
@@ -99,15 +99,15 @@ def execute(self, command, | |||
| 99 | 99 | Whether to avoid stripping off trailing whitespace. | |
| 100 | 100 | ||
| 101 | 101 | Returns:: | |
| 102 | - | ||
| 102 | + | ||
| 103 | 103 | str(output) # extended_output = False (Default) | |
| 104 | 104 | tuple(int(status), str(stdout), str(stderr)) # extended_output = True | |
| 105 | - | ||
| 105 | + | ||
| 106 | 106 | Raise | |
| 107 | - GitCommandError | ||
| 108 | - | ||
| 107 | + GitCommandError | ||
| 108 | + | ||
| 109 | 109 | NOTE | |
| 110 | - If you add additional keyword arguments to the signature of this method, | ||
| 110 | + If you add additional keyword arguments to the signature of this method, | ||
| 111 | 111 | you must update the execute_kwargs tuple housed in this module. | |
| 112 | 112 | """ | |
| 113 | 113 | if GIT_PYTHON_TRACE and not GIT_PYTHON_TRACE == 'full': | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1,5 +1,5 @@ | |||
| 1 | 1 | # commit.py | |
| 2 | - # Copyright (C) 2008, 2009 Michael Trier (mtrier@gmail.com) and contributors | ||
| 2 | + # Copyright (C) 2008-2010 Michael Trier (mtrier@gmail.com) and contributors | ||
| 3 | 3 | # | |
| 4 | 4 | # This module is part of GitPython and is released under | |
| 5 | 5 | # the BSD License: http://www.opensource.org/licenses/bsd-license.php | |
@@ -16,16 +16,16 @@ | |||
| 16 | 16 | class Commit(LazyMixin): | |
| 17 | 17 | """ | |
| 18 | 18 | Wraps a git Commit object. | |
| 19 | - | ||
| 20 | - This class will act lazily on some of its attributes and will query the | ||
| 19 | + | ||
| 20 | + This class will act lazily on some of its attributes and will query the | ||
| 21 | 21 | value on demand only if it involves calling the git binary. | |
| 22 | 22 | """ | |
| 23 | 23 | def __init__(self, repo, id, tree=None, author=None, authored_date=None, | |
| 24 | 24 | committer=None, committed_date=None, message=None, parents=None): | |
| 25 | 25 | """ | |
| 26 | - Instantiate a new Commit. All keyword arguments taking None as default will | ||
| 27 | - be implicitly set if id names a valid sha. | ||
| 28 | - | ||
| 26 | + Instantiate a new Commit. All keyword arguments taking None as default will | ||
| 27 | + be implicitly set if id names a valid sha. | ||
| 28 | + | ||
| 29 | 29 | The parameter documentation indicates the type of the argument after a colon ':'. | |
| 30 | 30 | ||
| 31 | 31 | ``id`` | |
@@ -75,7 +75,7 @@ def __init__(self, repo, id, tree=None, author=None, authored_date=None, | |||
| 75 | 75 | ||
| 76 | 76 | def __bake__(self): | |
| 77 | 77 | """ | |
| 78 | - Called by LazyMixin superclass when the first uninitialized member needs | ||
| 78 | + Called by LazyMixin superclass when the first uninitialized member needs | ||
| 79 | 79 | to be set as it is queried. | |
| 80 | 80 | """ | |
| 81 | 81 | temp = Commit.find_all(self.repo, self.id, max_count=1)[0] | |
@@ -133,7 +133,7 @@ def find_all(cls, repo, ref, path='', **kwargs): | |||
| 133 | 133 | is the ref from which to begin (SHA1 or name) | |
| 134 | 134 | ||
| 135 | 135 | ``path`` | |
| 136 | - is an optinal path, if set only Commits that include the path | ||
| 136 | + is an optinal path, if set only Commits that include the path | ||
| 137 | 137 | will be considered | |
| 138 | 138 | ||
| 139 | 139 | ``kwargs`` | |
@@ -210,9 +210,9 @@ def diff(cls, repo, a, b=None, paths=None): | |||
| 210 | 210 | ||
| 211 | 211 | Returns | |
| 212 | 212 | git.Diff[]:: | |
| 213 | - | ||
| 213 | + | ||
| 214 | 214 | between tree and the index if only a is given | |
| 215 | - between two trees if a and b are given and are commits | ||
| 215 | + between two trees if a and b are given and are commits | ||
| 216 | 216 | """ | |
| 217 | 217 | paths = paths or [] | |
| 218 | 218 | ||
@@ -234,7 +234,7 @@ def diffs(self): | |||
| 234 | 234 | """ | |
| 235 | 235 | Returns | |
| 236 | 236 | git.Diff[] | |
| 237 | - Diffs between this commit and its first parent or all changes if this | ||
| 237 | + Diffs between this commit and its first parent or all changes if this | ||
| 238 | 238 | commit is the first commit and has no parent. | |
| 239 | 239 | """ | |
| 240 | 240 | if not self.parents: | |
@@ -252,9 +252,9 @@ def diffs(self): | |||
| 252 | 252 | @property | |
| 253 | 253 | def stats(self): | |
| 254 | 254 | """ | |
| 255 | - Create a git stat from changes between this commit and its first parent | ||
| 255 | + Create a git stat from changes between this commit and its first parent | ||
| 256 | 256 | or from all changes done if this is the very first commit. | |
| 257 | - | ||
| 257 | + | ||
| 258 | 258 | Return | |
| 259 | 259 | git.Stats | |
| 260 | 260 | """ | |
| Back | FazBrowse Home | New Git URL |
0 commit comments