update docstrings, remove redundant code

Author: Elias Nygren

upcloud/cloud_manager/ip_address_mixin.py

@@ -1,41 +1,68 @@
 from ..ip_address import IP_address
 
-
 class IPManager():
 	"""
 	Functions for managing IP-addresses. Intended to be used as a mixin for CloudManager.
 	"""
 
-	def get_IP(self, UUID):
-		res = self.get_request("/ip_address/" + UUID)
-		IP = IP_address._create_ip_address_obj( res["ip_address"], cloud_manager=self )
-		return IP
+	def get_IP(self, address):
+		"""
+		Get an IP_address object with the IP address (string) from the API.
+		e.g manager.get_IP("80.69.175.210")
+		"""
+		res = self.get_request("/ip_address/" + address)
+		return IP_address( cloud_manager=self, **res["ip_address"] )
 
 	def get_IPs(self):
+		"""
+		Get all IP_address objects from the API.
+		"""
 		res = self.get_request("/ip_address")
 		IPs = IP_address._create_ip_address_objs( res["ip_addresses"], cloud_manager=self )
 		return IPs
 
-	def attach_IP(self, server_UUID):
-		body = dict()
-		body["ip_address"] = {
-			"server" : server_UUID
+	def attach_IP(self, server):
+		"""
+		Attach a new (random) IP_address to the given server (object or UUID)
+		"""
+
+		if not isinstance(server, str):
+			server = server.uuid
+
+		body = {
+			"ip_address": {
+				"server": server
+			}
 		}
 
 		res = self.request("POST", "/ip_address", body)
-		IP = IP_address._create_ip_address_obj( res["ip_address"], cloud_manager=self )
-		return IP
+		return IP_address( cloud_manager=self, **res["ip_address"] )
 
 	def modify_IP(self, IP_addr, ptr_record):
-		body = dict()
-		body["ip_address"] = {
-			"ptr_record": ptr_record
+		"""
+		Modify an IP address' ptr-record (Reverse DNS). 
+		Accepts an IP_address instance (object) or its address (string).
+		"""
+
+		if not isinstance(IP_addr, str):
+			IP_addr = IP_addr.address
+		
+		body = {
+			"ip_address": {
+				"ptr_record": ptr_record
+			}
 		}
 
 		res = self.request("PUT", "/ip_address/" + IP_addr, body)
-		IP = IP_address._create_ip_address_obj( res["ip_address"], cloud_manager=self )
-		return IP
+		return IP_address( cloud_manager=self, **res["ip_address"] )
 
 	def release_IP(self, IP_addr):
-		return self.request("DELETE", "/ip_address/" + IP_addr)
+		"""
+		Destroy an IP_address. Returns an empty object.
+		Accepts an IP_address instance (object) or its address (string).
+		"""
+		if not isinstance(IP_addr, str):
+			IP_addr = IP_addr.address
+
+		return self.request( "DELETE", "/ip_address/" + IP_addr )
 

upcloud/cloud_manager/server_mixin.py

@@ -17,7 +17,8 @@ def get_servers(self, populate=False):
 		Populate = False (default) => 1 API request, returns unpopulated Server instances.
 		Populate = True => Does 1 + n API requests (n = # of servers), returns populated Server instances.
 		"""
-		servers = self.__fetch_servers()		
+		
+		servers = self.get_request("/server")["servers"]["server"]		
 
 		server_list = list()
 		for server in servers:
@@ -120,16 +121,11 @@ def delete_server(self, UUID):
 		"""
 		DELETE '/server/UUID'. Permanently destroys the virtual machine. 
 		DOES NOT remove the storage disks.
+
+		Returns an empty object.
 		"""
 		return self.request("DELETE", "/server/" + UUID)
 
-	def __fetch_servers(self):
-		"""
-		Returns '/servers' data in Python dict.
-		"""
-		data = self.get_request("/server")
-		return data["servers"]["server"]
-
 
 	def get_server_data(self, UUID):
 		"""

upcloud/ip_address.py

@@ -1,6 +1,18 @@
 from .base import BaseAPI
 
 class IP_address(BaseAPI):
+	"""
+	Object representation of the IP-address. 
+
+	Attributes:
+	access -- "public" or "private"
+	address -- the actual IP_address (string)
+	ptr_record -- the reverse DNS name (string)
+	server -- the UUID of the server this IP is attached to (string)
+	
+	The only updateable field is the ptr_record. 
+	ptr_record and server are present only if /server/uuid endpoint was used.
+	"""
 
 	def __init__(self, access, address, cloud_manager, ptr_record=None, server=None):
 		"""
@@ -10,25 +22,15 @@ def __init__(self, access, address, cloud_manager, ptr_record=None, server=None)
 		self._cloud_manager = cloud_manager
 		self.__reset(access, address, ptr_record, server)
 
-	@property
-	def address(self):
-		return self._address
-	
-	@property
-	def access(self):
-		return self._access	
-	
-	@property
-	def server_uuid(self):
-		return self._server_uuid
-		
-
 	def __reset(self, access, address, ptr_record=None, server=None):
 		"""
 		Reset after repopulating from API.
 		"""
+		# Always present
 		self._access = access
 		self._address = address
+
+		# Present when populated from /server/uuid endpoint
 		self._server_uuid = server
 		self.ptr = ptr_record
 
@@ -49,14 +51,21 @@ def destroy(self):
 	def __str__(self):
 		return "IP-address: " + self.address
 
+	@property
+	def address(self):
+		return self._address
+	
+	@property
+	def access(self):
+		return self._access	
+	
+	@property
+	def server_uuid(self):
+		return self._server_uuid
+
 	@staticmethod
 	def _create_ip_address_objs(IP_addrs, cloud_manager):
-		IP_addrs = IP_addrs["ip_address"]
 		IP_objs = list()
-		for IP_addr in IP_addrs:
+		for IP_addr in IP_addrs["ip_address"]:
 			IP_objs.append( IP_address(cloud_manager = cloud_manager, **IP_addr) )
-		return IP_objs
-
-	@staticmethod
-	def _create_ip_address_obj(IP_addr, cloud_manager):
-		return IP_address(cloud_manager = cloud_manager, **IP_addr)
+		return IP_objs	

upcloud/tools.py

@@ -1,6 +1,4 @@
 
-
-
 def assignIfExists(opts, default=None, **kwargs):
 	"""
 	Helper for assigning object attributes from API responses.