MNT: Adding method to find images and refactoring.

README.md

@@ -19,6 +19,7 @@
 
 # Prerequisites
 * Python 3.7+
+* Pillow
 
 Python package requirements are listed in the requirements.txt file, which can
 be used to install all requirements from pip: 'pip install -r requirements.txt'

botcity/base/bot.py

@@ -1,5 +1,8 @@
+import os
+import pathlib
 import sys
 from os import path
+from PIL import Image
 
 
 class BaseBot:
@@ -30,6 +33,25 @@ def _resources_path(self, resource_folder="resources"):
         path_to_class = sys.modules[self.__module__].__file__
         return path.join(path.dirname(path.realpath(path_to_class)), resource_folder)
 
+    def _search_image_file(self, label):
+        img_path = self.state.map_images.get(label)
+        if img_path:
+            return img_path
+
+        search_path = [self.get_resource_abspath(""), os.getcwd()]
+        for sp in search_path:
+            path = pathlib.Path(sp)
+            found = path.glob(f"{label}.*")
+            for f in found:
+                try:
+                    img = Image.open(f)
+                except Exception:
+                    continue
+                else:
+                    img.close()
+                return str(f.absolute())
+        return None
+
     @classmethod
     def main(cls):
         try:

botcity/base/utils.py

@@ -2,8 +2,6 @@
 import platform
 import subprocess
 
-from .state import SingleState
-
 
 def is_retina():
     """
@@ -20,41 +18,23 @@ def is_retina():
     return False
 
 
-def ensure_state(func):
-    """
-    Decorator to ensure that a State instance is being provided.
-    If no State instance is provided it uses the singleton SingleState.
-
-    Args:
-        func (callable): The function to be wrapped
-
-    Returns:
-        wrapper (callable): The decorated function
-    """
-    @wraps(func)
-    def wrapper(*args, **kwargs):
-        if 'state' not in kwargs:
-            kwargs['state'] = SingleState()
-        return func(*args, **kwargs)
-    return wrapper
-
-
 def only_if_element(func):
     """
-    Decorator which raises if element is None.
+    Decorator which raises if element is None in class State.
 
     Args:
         func (callable): The function to be wrapped
 
     Returns:
         wrapper (callable): The decorated function
     """
+
     @wraps(func)
-    def wrapper(*args, **kwargs):
-        state = kwargs.get('state', SingleState())
-        if state.element is None:
+    def wrapper(self, *args, **kwargs):
+        if self.state.element is None:
             raise ValueError(f'Element not available. Cannot invoke {func.__name__}.')
-        return func(*args, **kwargs)
+        return func(self, *args, **kwargs)
+
     return wrapper
 
 

requirements.txt

@@ -0,0 +1 @@
+Pillow