Skip to content

Commit 89981c6

Browse files
JohnVillalovosJohnVillalovos
committed
chore: convert to using relative imports
Switch to using relative imports to ensure that we are importing from within our library. Also use the form: from foo import bar as bar When we want to signify that we want the import to be re-exported. https://mypy.readthedocs.io/en/stable/command_line.html#cmdoption-mypy-no-implicit-reexport
1 parent 789122d commit 89981c6

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

69 files changed

+298
-316
lines changed

‎gitlab/__init__.py‎

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -19,17 +19,18 @@
1919
import warnings
2020
from typing import Any
2121

22-
import gitlab.config # noqa: F401
23-
from gitlab.version import ( # noqa: F401
24-
__author__,
25-
__copyright__,
26-
__email__,
27-
__license__,
28-
__title__,
29-
__version__,
30-
)
31-
from gitlab.client import Gitlab, GitlabList # noqa: F401
32-
from gitlab.exceptions import * # noqa: F401,F403
22+
from . import config as config # noqa: F401
23+
from . import const as const
24+
from . import exceptions as exceptions # noqa: F401
25+
from .client import Gitlab as Gitlab # noqa: F401
26+
from .client import GitlabList as GitlabList # noqa: F401
27+
from .exceptions import * # noqa: F401,F403
28+
from .version import __author__ as __author__ # noqa: F401
29+
from .version import __copyright__ as __copyright__ # noqa: F401
30+
from .version import __email__ as __email__ # noqa: F401
31+
from .version import __license__ as __license__ # noqa: F401
32+
from .version import __title__ as __title__ # noqa: F401
33+
from .version import __version__ as __version__ # noqa: F401
3334

3435
warnings.filterwarnings("default", category=DeprecationWarning, module="^gitlab")
3536

@@ -39,12 +40,12 @@
3940
# 'from gitlab.const import *' statement.
4041
def __getattr__(name: str) -> Any:
4142
# Deprecate direct access to constants without namespace
42-
if name in gitlab.const._DEPRECATED:
43+
if name in const._DEPRECATED:
4344
warnings.warn(
4445
f"\nDirect access to 'gitlab.{name}' is deprecated and will be "
4546
f"removed in a future major python-gitlab release. Please "
4647
f"use 'gitlab.const.{name}' instead.",
4748
DeprecationWarning,
4849
)
49-
return getattr(gitlab.const, name)
50+
return getattr(const, name)
5051
raise AttributeError(f"module {__name__} has no attribute {name}")

‎gitlab/__main__.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import gitlab.cli
1+
from . import cli
22

33
if __name__ == "__main__":
4-
gitlab.cli.main()
4+
cli.main()

‎gitlab/base.py‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,10 @@
2020
from types import ModuleType
2121
from typing import Any, Dict, Iterable, NamedTuple, Optional, Tuple, Type
2222

23-
import gitlab
24-
from gitlab import types as g_types
25-
from gitlab.exceptions import GitlabParsingError
26-
2723
from .client import Gitlab, GitlabList
24+
from .exceptions import GitlabParsingError
25+
from .types import GitlabAttribute
26+
from .version import __version__
2827

2928
__all__ = [
3029
"RequiredOptional",
@@ -35,7 +34,7 @@
3534

3635

3736
_URL_ATTRIBUTE_ERROR = (
38-
f"https://python-gitlab.readthedocs.io/en/{gitlab.__version__}/"
37+
f"https://python-gitlab.readthedocs.io/en/{__version__}/"
3938
f"faq.html#attribute-error-list"
4039
)
4140

@@ -317,7 +316,7 @@ class RESTManager(object):
317316
_path: Optional[str] = None
318317
_obj_cls: Optional[Type[RESTObject]] = None
319318
_from_parent_attrs: Dict[str, Any] = {}
320-
_types: Dict[str, Type[g_types.GitlabAttribute]] = {}
319+
_types: Dict[str, Type[GitlabAttribute]] = {}
321320

322321
_computed_path: Optional[str]
323322
_parent: Optional[RESTObject]

‎gitlab/cli.py‎

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,10 @@
2727

2828
from requests.structures import CaseInsensitiveDict
2929

30-
import gitlab.config
31-
from gitlab.base import RESTObject
30+
from . import __version__
31+
from . import config as gl_config
32+
from .base import RESTObject
33+
from .client import Gitlab
3234

3335
# This regex is based on:
3436
# https://github.com/jpvanhal/inflection/blob/master/inflection/__init__.py
@@ -246,10 +248,10 @@ def _get_base_parser(add_help: bool = True) -> argparse.ArgumentParser:
246248
def _get_parser() -> argparse.ArgumentParser:
247249
# NOTE: We must delay import of gitlab.v4.cli until now or
248250
# otherwise it will cause circular import errors
249-
import gitlab.v4.cli
251+
from .v4 import cli
250252

251253
parser = _get_base_parser()
252-
return gitlab.v4.cli.extend_parser(parser)
254+
return cli.extend_parser(parser)
253255

254256

255257
def _parse_value(v: Any) -> Any:
@@ -279,7 +281,7 @@ def docs() -> argparse.ArgumentParser: # pragma: no cover
279281

280282
def main() -> None:
281283
if "--version" in sys.argv:
282-
print(gitlab.__version__)
284+
print(__version__)
283285
sys.exit(0)
284286

285287
parser = _get_base_parser(add_help=False)
@@ -289,8 +291,8 @@ def main() -> None:
289291
# any subparser setup
290292
(options, _) = parser.parse_known_args(sys.argv)
291293
try:
292-
config = gitlab.config.GitlabConfigParser(options.gitlab, options.config_file)
293-
except gitlab.config.ConfigError as e:
294+
config = gl_config.GitlabConfigParser(options.gitlab, options.config_file)
295+
except gl_config.ConfigError as e:
294296
if "--help" in sys.argv or "-h" in sys.argv:
295297
parser.print_help()
296298
sys.exit(0)
@@ -346,7 +348,7 @@ def main() -> None:
346348
args_dict = {k: _parse_value(v) for k, v in args_dict.items() if v is not None}
347349

348350
try:
349-
gl = gitlab.Gitlab.merge_config(vars(options), gitlab_id, config_files)
351+
gl = Gitlab.merge_config(vars(options), gitlab_id, config_files)
350352
if gl.private_token or gl.oauth_token:
351353
gl.auth()
352354
except Exception as e:
@@ -355,4 +357,6 @@ def main() -> None:
355357
if debug:
356358
gl.enable_debug()
357359

358-
gitlab.v4.cli.run(gl, what, action, args_dict, verbose, output, fields)
360+
from .v4 import cli
361+
362+
cli.run(gl, what, action, args_dict, verbose, output, fields)

‎gitlab/client.py‎

Lines changed: 21 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,8 @@
2424
import requests.utils
2525
from requests_toolbelt.multipart.encoder import MultipartEncoder # type: ignore
2626

27-
import gitlab.config
28-
import gitlab.const
29-
import gitlab.exceptions
30-
from gitlab import utils
27+
from . import config as gl_config
28+
from . import const, exceptions, utils
3129

3230
REDIRECT_MSG = (
3331
"python-gitlab detected a {status_code} ({reason!r}) redirection. You must update "
@@ -73,7 +71,7 @@ def __init__(
7371
per_page: Optional[int] = None,
7472
pagination: Optional[str] = None,
7573
order_by: Optional[str] = None,
76-
user_agent: str = gitlab.const.USER_AGENT,
74+
user_agent: str = const.USER_AGENT,
7775
retry_transient_errors: bool = False,
7876
) -> None:
7977

@@ -110,9 +108,9 @@ def __init__(
110108
raise ModuleNotFoundError(name=f"gitlab.v{self._api_version}.objects")
111109
# NOTE: We must delay import of gitlab.v4.objects until now or
112110
# otherwise it will cause circular import errors
113-
import gitlab.v4.objects
111+
from .v4 import objects as v4_objects
114112

115-
objects = gitlab.v4.objects
113+
objects = v4_objects
116114
self._objects = objects
117115

118116
self.broadcastmessages = objects.BroadcastMessageManager(self)
@@ -202,9 +200,9 @@ def __setstate__(self, state: Dict[str, Any]) -> None:
202200
raise ModuleNotFoundError(name=f"gitlab.v{self._api_version}.objects")
203201
# NOTE: We must delay import of gitlab.v4.objects until now or
204202
# otherwise it will cause circular import errors
205-
import gitlab.v4.objects
203+
from .v4 import objects as v4_objects
206204

207-
self._objects = gitlab.v4.objects
205+
self._objects = v4_objects
208206

209207
@property
210208
def url(self) -> str:
@@ -237,7 +235,7 @@ def from_config(
237235
Raises:
238236
gitlab.config.GitlabDataError: If the configuration is not correct.
239237
"""
240-
config = gitlab.config.GitlabConfigParser(
238+
config = gl_config.GitlabConfigParser(
241239
gitlab_id=gitlab_id, config_files=config_files
242240
)
243241
return cls(
@@ -371,7 +369,7 @@ def version(self) -> Tuple[str, str]:
371369

372370
return cast(str, self._server_version), cast(str, self._server_revision)
373371

374-
@gitlab.exceptions.on_http_error(gitlab.exceptions.GitlabVerifyError)
372+
@exceptions.on_http_error(exceptions.GitlabVerifyError)
375373
def lint(self, content: str, **kwargs: Any) -> Tuple[bool, List[str]]:
376374
"""Validate a gitlab CI configuration.
377375
@@ -392,7 +390,7 @@ def lint(self, content: str, **kwargs: Any) -> Tuple[bool, List[str]]:
392390
assert not isinstance(data, requests.Response)
393391
return (data["status"] == "valid", data["errors"])
394392

395-
@gitlab.exceptions.on_http_error(gitlab.exceptions.GitlabMarkdownError)
393+
@exceptions.on_http_error(exceptions.GitlabMarkdownError)
396394
def markdown(
397395
self, text: str, gfm: bool = False, project: Optional[str] = None, **kwargs: Any
398396
) -> str:
@@ -419,7 +417,7 @@ def markdown(
419417
assert not isinstance(data, requests.Response)
420418
return data["html"]
421419

422-
@gitlab.exceptions.on_http_error(gitlab.exceptions.GitlabLicenseError)
420+
@exceptions.on_http_error(exceptions.GitlabLicenseError)
423421
def get_license(self, **kwargs: Any) -> Dict[str, Any]:
424422
"""Retrieve information about the current license.
425423
@@ -438,7 +436,7 @@ def get_license(self, **kwargs: Any) -> Dict[str, Any]:
438436
return result
439437
return {}
440438

441-
@gitlab.exceptions.on_http_error(gitlab.exceptions.GitlabLicenseError)
439+
@exceptions.on_http_error(exceptions.GitlabLicenseError)
442440
def set_license(self, license: str, **kwargs: Any) -> Dict[str, Any]:
443441
"""Add a new license.
444442
@@ -529,7 +527,7 @@ def _get_base_url(self, url: Optional[str] = None) -> str:
529527
The base URL
530528
"""
531529
if not url:
532-
return gitlab.const.DEFAULT_URL
530+
return const.DEFAULT_URL
533531

534532
return url.rstrip("/")
535533

@@ -563,7 +561,7 @@ def _check_redirects(self, result: requests.Response) -> None:
563561
if item.request.method == "GET":
564562
continue
565563
target = item.headers.get("location")
566-
raise gitlab.exceptions.RedirectError(
564+
raise exceptions.RedirectError(
567565
REDIRECT_MSG.format(
568566
status_code=item.status_code,
569567
reason=item.reason,
@@ -718,13 +716,13 @@ def http_request(
718716
pass
719717

720718
if result.status_code == 401:
721-
raise gitlab.exceptions.GitlabAuthenticationError(
719+
raise exceptions.GitlabAuthenticationError(
722720
response_code=result.status_code,
723721
error_message=error_message,
724722
response_body=result.content,
725723
)
726724

727-
raise gitlab.exceptions.GitlabHttpError(
725+
raise exceptions.GitlabHttpError(
728726
response_code=result.status_code,
729727
error_message=error_message,
730728
response_body=result.content,
@@ -770,7 +768,7 @@ def http_get(
770768
try:
771769
return result.json()
772770
except Exception as e:
773-
raise gitlab.exceptions.GitlabParsingError(
771+
raise exceptions.GitlabParsingError(
774772
error_message="Failed to parse the server message"
775773
) from e
776774
else:
@@ -867,7 +865,7 @@ def http_post(
867865
if result.headers.get("Content-Type", None) == "application/json":
868866
return result.json()
869867
except Exception as e:
870-
raise gitlab.exceptions.GitlabParsingError(
868+
raise exceptions.GitlabParsingError(
871869
error_message="Failed to parse the server message"
872870
) from e
873871
return result
@@ -915,7 +913,7 @@ def http_put(
915913
try:
916914
return result.json()
917915
except Exception as e:
918-
raise gitlab.exceptions.GitlabParsingError(
916+
raise exceptions.GitlabParsingError(
919917
error_message="Failed to parse the server message"
920918
) from e
921919

@@ -935,7 +933,7 @@ def http_delete(self, path: str, **kwargs: Any) -> requests.Response:
935933
"""
936934
return self.http_request("delete", path, **kwargs)
937935

938-
@gitlab.exceptions.on_http_error(gitlab.exceptions.GitlabSearchError)
936+
@exceptions.on_http_error(exceptions.GitlabSearchError)
939937
def search(
940938
self, scope: str, search: str, **kwargs: Any
941939
) -> Union["GitlabList", List[Dict[str, Any]]]:
@@ -1009,7 +1007,7 @@ def _query(
10091007
try:
10101008
self._data: List[Dict[str, Any]] = result.json()
10111009
except Exception as e:
1012-
raise gitlab.exceptions.GitlabParsingError(
1010+
raise exceptions.GitlabParsingError(
10131011
error_message="Failed to parse the server message"
10141012
) from e
10151013

‎gitlab/config.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
from pathlib import Path
2424
from typing import List, Optional, Union
2525

26-
from gitlab.const import USER_AGENT
26+
from .const import USER_AGENT
2727

2828
_DEFAULT_FILES: List[str] = [
2929
"/etc/python-gitlab.cfg",

0 commit comments

Comments
 (0)