refactor(objects): make audit event classes consistent

nejch · nejch · commit 23e37c5512d1 · 2021-03-07T13:12:01.000+01:00
diff --git a/gitlab/tests/objects/test_audit_events.py b/gitlab/tests/objects/test_audit_events.py
@@ -8,7 +8,11 @@
 import pytest
 import responses
 
-from gitlab.v4.objects.audit_events import AuditEvent, GroupAuditEvent, ProjectAudit
+from gitlab.v4.objects.audit_events import (
+    AuditEvent,
+    GroupAuditEvent,
+    ProjectAuditEvent,
+)
 
 id = 5
 
@@ -95,11 +99,11 @@ def test_get_group_audit_events(group, resp_get_audit_event):
 def test_list_project_audit_events(project, resp_list_audit_events):
     audit_events = project.audit_events.list()
     assert isinstance(audit_events, list)
-    assert isinstance(audit_events[0], ProjectAudit)
+    assert isinstance(audit_events[0], ProjectAuditEvent)
     assert audit_events[0].id == id
 
 
 def test_get_project_audit_events(project, resp_get_audit_event):
     audit_event = project.audit_events.get(id)
-    assert isinstance(audit_event, ProjectAudit)
+    assert isinstance(audit_event, ProjectAuditEvent)
     assert audit_event.id == id
diff --git a/gitlab/v4/objects/audit_events.py b/gitlab/v4/objects/audit_events.py
@@ -2,6 +2,7 @@
 GitLab API:
 https://docs.gitlab.com/ee/api/audit_events.html
 """
+import warnings
 
 from gitlab.base import RESTManager, RESTObject
 from gitlab.mixins import RetrieveMixin
@@ -11,6 +12,8 @@
     "AuditEventManager",
     "GroupAuditEvent",
     "GroupAuditEventManager",
+    "ProjectAuditEvent",
+    "ProjectAuditEventManager",
     "ProjectAudit",
     "ProjectAuditManager",
 ]
@@ -37,12 +40,36 @@ class GroupAuditEventManager(RetrieveMixin, RESTManager):
     _list_filters = ("created_after", "created_before")
 
 
-class ProjectAudit(RESTObject):
+class ProjectAuditEvent(RESTObject):
     _id_attr = "id"
 
+    def __init_subclass__(self):
+        warnings.warn(
+            "This class has been renamed to ProjectAuditEvent "
+            "and will be removed in a future release.",
+            DeprecationWarning,
+            2,
+        )
 
-class ProjectAuditManager(RetrieveMixin, RESTManager):
+
+class ProjectAuditEventManager(RetrieveMixin, RESTManager):
     _path = "/projects/%(project_id)s/audit_events"
-    _obj_cls = ProjectAudit
+    _obj_cls = ProjectAuditEvent
     _from_parent_attrs = {"project_id": "id"}
     _list_filters = ("created_after", "created_before")
+
+    def __init_subclass__(self):
+        warnings.warn(
+            "This class has been renamed to ProjectAuditEventManager "
+            "and will be removed in a future release.",
+            DeprecationWarning,
+            2,
+        )
+
+
+class ProjectAudit(ProjectAuditEvent):
+    pass
+
+
+class ProjectAuditManager(ProjectAuditEventManager):
+    pass
diff --git a/gitlab/v4/objects/projects.py b/gitlab/v4/objects/projects.py
@@ -25,7 +25,7 @@
 from .deployments import ProjectDeploymentManager
 from .environments import ProjectEnvironmentManager
 from .events import ProjectEventManager
-from .audit_events import ProjectAuditManager
+from .audit_events import ProjectAuditEventManager
 from .export_import import ProjectExportManager, ProjectImportManager
 from .files import ProjectFileManager
 from .hooks import ProjectHookManager
@@ -117,7 +117,7 @@ class Project(RefreshMixin, SaveMixin, ObjectDeleteMixin, RepositoryMixin, RESTO
         ("deployments", "ProjectDeploymentManager"),
         ("environments", "ProjectEnvironmentManager"),
         ("events", "ProjectEventManager"),
-        ("audit_events", "ProjectAuditManager"),
+        ("audit_events", "ProjectAuditEventManager"),
         ("exports", "ProjectExportManager"),
         ("files", "ProjectFileManager"),
         ("forks", "ProjectForkManager"),
