Merge pull request #250 from pheus/housekeeping/249-use-netboxobjecttype-for-graphql

#249 [Housekeeping]: Use NetBoxObjectType for GraphQL

Author: cruse1977

netbox_acls/graphql/__init__.py

@@ -1,7 +1,3 @@
-from .schema import *
-from .types import *
-
-schema = [
-    schema.NetBoxACLSQuery
-]
+from .schema import NetBoxACLSQuery
 
+schema = [NetBoxACLSQuery]

netbox_acls/graphql/filters.py

@@ -1,30 +1,35 @@
 import strawberry_django
+from netbox.graphql.filter_mixins import BaseFilterMixin, autotype_decorator
+
 from .. import filtersets, models
-from netbox.graphql.filter_mixins import autotype_decorator, BaseFilterMixin
 
 __all__ = (
-    'AccessListFilter',
-    'ACLInterfaceAssignmentFilter',
-    'ACLExtendedRuleFilter',
-    'ACLStandardRuleFilter',
+    "AccessListFilter",
+    "ACLInterfaceAssignmentFilter",
+    "ACLExtendedRuleFilter",
+    "ACLStandardRuleFilter",
 )
 
+
 @strawberry_django.filter(models.AccessList, lookups=True)
 @autotype_decorator(filtersets.AccessListFilterSet)
 class AccessListFilter(BaseFilterMixin):
     pass
 
+
 @strawberry_django.filter(models.ACLStandardRule, lookups=True)
 @autotype_decorator(filtersets.ACLStandardRuleFilterSet)
 class ACLStandardRuleFilter(BaseFilterMixin):
     pass
 
+
 @strawberry_django.filter(models.ACLExtendedRule, lookups=True)
 @autotype_decorator(filtersets.ACLExtendedRuleFilterSet)
 class ACLExtendedRuleFilter(BaseFilterMixin):
     pass
 
+
 @strawberry_django.filter(models.ACLInterfaceAssignment, lookups=True)
 @autotype_decorator(filtersets.ACLInterfaceAssignmentFilterSet)
 class ACLInterfaceAssignmentFilter(BaseFilterMixin):
-    pass
+    pass

netbox_acls/graphql/schema.py

@@ -1,14 +1,21 @@
+from typing import List
+
 import strawberry
 import strawberry_django
-from .types import *
-from ..models import *
-from typing import List
+
+from .types import (
+    AccessListType,
+    ACLExtendedRuleType,
+    ACLStandardRuleType,
+)
+
 
 @strawberry.type(name="Query")
 class NetBoxACLSQuery:
     """
     Defines the queries available to this plugin via the graphql api.
     """
+
     access_list: AccessListType = strawberry_django.field()
     access_list_list: List[AccessListType] = strawberry_django.field()
 
@@ -17,4 +24,3 @@ class NetBoxACLSQuery:
 
     acl_standard_rule: ACLStandardRuleType = strawberry_django.field()
     acl_standard_rule_list: List[ACLStandardRuleType] = strawberry_django.field()
-

netbox_acls/graphql/types.py

@@ -1,113 +1,86 @@
 """
-Define the object types and queries availble via the graphql api.
+Define the object types and queries available via the graphql api.
 """
 
+from typing import Annotated, List, Union
+
 import strawberry
 import strawberry_django
+from netbox.graphql.types import NetBoxObjectType
 
-
-from typing import Annotated, List, Union
-from .filters import *
 from .. import models
-from netbox.graphql.types import OrganizationalObjectType
+from . import filters
+
 
 @strawberry_django.type(
     models.AccessList,
-    fields='__all__',
-    filters=AccessListFilter,
-    exclude=('assigned_object_type', 'assigned_object_id')
+    fields="__all__",
+    exclude=["assigned_object_type", "assigned_object_id"],
+    filters=filters.AccessListFilter,
 )
-
-class AccessListType(OrganizationalObjectType):
+class AccessListType(NetBoxObjectType):
     """
     Defines the object type for the django model AccessList.
     """
+
     assigned_object_type: Annotated["ContentTypeType", strawberry.lazy("netbox.graphql.types")]
-    assigned_object: Annotated[Union[
-        Annotated["DeviceType", strawberry.lazy('dcim.graphql.types')],
-        Annotated["VirtualMachineType", strawberry.lazy('virtualization.graphql.types')],
-    ], strawberry.union("ACLAssignmentType")]
+    assigned_object: Annotated[
+        Union[
+            Annotated["DeviceType", strawberry.lazy("dcim.graphql.types")],
+            Annotated["VirtualMachineType", strawberry.lazy("virtualization.graphql.types")],
+        ],
+        strawberry.union("ACLAssignmentType"),
+    ]
 
 
-    class Meta:
-        """
-        Associates the filterset, fields, and model for the django model AccessList.
-        """
-        @strawberry_django.field
-        def accesslists(self) -> List[Annotated["AccessList", strawberry.lazy('accesslists.graphql.types')]]:
-            return self.accesslists.all()
-        
 @strawberry_django.type(
     models.ACLInterfaceAssignment,
-    fields='__all__',
-    exclude=('assigned_object_type', 'assigned_object_id'),
-    filters=ACLInterfaceAssignmentFilter
+    fields="__all__",
+    exclude=["assigned_object_type", "assigned_object_id"],
+    filters=filters.ACLInterfaceAssignmentFilter,
 )
-class ACLInterfaceAssignmentType(OrganizationalObjectType):
+class ACLInterfaceAssignmentType(NetBoxObjectType):
     """
     Defines the object type for the django model AccessList.
     """
+
     access_list: Annotated["AccessListType", strawberry.lazy("netbox_acls.graphql.types")]
     assigned_object_type: Annotated["ContentTypeType", strawberry.lazy("netbox.graphql.types")]
-    assigned_object: Annotated[Union[
-        Annotated["InterfaceType", strawberry.lazy('dcim.graphql.types')],
-        Annotated["VMInterfaceType", strawberry.lazy('virtualization.graphql.types')],
-    ], strawberry.union("ACLInterfaceAssignmentType")]
-
-    
-
+    assigned_object: Annotated[
+        Union[
+            Annotated["InterfaceType", strawberry.lazy("dcim.graphql.types")],
+            Annotated["VMInterfaceType", strawberry.lazy("virtualization.graphql.types")],
+        ],
+        strawberry.union("ACLInterfaceAssignmentType"),
+    ]
 
-    class Meta:
-        """
-        Associates the filterset, fields, and model for the django model ACLInterfaceAssignment.
-        """
-        @strawberry_django.field
-        def aclinterfaceassignments(self) -> List[Annotated["ACLInterfaceAssignment", strawberry.lazy('aclinterfaceassignments.graphql.types')]]:
-            return self.aclinterfaceassignments.all()
 
 @strawberry_django.type(
-    models.ACLExtendedRule,
-    fields='__all__',
-    filters=ACLExtendedRuleFilter
+    models.ACLStandardRule,
+    fields="__all__",
+    filters=filters.ACLStandardRuleFilter,
 )
-
-class ACLExtendedRuleType(OrganizationalObjectType):
+class ACLStandardRuleType(NetBoxObjectType):
     """
-    Defines the object type for the django model ACLExtendedRule.
+    Defines the object type for the django model ACLStandardRule.
     """
-    source_ports: List[int]
-    destination_ports: List[int]
-    access_list: Annotated["AccessListType", strawberry.lazy("netbox_acls.graphql.types")]
-    destination_prefix: Annotated["PrefixType", strawberry.lazy("ipam.graphql.types")]
-    source_prefix: Annotated["PrefixType", strawberry.lazy("ipam.graphql.types")]
 
-    class Meta:
-        """
-        Associates the filterset, fields, and model for the django model ACLExtendedRule.
-        """
-        @strawberry_django.field
-        def aclextendedrules(self) -> List[Annotated["ACLExtendedRule", strawberry.lazy('aclextendedrule.graphql.types')]]:
-            return self.aclextendedrules.all()
+    access_list: Annotated["AccessListType", strawberry.lazy("netbox_acls.graphql.types")]
+    source_prefix: Annotated["PrefixType", strawberry.lazy("ipam.graphql.types")] | None
 
 
 @strawberry_django.type(
-    models.ACLStandardRule,
-    fields='__all__',
-    filters=ACLStandardRuleFilter
+    models.ACLExtendedRule,
+    fields="__all__",
+    filters=filters.ACLExtendedRuleFilter,
 )
-
-class ACLStandardRuleType(OrganizationalObjectType):
+class ACLExtendedRuleType(NetBoxObjectType):
     """
-    Defines the object type for the django model ACLStandardRule.
+    Defines the object type for the django model ACLExtendedRule.
     """
-    access_list: Annotated["AccessListType", strawberry.lazy("netbox_acls.graphql.types")]
-    source_prefix: Annotated["PrefixType", strawberry.lazy("ipam.graphql.types")]
-
-    class Meta:
-        """
-        Associates the filterset, fields, and model for the django model ACLExtendedRule.
-        """
-        @strawberry_django.field
-        def aclstandardrules(self) -> List[Annotated["ACLStandardRule", strawberry.lazy('aclstandardrule.graphql.types')]]:
-            return self.aclstandardrules.all()
 
+    access_list: Annotated["AccessListType", strawberry.lazy("netbox_acls.graphql.types")]
+    source_prefix: Annotated["PrefixType", strawberry.lazy("ipam.graphql.types")] | None
+    source_ports: List[int] | None
+    destination_prefix: Annotated["PrefixType", strawberry.lazy("ipam.graphql.types")] | None
+    destination_ports: List[int] | None