Commitbca0cb7

committed

Improved documentation on Actor and Blob

1 parent4c39f9d commitbca0cb7Copy full SHA for bca0cb7

File tree

2 files changed

+20

-0

lines changed

lib/git
- actor.py
- blob.py

2 files changed

+20

-0

lines changed

`‎lib/git/actor.py`

Lines changed: 3 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,9 @@`
`7`	`7`	`importre`
`8`	`8`
`9`	`9`	`classActor(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`
	`12`	`+ mentioned in the git log entries."""`
`10`	`13`	`def__init__(self,name,email):`
`11`	`14`	`self.name=name`
`12`	`15`	`self.email=email`

`‎lib/git/blob.py`

Lines changed: 17 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,7 @@`
`12`	`12`	`fromcommitimportCommit`
`13`	`13`
`14`	`14`	`classBlob(object):`
	`15`	`+"""A Blob encapsulates a git blob object"""`
`15`	`16`	`DEFAULT_MIME_TYPE="text/plain"`
`16`	`17`
`17`	`18`	`def__init__(self,repo,id,mode=None,name=None):`
`@@ -48,6 +49,9 @@ def size(self):`
`48`	`49`
`49`	`50`	`Returns`
`50`	`51`	`int`
	`52`	`+`
	`53`	`+ NOTE`
	`54`	`+ The size will be cached after the first access`
`51`	`55`	`"""`
`52`	`56`	`ifself._sizeisNone:`
`53`	`57`	`self._size=int(self.repo.git.cat_file(self.id,s=True).rstrip())`
`@@ -60,6 +64,9 @@ def data(self):`
`60`	`64`
`61`	`65`	`Returns`
`62`	`66`	`str`
	`67`	`+`
	`68`	`+ NOTE`
	`69`	`+ The data will be cached after the first access.`
`63`	`70`	`"""`
`64`	`71`	`self.data_stored=self.data_storedorself.repo.git.cat_file(self.id,p=True,with_raw_output=True)`
`65`	`72`	`returnself.data_stored`
`@@ -71,6 +78,9 @@ def mime_type(self):`
`71`	`78`
`72`	`79`	`Returns`
`73`	`80`	`str`
	`81`	`+`
	`82`	`+ NOTE`
	`83`	`+ Defaults to 'text/plain' in case the actual file type is unknown.`
`74`	`84`	`"""`
`75`	`85`	`guesses=None`
`76`	`86`	`ifself.name:`
`@@ -79,6 +89,10 @@ def mime_type(self):`
`79`	`89`
`80`	`90`	`@property`
`81`	`91`	`defbasename(self):`
	`92`	`+"""`
	`93`	`+ Returns`
	`94`	`+ The basename of the Blobs file name`
	`95`	`+ """`
`82`	`96`	`returnos.path.basename(self.name)`
`83`	`97`
`84`	`98`	`@classmethod`
`@@ -88,6 +102,9 @@ def blame(cls, repo, commit, file):`
`88`	`102`
`89`	`103`	`Returns`
`90`	`104`	`list: [git.Commit, list: [<line>]]`
	`105`	`+ A list of tuples associating a Commit object with a list of lines that`
	`106`	`+ changed within the given commit. The Commit objects will be given in order`
	`107`	`+ of appearance.`
`91`	`108`	`"""`
`92`	`109`	`data=repo.git.blame(commit,'--',file,p=True)`
`93`	`110`	`commits= {}`

0 commit comments

Comments

(0)

Movatterモバイル変換

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Commitbca0cb7

File tree

2 files changed

2 files changed

`‎lib/git/actor.py`

`‎lib/git/blob.py`

0 commit comments