Add DataStore.get_as

docs/source/changelogs/v2-changelog.rst

@@ -6,6 +6,11 @@ Below are all the changelogs for the stable versions of hikari-lightbulb (versio
 
 ----
 
+Version 2.2.4
+=============
+
+- Add :obj:`~lightbulb.utils.data_store.DataStore.get_as` to allow ``DataStore`` to be more type-complete.
+
 Version 2.2.3
 =============
 

lightbulb/__init__.py

@@ -179,4 +179,4 @@
 from lightbulb.help_command import *
 from lightbulb.plugins import *
 
-__version__ = "2.2.3"
+__version__ = "2.2.4"

lightbulb/utils/data_store.py

@@ -21,11 +21,13 @@
 
 import typing as t
 
+T = t.TypeVar("T")
+
 
 class DataStore(t.Dict[str, t.Any]):
     """
     Data storage class allowing setting, retrieval and unsetting of custom
-    attributes. This class subclasses dict so the data can be accessed the same
+    attributes. This class subclasses :obj:`dict` so the data can be accessed the same
     as you would a dictionary as well as using dot notation.
 
     Example:
@@ -57,3 +59,21 @@ def __setattr__(self, key: str, value: t.Any) -> None:
 
     def __delattr__(self, item: str) -> None:
         self.pop(item, None)
+
+    def get_as(self, item: str, type: t.Type[T]) -> T:
+        """
+        Helper method to allow type-complete getting of items from this ``DataStore``.
+
+        Args:
+            item (:obj:`str`): The name of the key that the item is stored at.
+            type (Type[T]): The type to cast the item as.
+
+        Returns:
+            T: The item stored at key ``item``, cast to the given type.
+
+        Raises:
+            :obj:`ValueError`: If a key of name ``item`` has not been set.
+        """
+        if item not in self:
+            raise TypeError(f"Item {item!r} was never set")
+        return t.cast(type, self.get(item))  # type: ignore