refactor(api): explicitly export classes for star imports

python-gitlab · Feb 7, 2021 · f05c287 · f05c287
1 parent a5a48ad
commit f05c287
Show file tree

Hide file tree

Showing 56 changed files with 557 additions and 9 deletions.
diff --git a/gitlab/base.py b/gitlab/base.py
@@ -18,6 +18,13 @@
 import importlib
 
 
+__all__ = [
+    "RESTObject",
+    "RESTObjectList",
+    "RESTManager",
+]
+
+
 class RESTObject(object):
     """Represents an object built from server data.
 

diff --git a/gitlab/mixins.py b/gitlab/mixins.py
@@ -23,6 +23,31 @@
 from gitlab import utils
 
 
+__all__ = [
+    "GetMixin",
+    "GetWithoutIdMixin",
+    "RefreshMixin",
+    "ListMixin",
+    "RetrieveMixin",
+    "CreateMixin",
+    "UpdateMixin",
+    "SetMixin",
+    "DeleteMixin",
+    "CRUDMixin",
+    "NoUpdateMixin",
+    "SaveMixin",
+    "ObjectDeleteMixin",
+    "UserAgentDetailMixin",
+    "AccessRequestMixin",
+    "DownloadMixin",
+    "SubscribableMixin",
+    "TodoMixin",
+    "TimeTrackingMixin",
+    "ParticipantsMixin",
+    "BadgeRenderMixin",
+]
+
+
 class GetMixin(object):
     @exc.on_http_error(exc.GitlabGetError)
     def get(self, id, lazy=False, **kwargs):

diff --git a/gitlab/v4/objects/access_requests.py b/gitlab/v4/objects/access_requests.py
@@ -2,6 +2,14 @@
 from gitlab.mixins import *  # noqa
 
 
+__all__ = [
+    "GroupAccessRequest",
+    "GroupAccessRequestManager",
+    "ProjectAccessRequest",
+    "ProjectAccessRequestManager",
+]
+
+
 class GroupAccessRequest(AccessRequestMixin, ObjectDeleteMixin, RESTObject):
     pass
 

diff --git a/gitlab/v4/objects/appearance.py b/gitlab/v4/objects/appearance.py
@@ -3,6 +3,12 @@
 from gitlab.mixins import *  # noqa
 
 
+__all__ = [
+    "ApplicationAppearance",
+    "ApplicationAppearanceManager",
+]
+
+
 class ApplicationAppearance(SaveMixin, RESTObject):
     _id_attr = None
 

diff --git a/gitlab/v4/objects/applications.py b/gitlab/v4/objects/applications.py
@@ -1,6 +1,11 @@
 from gitlab.base import *  # noqa
 from gitlab.mixins import *  # noqa
 
+__all__ = [
+    "Application",
+    "ApplicationManager",
+]
+
 
 class Application(ObjectDeleteMixin, RESTObject):
     _url = "/applications"

diff --git a/gitlab/v4/objects/award_emojis.py b/gitlab/v4/objects/award_emojis.py
@@ -2,6 +2,22 @@
 from gitlab.mixins import *  # noqa
 
 
+__all__ = [
+    "ProjectIssueAwardEmoji",
+    "ProjectIssueAwardEmojiManager",
+    "ProjectIssueNoteAwardEmoji",
+    "ProjectIssueNoteAwardEmojiManager",
+    "ProjectMergeRequestAwardEmoji",
+    "ProjectMergeRequestAwardEmojiManager",
+    "ProjectMergeRequestNoteAwardEmoji",
+    "ProjectMergeRequestNoteAwardEmojiManager",
+    "ProjectSnippetAwardEmoji",
+    "ProjectSnippetAwardEmojiManager",
+    "ProjectSnippetNoteAwardEmoji",
+    "ProjectSnippetNoteAwardEmojiManager",
+]
+
+
 class ProjectIssueAwardEmoji(ObjectDeleteMixin, RESTObject):
     pass
 

diff --git a/gitlab/v4/objects/badges.py b/gitlab/v4/objects/badges.py
@@ -2,6 +2,14 @@
 from gitlab.mixins import *  # noqa
 
 
+__all__ = [
+    "GroupBadge",
+    "GroupBadgeManager",
+    "ProjectBadge",
+    "ProjectBadgeManager",
+]
+
+
 class GroupBadge(SaveMixin, ObjectDeleteMixin, RESTObject):
     pass
 

diff --git a/gitlab/v4/objects/boards.py b/gitlab/v4/objects/boards.py
@@ -2,6 +2,18 @@
 from gitlab.mixins import *  # noqa
 
 
+__all__ = [
+    "GroupBoardList",
+    "GroupBoardListManager",
+    "GroupBoard",
+    "GroupBoardManager",
+    "ProjectBoardList",
+    "ProjectBoardListManager",
+    "ProjectBoard",
+    "ProjectBoardManager",
+]
+
+
 class GroupBoardList(SaveMixin, ObjectDeleteMixin, RESTObject):
     pass
 

diff --git a/gitlab/v4/objects/branches.py b/gitlab/v4/objects/branches.py
@@ -4,6 +4,14 @@
 from gitlab.mixins import *  # noqa
 
 
+__all__ = [
+    "ProjectBranch",
+    "ProjectBranchManager",
+    "ProjectProtectedBranch",
+    "ProjectProtectedBranchManager",
+]
+
+
 class ProjectBranch(ObjectDeleteMixin, RESTObject):
     _id_attr = "name"
 

diff --git a/gitlab/v4/objects/broadcast_messages.py b/gitlab/v4/objects/broadcast_messages.py
@@ -2,6 +2,12 @@
 from gitlab.mixins import *  # noqa
 
 
+__all__ = [
+    "BroadcastMessage",
+    "BroadcastMessageManager",
+]
+
+
 class BroadcastMessage(SaveMixin, ObjectDeleteMixin, RESTObject):
     pass
 

diff --git a/gitlab/v4/objects/clusters.py b/gitlab/v4/objects/clusters.py
@@ -3,6 +3,14 @@
 from gitlab.mixins import *  # noqa
 
 
+__all__ = [
+    "GroupCluster",
+    "GroupClusterManager",
+    "ProjectCluster",
+    "ProjectClusterManager",
+]
+
+
 class GroupCluster(SaveMixin, ObjectDeleteMixin, RESTObject):
     pass
 

diff --git a/gitlab/v4/objects/commits.py b/gitlab/v4/objects/commits.py
@@ -5,6 +5,16 @@
 from .discussions import ProjectCommitDiscussionManager
 
 
+__all__ = [
+    "ProjectCommit",
+    "ProjectCommitManager",
+    "ProjectCommitComment",
+    "ProjectCommitCommentManager",
+    "ProjectCommitStatus",
+    "ProjectCommitStatusManager",
+]
+
+
 class ProjectCommit(RESTObject):
     _short_print_attr = "title"
     _managers = (

diff --git a/gitlab/v4/objects/container_registry.py b/gitlab/v4/objects/container_registry.py
@@ -4,6 +4,14 @@
 from gitlab.mixins import *  # noqa
 
 
+__all__ = [
+    "ProjectRegistryRepository",
+    "ProjectRegistryRepositoryManager",
+    "ProjectRegistryTag",
+    "ProjectRegistryTagManager",
+]
+
+
 class ProjectRegistryRepository(ObjectDeleteMixin, RESTObject):
     _managers = (("tags", "ProjectRegistryTagManager"),)
 

diff --git a/gitlab/v4/objects/custom_attributes.py b/gitlab/v4/objects/custom_attributes.py
@@ -2,6 +2,16 @@
 from gitlab.mixins import *  # noqa
 
 
+__all__ = [
+    "GroupCustomAttribute",
+    "GroupCustomAttributeManager",
+    "ProjectCustomAttribute",
+    "ProjectCustomAttributeManager",
+    "UserCustomAttribute",
+    "UserCustomAttributeManager",
+]
+
+
 class GroupCustomAttribute(ObjectDeleteMixin, RESTObject):
     _id_attr = "key"
 

diff --git a/gitlab/v4/objects/deploy_keys.py b/gitlab/v4/objects/deploy_keys.py
@@ -4,6 +4,14 @@
 from gitlab.mixins import *  # noqa
 
 
+__all__ = [
+    "DeployKey",
+    "DeployKeyManager",
+    "ProjectKey",
+    "ProjectKeyManager",
+]
+
+
 class DeployKey(RESTObject):
     pass
 

diff --git a/gitlab/v4/objects/deploy_tokens.py b/gitlab/v4/objects/deploy_tokens.py
@@ -2,6 +2,16 @@
 from gitlab.mixins import *  # noqa
 
 
+__all__ = [
+    "DeployToken",
+    "DeployTokenManager",
+    "GroupDeployToken",
+    "GroupDeployTokenManager",
+    "ProjectDeployToken",
+    "ProjectDeployTokenManager",
+]
+
+
 class DeployToken(ObjectDeleteMixin, RESTObject):
     pass
 

diff --git a/gitlab/v4/objects/deployments.py b/gitlab/v4/objects/deployments.py
@@ -2,6 +2,12 @@
 from gitlab.mixins import *  # noqa
 
 
+__all__ = [
+    "ProjectDeployment",
+    "ProjectDeploymentManager",
+]
+
+
 class ProjectDeployment(RESTObject, SaveMixin):
     pass
 

diff --git a/gitlab/v4/objects/discussions.py b/gitlab/v4/objects/discussions.py
@@ -8,6 +8,18 @@
 )
 
 
+__all__ = [
+    "ProjectCommitDiscussion",
+    "ProjectCommitDiscussionManager",
+    "ProjectIssueDiscussion",
+    "ProjectIssueDiscussionManager",
+    "ProjectMergeRequestDiscussion",
+    "ProjectMergeRequestDiscussionManager",
+    "ProjectSnippetDiscussion",
+    "ProjectSnippetDiscussionManager",
+]
+
+
 class ProjectCommitDiscussion(RESTObject):
     _managers = (("notes", "ProjectCommitDiscussionNoteManager"),)
 

diff --git a/gitlab/v4/objects/environments.py b/gitlab/v4/objects/environments.py
@@ -4,6 +4,12 @@
 from gitlab.mixins import *  # noqa
 
 
+__all__ = [
+    "ProjectEnvironment",
+    "ProjectEnvironmentManager",
+]
+
+
 class ProjectEnvironment(SaveMixin, ObjectDeleteMixin, RESTObject):
     @cli.register_custom_action("ProjectEnvironment")
     @exc.on_http_error(exc.GitlabStopError)

diff --git a/gitlab/v4/objects/epics.py b/gitlab/v4/objects/epics.py
@@ -5,6 +5,14 @@
 from .events import GroupEpicResourceLabelEventManager
 
 
+__all__ = [
+    "GroupEpic",
+    "GroupEpicManager",
+    "GroupEpicIssue",
+    "GroupEpicIssueManager",
+]
+
+
 class GroupEpic(ObjectDeleteMixin, SaveMixin, RESTObject):
     _id_attr = "iid"
     _managers = (

diff --git a/gitlab/v4/objects/events.py b/gitlab/v4/objects/events.py
@@ -3,6 +3,28 @@
 from gitlab.mixins import *  # noqa
 
 
+__all__ = [
+    "Event",
+    "EventManager",
+    "AuditEvent",
+    "AuditEventManager",
+    "GroupEpicResourceLabelEvent",
+    "GroupEpicResourceLabelEventManager",
+    "ProjectEvent",
+    "ProjectEventManager",
+    "ProjectIssueResourceLabelEvent",
+    "ProjectIssueResourceLabelEventManager",
+    "ProjectIssueResourceMilestoneEvent",
+    "ProjectIssueResourceMilestoneEventManager",
+    "ProjectMergeRequestResourceLabelEvent",
+    "ProjectMergeRequestResourceLabelEventManager",
+    "ProjectMergeRequestResourceMilestoneEvent",
+    "ProjectMergeRequestResourceMilestoneEventManager",
+    "UserEvent",
+    "UserEventManager",
+]
+
+
 class Event(RESTObject):
     _id_attr = None
     _short_print_attr = "target_title"

diff --git a/gitlab/v4/objects/export_import.py b/gitlab/v4/objects/export_import.py
@@ -2,6 +2,18 @@
 from gitlab.mixins import *  # noqa
 
 
+__all__ = [
+    "GroupExport",
+    "GroupExportManager",
+    "GroupImport",
+    "GroupImportManager",
+    "ProjectExport",
+    "ProjectExportManager",
+    "ProjectImport",
+    "ProjectImportManager",
+]
+
+
 class GroupExport(DownloadMixin, RESTObject):
     _id_attr = None
 

diff --git a/gitlab/v4/objects/features.py b/gitlab/v4/objects/features.py
@@ -1,8 +1,15 @@
+from gitlab import utils
 from gitlab import exceptions as exc
 from gitlab.base import *  # noqa
 from gitlab.mixins import *  # noqa
 
 
+__all__ = [
+    "Feature",
+    "FeatureManager",
+]
+
+
 class Feature(ObjectDeleteMixin, RESTObject):
     _id_attr = "name"