NotificationsYou must be signed in to change notification settings
Fork673
Star2.4k

Commit233b79e

committed

chore: explicitly import gitlab.v4.objects/cli

As we only support the v4 Gitlab API, explicitly importgitlab.v4.objects and gitlab.v4.clie instead of dynamically importingit depending on the API version.This has the added benefit of mypy being able to type check the Gitlab__init__() function as currently it will fail if we enable typechecking of __init__() it will fail.Also, this also helps by not confusing tools like pyinstaller/cx_freeze withdynamic imports so you don't need hooks for standalone executables. Andaccording tohttps://docs.gitlab.com/ee/api/, "GraphQL co-exists with the current v4 REST API. If we have a v5 API, this should be a compatibility layer on top of GraphQL."

1 parent5cc60d5 commit233b79eCopy full SHA for 233b79e

File tree

2 files changed

+29

-10

lines changed

gitlab
- cli.py
- client.py

2 files changed

+29

-10

lines changed

`‎gitlab/cli.py`

Lines changed: 13 additions & 6 deletions

Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,6 @@`
`19`	`19`
`20`	`20`	`importargparse`
`21`	`21`	`importfunctools`
`22`		`-importimportlib`
`23`	`22`	`importre`
`24`	`23`	`importsys`
`25`	`24`
`@@ -158,12 +157,18 @@ def docs():`
`158`	`157`	`sys.exit("Docs parser is only intended for build_sphinx")`
`159`	`158`
`160`	`159`	`parser=_get_base_parser(add_help=False)`
`161`		`-cli_module=importlib.import_module("gitlab.v4.cli")`
	`160`	`+# NOTE: We must delay import of gitlab.v4.cli until now or`
	`161`	`+# otherwise it will cause circular import errors`
	`162`	`+importgitlab.v4.cli`
`162`	`163`
`163`		`-return_get_parser(cli_module)`
	`164`	`+return_get_parser(gitlab.v4.cli)`
`164`	`165`
`165`	`166`
`166`	`167`	`defmain():`
	`168`	`+# NOTE: We must delay import of gitlab.v4.cli until now or`
	`169`	`+# otherwise it will cause circular import errors`
	`170`	`+importgitlab.v4.cli`
	`171`	`+`
`167`	`172`	`if"--version"insys.argv:`
`168`	`173`	`print(gitlab.__version__)`
`169`	`174`	`sys.exit(0)`
`@@ -181,10 +186,12 @@ def main():`
`181`	`186`	`parser.print_help()`
`182`	`187`	`sys.exit(0)`
`183`	`188`	`sys.exit(e)`
`184`		`-cli_module=importlib.import_module("gitlab.v%s.cli"%config.api_version)`
	`189`	`+# We only support v4 API at this time`
	`190`	`+ifconfig.api_versionnotin ("4",):`
	`191`	`+raiseModuleNotFoundError(name="gitlab.v%s.cli"%self._api_version)`
`185`	`192`
`186`	`193`	`# Now we build the entire set of subcommands and do the complete parsing`
`187`		`-parser=_get_parser(cli_module)`
	`194`	`+parser=_get_parser(gitlab.v4.cli)`
`188`	`195`	`try:`
`189`	`196`	`importargcomplete`
`190`	`197`
`@@ -229,6 +236,6 @@ def main():`
`229`	`236`	`ifdebug:`
`230`	`237`	`gl.enable_debug()`
`231`	`238`
`232`		`-cli_module.run(gl,what,action,args,verbose,output,fields)`
	`239`	`+gitlab.v4.cli.run(gl,what,action,args,verbose,output,fields)`
`233`	`240`
`234`	`241`	`sys.exit(0)`

`‎gitlab/client.py`

Lines changed: 16 additions & 4 deletions

Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,6 @@`
`16`	`16`	`# along with this program. If not, see <http://www.gnu.org/licenses/>.`
`17`	`17`	`"""Wrapper for the GitLab API."""`
`18`	`18`
`19`		`-importimportlib`
`20`	`19`	`importtime`
`21`	`20`
`22`	`21`	`importrequests`
`@@ -99,7 +98,14 @@ def __init__(`
`99`	`98`	`self.pagination=pagination`
`100`	`99`	`self.order_by=order_by`
`101`	`100`
`102`		`-objects=importlib.import_module("gitlab.v%s.objects"%self._api_version)`
	`101`	`+# We only support v4 API at this time`
	`102`	`+ifself._api_versionnotin ("4",):`
	`103`	`+raiseModuleNotFoundError(name="gitlab.v%s.objects"%self._api_version)`
	`104`	`+# NOTE: We must delay import of gitlab.v4.objects until now or`
	`105`	`+# otherwise it will cause circular import errors`
	`106`	`+importgitlab.v4.objects`
	`107`	`+`
	`108`	`+objects=gitlab.v4.objects`
`103`	`109`	`self._objects=objects`
`104`	`110`
`105`	`111`	`self.broadcastmessages=objects.BroadcastMessageManager(self)`
`@@ -147,8 +153,14 @@ def __getstate__(self):`
`147`	`153`
`148`	`154`	`def__setstate__(self,state):`
`149`	`155`	`self.__dict__.update(state)`
`150`		`-objects=importlib.import_module("gitlab.v%s.objects"%self._api_version)`
`151`		`-self._objects=objects`
	`156`	`+# We only support v4 API at this time`
	`157`	`+ifself._api_versionnotin ("4",):`
	`158`	`+raiseModuleNotFoundError(name="gitlab.v%s.objects"%self._api_version)`
	`159`	`+# NOTE: We must delay import of gitlab.v4.objects until now or`
	`160`	`+# otherwise it will cause circular import errors`
	`161`	`+importgitlab.v4.objects`
	`162`	`+`
	`163`	`+self._objects=gitlab.v4.objects`
`152`	`164`
`153`	`165`	`@property`
`154`	`166`	`defurl(self):`

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!

Commit233b79e

File tree

2 files changed

2 files changed

`‎gitlab/cli.py`

`‎gitlab/client.py`

0 commit comments