Commit3203cd7

committed

Fixed doc strings, improved error checking on RefLog.write method

1 parent98a3133 commit3203cd7Copy full SHA for 3203cd7

File tree

4 files changed

+23

-9

lines changed

4 files changed

+23

-9

lines changed

`‎refs/log.py‎`

Lines changed: 9 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -182,6 +182,7 @@ def entry_at(cls, filepath, index):`
`182`	`182`	`specifiy an entry counted from the end of the list`
`183`	`183`
`184`	`184`	`:raise IndexError: If the entry didn't exist`
	`185`	`+`
`185`	`186`	`.. note:: This method is faster as it only parses the entry at index, skipping`
`186`	`187`	`all other lines. Nonetheless, the whole file has to be read if`
`187`	`188`	`the index is negative`
`@@ -224,6 +225,7 @@ def to_file(self, filepath):`
`224`	`225`	`@classmethod`
`225`	`226`	`defappend_entry(cls,config_reader,filepath,oldbinsha,newbinsha,message):`
`226`	`227`	`"""Append a new log entry to the revlog at filepath.`
	`228`	`+`
`227`	`229`	`:param config_reader: configuration reader of the repository - used to obtain`
`228`	`230`	`user information. May be None`
`229`	`231`	`:param filepath: full path to the log file`
`@@ -255,8 +257,13 @@ def append_entry(cls, config_reader, filepath, oldbinsha, newbinsha, message):`
`255`	`257`	`returnentry`
`256`	`258`
`257`	`259`	`defwrite(self):`
`258`		`-"""Write this instance's data to the file we are originating from"""`
`259`		`-returnself.to_file(self._path)`
	`260`	`+"""Write this instance's data to the file we are originating from`
	`261`	`+:return: self"""`
	`262`	`+ifself._pathisNone:`
	`263`	`+raiseValueError("Instance was not initialized with a path, use to_file(...) instead")`
	`264`	`+#END assert path`
	`265`	`+self.to_file(self._path)`
	`266`	`+returnself`
`260`	`267`
`261`	`268`	`#} END interface`
`262`	`269`

`‎refs/symbolic.py‎`

Lines changed: 2 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -174,6 +174,7 @@ def _get_commit(self):`
`174`	`174`
`175`	`175`	`defset_commit(self,commit,logmsg=None):`
`176`	`176`	`"""As set_object, but restricts the type of object to be a Commit`
	`177`	`+`
`177`	`178`	`:raise ValueError: If commit is not a Commit object or doesn't point to`
`178`	`179`	`a commit`
`179`	`180`	`:return: self"""`
`@@ -345,6 +346,7 @@ def log(self):`
`345`	`346`
`346`	`347`	`deflog_append(self,oldbinsha,message,newbinsha=None):`
`347`	`348`	`"""Append a logentry to the logfile of this ref`
	`349`	`+`
`348`	`350`	`:param oldbinsha: binary sha this ref used to point to`
`349`	`351`	`:param message: A message describing the change`
`350`	`352`	`:param newbinsha: The sha the ref points to now. If None, our current commit sha`

`‎test/test_reflog.py‎`

Lines changed: 3 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -56,6 +56,8 @@ def test_base(self):`
`56`	`56`	`self.failUnlessRaises(ValueError,RefLog.from_file,fixture_path(pp+suffix))`
`57`	`57`	`#END for each invalid file`
`58`	`58`
	`59`	`+# cannot write an uninitialized reflog`
	`60`	`+self.failUnlessRaises(ValueError,RefLog().write)`
`59`	`61`
`60`	`62`	`# test serialize and deserialize - results must match exactly`
`61`	`63`	`binsha=chr(255)*20`
`@@ -65,6 +67,7 @@ def test_base(self):`
`65`	`67`	`reflog=RefLog.from_file(rlp)`
`66`	`68`	`tfile=os.path.join(tdir,os.path.basename(rlp))`
`67`	`69`	`reflog.to_file(tfile)`
	`70`	`+assertreflog.write()isreflog`
`68`	`71`
`69`	`72`	`# parsed result must match ...`
`70`	`73`	`treflog=RefLog.from_file(tfile)`

`‎util.py‎`

Lines changed: 9 additions & 7 deletions

Original file line number	Diff line number	Diff line change
`@@ -69,9 +69,10 @@ def to_native_path_linux(path):`
`69`	`69`	`to_native_path=to_native_path_linux`
`70`	`70`
`71`	`71`	`defjoin_path_native(a,*p):`
`72`		`-"""As join path, but makes sure an OS native path is returned. This is only`
`73`		`-needed to play it safe on my dear windows and to assure nice paths that only`
`74`		`-use '\'"""`
	`72`	`+"""`
	`73`	`+As join path, but makes sure an OS native path is returned. This is only`
	`74`	`+needed to play it safe on my dear windows and to assure nice paths that only`
	`75`	`+use '\'"""`
`75`	`76`	`returnto_native_path(join_path(a,*p))`
`76`	`77`
`77`	`78`	`defassure_directory_exists(path,is_file=False):`
`@@ -187,10 +188,11 @@ def _main_actor(cls, env_name, env_email, config_reader=None):`
`187`	`188`
`188`	`189`	`@classmethod`
`189`	`190`	`defcommitter(cls,config_reader=None):`
`190`		`-""":return: Actor instance corresponding to the configured committer. It behaves`
`191`		`-similar to the git implementation, such that the environment will override`
`192`		`-configuration values of config_reader. If no value is set at all, it will be`
`193`		`-generated`
	`191`	`+"""`
	`192`	`+:return: Actor instance corresponding to the configured committer. It behaves`
	`193`	`+similar to the git implementation, such that the environment will override`
	`194`	`+configuration values of config_reader. If no value is set at all, it will be`
	`195`	`+generated`
`194`	`196`	`:param config_reader: ConfigReader to use to retrieve the values from in case`
`195`	`197`	`they are not set in the environment"""`
`196`	`198`	`returncls._main_actor(cls.env_committer_name,cls.env_committer_email,config_reader)`

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!

Commit3203cd7

File tree

4 files changed

4 files changed

`‎refs/log.py‎`

`‎refs/symbolic.py‎`

`‎test/test_reflog.py‎`

`‎util.py‎`

0 commit comments