Commit20b2537

committed

chore: addpprint() andpformat() methods to RESTObject

This is useful in debugging and testing. As can easily print out thevalues from an instance in a more human-readable form.

1 parent9896340 commit20b2537Copy full SHA for 20b2537

File tree

+50

-0

lines changed

+50

-0

lines changed

Lines changed: 11 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -179,6 +179,17 @@ resources. For example:`
`179`	`179`	`project= gl.projects.get(1)`
`180`	`180`	`project.star()`
`181`	`181`
	`182`	`+You can print a Gitlab Object. For example:`
	`183`	`+`
	`184`	`+..code-block::python`
	`185`	`+`
	`186`	`+ project= gl.projects.get(1)`
	`187`	`+print(project)`
	`188`	`+# Or in a prettier format. These two are equivalent.`
	`189`	`+print(project.pformat())`
	`190`	`+ project.pprint()`
	`191`	`+`
	`192`	`+`
`182`	`193`	`Base types`
`183`	`194`	`==========`
`184`	`195`

Lines changed: 9 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,7 @@`
`16`	`16`	`# along with this program. If not, see <http://www.gnu.org/licenses/>.`
`17`	`17`
`18`	`18`	`importimportlib`
	`19`	`+importpprint`
`19`	`20`	`importtextwrap`
`20`	`21`	`fromtypesimportModuleType`
`21`	`22`	`fromtypingimportAny,Dict,Iterable,NamedTuple,Optional,Tuple,Type`
`@@ -147,6 +148,14 @@ def __str__(self) -> str:`
`147`	`148`	`data.update(self._updated_attrs)`
`148`	`149`	`returnf"{type(self)} =>{data}"`
`149`	`150`
	`151`	`+defpformat(self)->str:`
	`152`	`+data=self._attrs.copy()`
	`153`	`+data.update(self._updated_attrs)`
	`154`	`+returnf"{type(self)} =>\n{pprint.pformat(data)}"`
	`155`	`+`
	`156`	`+defpprint(self)->None:`
	`157`	`+print(self.pformat())`
	`158`	`+`
`150`	`159`	`def__repr__(self)->str:`
`151`	`160`	`ifself._id_attr:`
`152`	`161`	`returnf"<{self.__class__.__name__}{self._id_attr}:{self.get_id()}>"`

Lines changed: 30 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -201,3 +201,33 @@ def test_inequality_no_id(self, fake_manager):`
`201`	`201`	`obj1=FakeObject(fake_manager, {"attr1":"foo"})`
`202`	`202`	`obj2=FakeObject(fake_manager, {"attr1":"bar"})`
`203`	`203`	`assertobj1!=obj2`
	`204`	`+`
	`205`	`+deftest_dunder_str(self,fake_manager):`
	`206`	`+fake_object=FakeObject(fake_manager, {"attr1":"foo"})`
	`207`	`+assertstr(fake_object)== (`
	`208`	`+"<class 'tests.unit.test_base.FakeObject'> => {'attr1': 'foo'}"`
	`209`	`+ )`
	`210`	`+`
	`211`	`+deftest_pformat(self,fake_manager):`
	`212`	`+fake_object=FakeObject(`
	`213`	`+fake_manager, {"attr1":"foo"10,"ham":"eggs"15}`
	`214`	`+ )`
	`215`	`+assertfake_object.pformat()== (`
	`216`	`+"<class 'tests.unit.test_base.FakeObject'> => "`
	`217`	`+"\n{'attr1': 'foofoofoofoofoofoofoofoofoofoo',\n"`
	`218`	`+" 'ham': 'eggseggseggseggseggseggseggseggseggseggseggseggseggseggseggs'}"`
	`219`	`+ )`
	`220`	`+`
	`221`	`+deftest_pprint(self,capfd,fake_manager):`
	`222`	`+fake_object=FakeObject(`
	`223`	`+fake_manager, {"attr1":"foo"10,"ham":"eggs"15}`
	`224`	`+ )`
	`225`	`+result=fake_object.pprint()`
	`226`	`+assertresultisNone`
	`227`	`+stdout,stderr=capfd.readouterr()`
	`228`	`+assertstdout== (`
	`229`	`+"<class 'tests.unit.test_base.FakeObject'> => "`
	`230`	`+"\n{'attr1': 'foofoofoofoofoofoofoofoofoofoo',\n"`
	`231`	`+" 'ham': 'eggseggseggseggseggseggseggseggseggseggseggseggseggseggseggs'}\n"`
	`232`	`+ )`
	`233`	`+assertstderr==""`

Comments

(0)