fix: Ensure all arguments with None defaults are marked as optional (#459)

* Ensure all arguments with None defaults are marked as optional

* Fix import issue

Author: lgarber-akamai

linode_api4/groups/image.py

@@ -32,8 +32,8 @@ def __call__(self, *filters):
     def create(
         self,
         disk: Union[Disk, int],
-        label: str = None,
-        description: str = None,
+        label: Optional[str] = None,
+        description: Optional[str] = None,
         cloud_init: bool = False,
         tags: Optional[List[str]] = None,
     ):
@@ -82,7 +82,7 @@ def create_upload(
         self,
         label: str,
         region: str,
-        description: str = None,
+        description: Optional[str] = None,
         cloud_init: bool = False,
         tags: Optional[List[str]] = None,
     ) -> Tuple[Image, str]:
@@ -132,7 +132,7 @@ def upload(
         label: str,
         region: str,
         file: BinaryIO,
-        description: str = None,
+        description: Optional[str] = None,
         tags: Optional[List[str]] = None,
     ) -> Image:
         """

linode_api4/groups/polling.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 import polling
 
 from linode_api4.groups import Group
@@ -13,7 +15,7 @@ def event_poller_create(
         self,
         entity_type: str,
         action: str,
-        entity_id: int = None,
+        entity_id: Optional[int] = None,
     ) -> EventPoller:
         """
         Creates a new instance of the EventPoller class.

linode_api4/linode_client.py

@@ -3,7 +3,7 @@
 import json
 import logging
 from importlib.metadata import version
-from typing import BinaryIO, List, Tuple
+from typing import BinaryIO, List, Optional, Tuple
 from urllib import parse
 
 import requests
@@ -391,8 +391,8 @@ def image_create_upload(
         self,
         label: str,
         region: str,
-        description: str = None,
-        tags: List[str] = None,
+        description: Optional[str] = None,
+        tags: Optional[List[str]] = None,
     ) -> Tuple[Image, str]:
         """
         .. note:: This method is an alias to maintain backwards compatibility.
@@ -409,8 +409,8 @@ def image_upload(
         label: str,
         region: str,
         file: BinaryIO,
-        description: str = None,
-        tags: List[str] = None,
+        description: Optional[str] = None,
+        tags: Optional[List[str]] = None,
     ) -> Image:
         """
         .. note:: This method is an alias to maintain backwards compatibility.

linode_api4/objects/image.py

@@ -1,5 +1,5 @@
 from dataclasses import dataclass
-from typing import List, Union
+from typing import List, Optional, Union
 
 from linode_api4.objects import Base, Property, Region
 from linode_api4.objects.serializable import JSONObject, StrEnum
@@ -25,7 +25,7 @@ class ImageRegion(JSONObject):
     """
 
     region: str = ""
-    status: ReplicationStatus = None
+    status: Optional[ReplicationStatus] = None
 
 
 class Image(Base):

linode_api4/objects/lke.py

@@ -103,8 +103,8 @@ class LKEClusterControlPlaneACLAddresses(JSONObject):
     to access an LKE cluster's control plane.
     """
 
-    ipv4: List[str] = None
-    ipv6: List[str] = None
+    ipv4: Optional[List[str]] = None
+    ipv6: Optional[List[str]] = None
 
 
 @dataclass
@@ -117,7 +117,7 @@ class LKEClusterControlPlaneACL(JSONObject):
     """
 
     enabled: bool = False
-    addresses: LKEClusterControlPlaneACLAddresses = None
+    addresses: Optional[LKEClusterControlPlaneACLAddresses] = None
 
 
 class LKENodePoolNode:
@@ -351,7 +351,7 @@ def node_pool_create(
         self,
         node_type: Union[Type, str],
         node_count: int,
-        labels: Dict[str, str] = None,
+        labels: Optional[Dict[str, str]] = None,
         taints: List[Union[LKENodePoolTaint, Dict[str, Any]]] = None,
         **kwargs,
     ):

linode_api4/objects/region.py

@@ -1,5 +1,5 @@
 from dataclasses import dataclass
-from typing import List
+from typing import List, Optional
 
 from linode_api4.errors import UnexpectedResponseError
 from linode_api4.objects.base import Base, JSONObject, Property
@@ -59,6 +59,6 @@ class RegionAvailabilityEntry(JSONObject):
     API Documentation: https://techdocs.akamai.com/linode-api/reference/get-region-availability
     """
 
-    region: str = None
-    plan: str = None
+    region: Optional[str] = None
+    plan: Optional[str] = None
     available: bool = False

linode_api4/objects/vpc.py

@@ -16,7 +16,7 @@ class VPCSubnetLinodeInterface(JSONObject):
 @dataclass
 class VPCSubnetLinode(JSONObject):
     id: int = 0
-    interfaces: List[VPCSubnetLinodeInterface] = None
+    interfaces: Optional[List[VPCSubnetLinodeInterface]] = None
 
 
 class VPCSubnet(DerivedBase):

linode_api4/polling.py

@@ -104,7 +104,7 @@ def __init__(
         client: "LinodeClient",
         entity_type: str,
         action: str,
-        entity_id: int = None,
+        entity_id: Optional[int] = None,
     ):
         self._client = client
         self._entity_type = entity_type

test/integration/conftest.py

@@ -2,7 +2,7 @@
 import os
 import random
 import time
-from typing import Set
+from typing import Optional, Set
 
 import pytest
 import requests
@@ -35,7 +35,9 @@ def get_random_label():
 
 
 def get_regions(
-    client: LinodeClient, capabilities: Set[str] = None, site_type: str = None
+    client: LinodeClient,
+    capabilities: Optional[Set[str]] = None,
+    site_type: Optional[str] = None,
 ):
     region_override = os.environ.get(ENV_REGION_OVERRIDE)
 

test/unit/objects/image_test.py

@@ -1,7 +1,7 @@
 from datetime import datetime
 from io import BytesIO
 from test.unit.base import ClientBaseCase
-from typing import BinaryIO
+from typing import BinaryIO, Optional
 from unittest.mock import patch
 
 from linode_api4.objects import Image, Region
@@ -95,7 +95,7 @@ def test_image_upload(self):
         Test that an image can be uploaded.
         """
 
-        def put_mock(url: str, data: BinaryIO = None, **kwargs):
+        def put_mock(url: str, data: Optional[BinaryIO] = None, **kwargs):
             self.assertEqual(url, "https://linode.com/")
             self.assertEqual(data.read(), TEST_IMAGE_CONTENT)