Add generic filter_list method

Author: smashedr

src/vultr/vultr.py

@@ -1,5 +1,6 @@
 import os
-from typing import Optional, Union
+import warnings
+from typing import Optional, Union, List
 
 import requests
 
@@ -8,9 +9,7 @@ class Vultr(object):
     url = "https://api.vultr.com/v2"
 
     def __init__(self, api_key: Optional[str] = None):
-        """
-        :param api_key: Vultr API Key or `VULTR_API_KEY` Environment Variable
-        """
+        """:param api_key: Vultr API Key or `VULTR_API_KEY` Environment Variable"""
         self.api_key = api_key or os.getenv("VULTR_API_KEY")
         """Provide the API key here or with the `VULTR_API_KEY` environment variable"""
         self._session = requests.session()
@@ -21,7 +20,7 @@ def get(self, url: str, params: Optional[dict] = None):
         """
         GET Data
         :param url: Request URL. Example `/instances`
-        :param params: Query Parameters
+        :param params: Query Parameters Dictionary
         :return: Response Data
         """
         return self._get(f"{self.url}/{url.lstrip('/')}", params)
@@ -154,31 +153,48 @@ def delete_ipv4(self, instance: Union[str, dict]):
         url = f"{self.url}/instances/{instance_id}/ipv4"
         return self._delete(url)
 
+    @staticmethod
+    def filter_list(item_list: List[dict], value: str, key: str = "name") -> dict:
+        """
+        Helper Function to get an Item from a List of Dictionaries
+        :param item_list: List to filter
+        :param value: Value of the Key
+        :param key: Key to check for Value
+        :return: Item or {}
+        """
+        return next((d for d in item_list if str(d.get(key, "")).lower() == value.lower()), {})
+
+    @staticmethod
+    def filter_regions(regions: list, locations: list) -> list:
+        return [d for d in regions if d["id"] in locations]
+
     @staticmethod
     def filter_keys(keys: list, name: str) -> dict:
+        """Soft Deprecated in 0.2.0. Use `Vultr.filter_list()`"""
+        warnings.warn("Soft Deprecated in 0.2.0. Use filter_list()", PendingDeprecationWarning, stacklevel=2)
         try:
             return next(d for d in keys if d["name"].lower() == name.lower())
         except StopIteration:
             return {}
 
     @staticmethod
     def filter_os(os_list: list, name: str) -> dict:
+        """Soft Deprecated in 0.2.0. Use `Vultr.filter_list()`"""
+        warnings.warn("Soft Deprecated in 0.2.0. Use filter_list()", PendingDeprecationWarning, stacklevel=2)
         try:
             return next(d for d in os_list if d["name"].lower() == name.lower())
         except StopIteration:
             return {}
 
     @staticmethod
     def filter_scripts(scripts: list, name: str) -> dict:
+        """Soft Deprecated in 0.2.0. Use `Vultr.filter_list()`"""
+        warnings.warn("Soft Deprecated in 0.2.0. Use filter_list()", PendingDeprecationWarning, stacklevel=2)
         try:
             return next(d for d in scripts if d["name"].lower() == name.lower())
         except StopIteration:
             return {}
 
-    @staticmethod
-    def filter_regions(regions: list, locations: list) -> list:
-        return [d for d in regions if d["id"] in locations]
-
     def _get(self, url, params: Optional[dict] = None):
         r = self._session.get(url, params=params, timeout=10)
         if not r.ok:

tests/test_all.py

@@ -4,16 +4,19 @@
 vultr = Vultr()
 
 
-def test_free():
+def test_basic():
     per_page = 100
     plans = vultr.get("plans", {"type": "vc2", "per_page": per_page})
     print(f"plans: {len(plans['plans'])}")
     assert len(plans["plans"]) == min(plans["meta"]["total"], per_page)
 
-    regions = vultr.list_regions({"per_page": per_page})
-    print(f"regions: {len(regions)}")
-    assert 0 < len(regions) <= per_page
+    plan = vultr.filter_list(plans["plans"], "vc2-1c-1gb", "id")
+    assert plan.get("id") == "vc2-1c-1gb"
 
-    available = vultr.filter_regions(regions, plans["plans"][0]["locations"])
-    print(f"available: {len(available)}")
-    assert 0 < len(available) <= per_page
+    # regions = vultr.list_regions({"per_page": per_page})
+    # print(f"regions: {len(regions)}")
+    # assert 0 < len(regions) <= per_page
+
+    # available = vultr.filter_regions(regions, plans["plans"][0]["locations"])
+    # print(f"available: {len(available)}")
+    # assert 0 < len(available) <= per_page