Drop root_pass from returned fields for instance_create, rebuild, and disk_create

Author: ezilber-akamai

linode_api4/groups/linode.py

@@ -177,12 +177,11 @@ def instance_create(
         a :any:`Type`, a :any:`Region`, and an :any:`Image`.  All three of
         these fields may be provided as either the ID or the appropriate object.
         When an Image is provided, at least one of ``root_pass``, ``authorized_users``, or
-        ``authorized_keys`` must also be given.  If ``root_pass`` is provided,
-        the Instance and the password are returned as a tuple.
+        ``authorized_keys`` must also be given.
 
         For example::
 
-           new_linode, password = client.linode.instance_create(
+           new_linode = client.linode.instance_create(
                "g6-standard-2",
                "us-east",
                image="linode/debian13",
@@ -198,9 +197,6 @@ def instance_create(
                image=image,
                authorized_keys="ssh-rsa AAAA")
 
-        To output the password from the first example above:
-            print(password)
-
         To output the first IPv4 address of the new Linode:
             print(new_linode.ipv4[0])
 
@@ -217,7 +213,7 @@ def instance_create(
 
            stackscript = StackScript(client, 10079)
 
-           new_linode, password = client.linode.instance_create(
+           new_linode = client.linode.instance_create(
               "g6-standard-2",
               "us-east",
               image="linode/debian13",
@@ -252,7 +248,7 @@ def instance_create(
         To create a new Instance with explicit interfaces, provide list of
         LinodeInterfaceOptions objects or dicts to the "interfaces" field::
 
-        linode, password = client.linode.instance_create(
+        linode = client.linode.instance_create(
             "g6-standard-1",
             "us-mia",
             image="linode/ubuntu24.04",
@@ -293,11 +289,9 @@ def instance_create(
                       at least one of root_pass, authorized_users, or authorized_keys must also be
                       provided.
         :type image: str or Image
-        :param root_pass: The root password for the new Instance. If an image is
-                          provided and root_pass is given, the Instance and password
-                          will be returned as a tuple. If all of root_pass, authorized_users, and
-                          authorized_keys are not provided when an image is specified,
-                          a ValueError will be raised.
+        :param root_pass: The root password for the new Instance. Required when
+                          an image is provided and neither authorized_users nor
+                          authorized_keys are given.
         :type root_pass: str
         :param stackscript: The StackScript to deploy to the new Instance.  If
                             provided, "image" is required and must be compatible
@@ -363,9 +357,8 @@ def instance_create(
                           the boot disk for the Instance.
         :type boot_size: int
 
-        :returns: A new Instance object, or a tuple containing the new Instance and
-                  the password if both image and root_pass were provided.
-        :rtype: Instance or tuple(Instance, str)
+        :returns: A new Instance object
+        :rtype: Instance
         :raises ApiError: If contacting the API fails
         :raises UnexpectedResponseError: If the API response is somehow malformed.
                                          This usually indicates that you are using
@@ -423,10 +416,7 @@ def instance_create(
                 "Unexpected response when creating linode!", json=result
             )
 
-        l = Instance(self.client, result["id"], result)
-        if not (image and root_pass):
-            return l
-        return l, root_pass
+        return Instance(self.client, result["id"], result)
 
     @staticmethod
     def build_instance_metadata(user_data=None, encode_user_data=True):
@@ -435,7 +425,7 @@ def build_instance_metadata(user_data=None, encode_user_data=True):
         the :any:`instance_create` method. This helper can also be used
         when cloning and rebuilding Instances.
         **Creating an Instance with User Data**::
-            new_linode, password = client.linode.instance_create(
+            new_linode = client.linode.instance_create(
                 "g6-standard-2",
                 "us-east",
                 image="linode/ubuntu22.04",

linode_api4/objects/linode.py

@@ -1398,9 +1398,7 @@ def disk_create(
         :param image: The Image to deploy to the disk.  If provided, at least one of
                       root_pass, authorized_users or authorized_keys must also be given.
         :param root_pass: The password to configure for the root user when deploying an
-                          image to this disk.  Not used if image is not given.  If an
-                          image is given and root_pass is provided, it will be returned
-                          alongside the new disk as a tuple.
+                          image to this disk.  Not used if image is not given.
         :param authorized_keys: A list of SSH keys to install as trusted for the root user.
         :param authorized_users: A list of usernames whose keys should be installed
                                  as trusted for the root user.  These user's keys
@@ -1414,9 +1412,8 @@ def disk_create(
         :param **stackscript_args: Any arguments to pass to the StackScript, as defined
                                    by its User Defined Fields.
 
-        :returns: A new Disk object, or a tuple containing the new Disk and the
-                  password if both image and root_pass were provided.
-        :rtype: Disk or tuple(Disk, str)
+        :returns: A new Disk object.
+        :rtype: Disk
         """
 
         if (
@@ -1475,11 +1472,7 @@ def disk_create(
                 "Unexpected response creating disk!", json=result
             )
 
-        d = Disk(self._client, result["id"], self.id, result)
-
-        if image and root_pass:
-            return d, root_pass
-        return d
+        return Disk(self._client, result["id"], self.id, result)
 
     def enable_backups(self):
         """
@@ -1620,8 +1613,8 @@ def rebuild(
                                 NOTE: Disk encryption may not currently be available to all users.
         :type disk_encryption: InstanceDiskEncryptionType or str
 
-        :returns: The root_pass if provided, otherwise True.
-        :rtype: str or bool
+        :returns: True.
+        :rtype: bool
         """
         if not root_pass and not authorized_keys and not authorized_users:
             raise ValueError(
@@ -1657,8 +1650,6 @@ def rebuild(
         # update ourself with the newly-returned information
         self._populate(result)
 
-        if root_pass:
-            return root_pass
         return True
 
     def rescue(self, *disks):

test/integration/conftest.py

@@ -223,12 +223,13 @@ def create_linode(test_linode_client, e2e_test_firewall):
     region = get_region(client, {"Linodes", "Cloud Firewall"}, site_type="core")
     label = get_test_label(length=8)
 
-    linode_instance, password = client.linode.instance_create(
+    linode_instance = client.linode.instance_create(
         "g6-nanode-1",
         region,
         image="linode/debian12",
         label=label,
         firewall=e2e_test_firewall,
+        root_pass="aComplex@Password123",
     )
 
     yield linode_instance
@@ -242,13 +243,15 @@ def create_linode_for_pass_reset(test_linode_client, e2e_test_firewall):
 
     region = get_region(client, {"Linodes", "Cloud Firewall"}, site_type="core")
     label = get_test_label(length=8)
+    password = "aComplex@Password123"
 
-    linode_instance, password = client.linode.instance_create(
+    linode_instance = client.linode.instance_create(
         "g6-nanode-1",
         region,
         image="linode/debian12",
         label=label,
         firewall=e2e_test_firewall,
+        root_pass=password,
     )
 
     yield linode_instance, password
@@ -488,15 +491,16 @@ def create_vpc_with_subnet_and_linode(
 
     label = get_test_label(length=8)
 
-    instance, password = test_linode_client.linode.instance_create(
+    instance = test_linode_client.linode.instance_create(
         "g6-standard-1",
         vpc.region,
         image="linode/debian11",
         label=label,
         firewall=e2e_test_firewall,
+        root_pass="aComplex@Password123",
     )
 
-    yield vpc, subnet, instance, password
+    yield vpc, subnet, instance
 
     instance.delete()
 
@@ -579,12 +583,13 @@ def linode_for_vlan_tests(test_linode_client, e2e_test_firewall):
     region = get_region(client, {"Linodes", "Vlans"}, site_type="core")
     label = get_test_label(length=8)
 
-    linode_instance, password = client.linode.instance_create(
+    linode_instance = client.linode.instance_create(
         "g6-nanode-1",
         region,
         image="linode/debian12",
         label=label,
         firewall=e2e_test_firewall,
+        root_pass="aComplex@Password123",
     )
 
     yield linode_instance
@@ -628,13 +633,14 @@ def linode_with_linode_interfaces(
     region = vpc.region
     label = get_test_label()
 
-    instance, _ = client.linode.instance_create(
+    instance = client.linode.instance_create(
         "g6-nanode-1",
         region,
         image="linode/debian12",
         label=label,
         booted=False,
         interface_generation=InterfaceGeneration.LINODE,
+        root_pass="aComplex@Password123",
         interfaces=[
             LinodeInterfaceOptions(
                 firewall_id=e2e_test_firewall.id,

test/integration/linode_client/test_linode_client.py

@@ -16,12 +16,13 @@ def setup_client_and_linode(test_linode_client, e2e_test_firewall):
 
     label = get_test_label()
 
-    linode_instance, password = client.linode.instance_create(
+    linode_instance = client.linode.instance_create(
         "g6-nanode-1",
         region,
         image="linode/debian12",
         label=label,
         firewall=e2e_test_firewall,
+        root_pass="aComplex@Password123"
     )
 
     yield client, linode_instance
@@ -258,7 +259,7 @@ def test_create_linode_with_interfaces(test_linode_client):
     region = get_region(client, {"Vlans", "Linodes"}, site_type="core").id
     label = get_test_label()
 
-    linode_instance, password = client.linode.instance_create(
+    linode_instance = client.linode.instance_create(
         "g6-nanode-1",
         region,
         label=label,
@@ -269,6 +270,7 @@ def test_create_linode_with_interfaces(test_linode_client):
                 purpose="vlan", label="cool-vlan", ipam_address="10.0.0.4/32"
             ),
         ],
+        root_pass="aComplex@Password123",
     )
 
     assert len(linode_instance.configs[0].interfaces) == 2

test/integration/models/account/test_account.py

@@ -98,12 +98,13 @@ def test_latest_get_event(test_linode_client, e2e_test_firewall):
     region = get_region(client, {"Linodes", "Cloud Firewall"}, site_type="core")
     label = get_test_label()
 
-    linode, password = client.linode.instance_create(
+    linode = client.linode.instance_create(
         "g6-nanode-1",
         region,
         image="linode/debian12",
         label=label,
         firewall=e2e_test_firewall,
+        root_pass="aComplex@Password123",
     )
 
     def get_linode_status():

test/integration/models/firewall/test_firewall.py

@@ -13,8 +13,9 @@ def linode_fw(test_linode_client):
     region = get_region(client, {"Linodes", "Cloud Firewall"}, site_type="core")
     label = get_test_label()
 
-    linode_instance, password = client.linode.instance_create(
-        "g6-nanode-1", region, image="linode/debian12", label=label
+    linode_instance = client.linode.instance_create(
+        "g6-nanode-1", region, image="linode/debian12", label=label,
+        root_pass="aComplex@Password123",
     )
 
     yield linode_instance