Merge pull request #300 from ppizarror/fix-ascii-py2

Fix ascii py2

Author: ppizarror

docs/_source/themes.rst

@@ -69,7 +69,7 @@ Background Color/Images
 -----------------------
 
 Theme background can be both a color or an image. All colors can be defined
-using a tuple or an list of 3 or 4 numbers between 0 and 255. The format of
+using a tuple or a list of 3 or 4 numbers between 0 and 255. The format of
 the numbers are:
 
 .. code-block:: python

pygame_menu/__init__.py

@@ -45,7 +45,7 @@
 # Import modules that require pygame
 if __pygame_version__ is not None:
     """
-    BaseImage: Provides basic image loading an manipulation with pygame
+    BaseImage: Provides basic image loading and manipulation with pygame
     """
     import pygame_menu.baseimage
 

pygame_menu/baseimage.py

@@ -4,7 +4,7 @@
 https://github.com/ppizarror/pygame-menu
 
 BASEIMAGE
-Provides a class to perform basic image loading an manipulation with pygame.
+Provides a class to perform basic image loading and manipulation with pygame.
 
 NOTE: pygame-menu v3 will not provide new widgets or functionalities, consider
 upgrading to the latest version.
@@ -44,7 +44,7 @@
     _Path = None
 
 import pygame
-from pygame_menu.utils import assert_vector2
+from pygame_menu.utils import assert_vector2, isinstance_str
 
 # Example image paths
 __images_path__ = path.join(path.dirname(path.abspath(__file__)), 'resources', 'images', '{0}')
@@ -74,7 +74,7 @@
 class BaseImage(object):
     """
     Object that loads an image, stores as a surface, transform it and
-    let write the image to an surface.
+    let write the image to a surface.
 
     :param image_path: Path of the image to be loaded. It can be a string or :py:class:`pathlib.Path` on ``Python 3+``
     :type image_path: str, :py:class:`pathlib.Path`
@@ -92,12 +92,10 @@ def __init__(self,
                  drawing_offset=(0, 0),
                  load_from_file=True
                  ):
-        if _Path is None:
-            assert isinstance(image_path, str)
-        else:
-            assert isinstance(image_path, (str, _Path))
+        if _Path is not None:
             if isinstance(image_path, _Path):
                 image_path = str(image_path)
+        assert isinstance_str(image_path)
         assert isinstance(load_from_file, bool)
 
         _, file_extension = path.splitext(image_path)
@@ -340,7 +338,7 @@ def pick_channels(self, channels):
         :return: Self reference
         :rtype: BaseImage
         """
-        if isinstance(channels, str):
+        if isinstance_str(channels):
             channels = [channels]
         assert isinstance(channels, (list, tuple))
         assert 1 <= len(channels) <= 3, 'maximum size of channels can be 3'

pygame_menu/examples/game_selector.py

@@ -100,7 +100,6 @@ def play_function(difficulty, font, test=False):
     """
     assert isinstance(difficulty, (tuple, list))
     difficulty = difficulty[0]
-    assert isinstance(difficulty, str)
 
     # Define globals
     global main_menu

pygame_menu/menu.py

@@ -127,23 +127,23 @@ def __init__(self,
                  ):
         assert isinstance(height, (int, float))
         assert isinstance(width, (int, float))
-        # assert isinstance(title, str)
+        assert _utils.isinstance_str(title)
 
         assert isinstance(center_content, bool)
         assert isinstance(column_force_fit_text, bool)
         assert isinstance(column_max_width, (tuple, type(None), (int, float), list))
         assert isinstance(columns, int)
         assert isinstance(enabled, bool)
         assert isinstance(joystick_enabled, bool)
-        assert isinstance(menu_id, str)
+        assert _utils.isinstance_str(menu_id)
         assert isinstance(menu_position, (tuple, list))
         assert isinstance(mouse_enabled, bool)
         assert isinstance(mouse_motion_selection, bool)
         assert isinstance(mouse_visible, bool)
         assert isinstance(overflow, (tuple, list, bool))
         assert isinstance(rows, (int, type(None)))
         assert isinstance(screen_dimension, (tuple, list, type(None)))
-        assert isinstance(theme, _themes.Theme), 'theme bust be an pygame_menu.themes.Theme object instance'
+        assert isinstance(theme, _themes.Theme), 'theme bust be a pygame_menu.themes.Theme object instance'
         assert isinstance(touchscreen_enabled, bool)
         assert isinstance(touchscreen_motion_selection, bool)
 
@@ -468,7 +468,7 @@ def add_button(self,
 
         # Get ID
         button_id = kwargs.pop('button_id', '')
-        assert isinstance(button_id, str), 'id must be a string'
+        assert _utils.isinstance_str(button_id), 'id must be a string'
 
         # Change action if certain events
         if action == _events.PYGAME_QUIT or action == _events.PYGAME_WINDOWCLOSE:
@@ -708,7 +708,7 @@ def add_label(self,
         :return: Widget object, or List of widgets if the text overflows
         :rtype: :py:class:`pygame_menu.widgets.Label`, list[:py:class:`pygame_menu.widgets.Label`]
         """
-        assert isinstance(label_id, str)
+        assert _utils.isinstance_str(label_id)
         assert isinstance(max_char, int)
         assert isinstance(selectable, bool)
         assert max_char >= -1
@@ -929,7 +929,9 @@ def add_text_input(self,
         :return: Widget object
         :rtype: :py:class:`pygame_menu.widgets.TextInput`
         """
-        assert isinstance(default, (str, int, float))
+        if not isinstance(default, (int, float)):
+            assert _utils.isinstance_str(default), \
+                'default value must be a string, an integer or a float value'
 
         # Filter widget attributes to avoid passing them to the callbacks
         attributes = self._filter_widget_attributes(kwargs)
@@ -1042,7 +1044,7 @@ def _filter_widget_attributes(self, kwargs):
         """
         attributes = {}
         align = kwargs.pop('align', self._theme.widget_alignment)
-        assert isinstance(align, str)
+        assert _utils.isinstance_str(align)
         attributes['align'] = align
 
         background_is_color = False
@@ -1077,7 +1079,7 @@ def _filter_widget_attributes(self, kwargs):
         attributes['font_color'] = font_color
 
         font_name = kwargs.pop('font_name', self._theme.widget_font)
-        assert isinstance(font_name, str)
+        assert _utils.isinstance_str(font_name)
         attributes['font_name'] = font_name
 
         font_size = kwargs.pop('font_size', self._theme.widget_font_size)
@@ -1111,7 +1113,7 @@ def _filter_widget_attributes(self, kwargs):
         attributes['shadow_color'] = shadow_color
 
         shadow_position = kwargs.pop('shadow_position', self._theme.widget_shadow_position)
-        assert isinstance(shadow_position, str)
+        assert _utils.isinstance_str(shadow_position)
         attributes['shadow_position'] = shadow_position
 
         shadow_offset = kwargs.pop('shadow_offset', self._theme.widget_shadow_offset)
@@ -1212,7 +1214,7 @@ def select_widget(self, widget):
         :type widget: :py:class:`pygame_menu.widgets.core.widget.Widget`, str
         :return: None
         """
-        if isinstance(widget, str):
+        if _utils.isinstance_str(widget):
             widget = self.get_widget(widget_id=widget)
         assert isinstance(widget, _widgets.core.Widget)
         if not widget.is_selectable:
@@ -1234,7 +1236,7 @@ def remove_widget(self, widget):
         :type widget: :py:class:`pygame_menu.widgets.core.widget.Widget`, str
         :return: None
         """
-        if isinstance(widget, str):
+        if _utils.isinstance_str(widget):
             widget = self.get_widget(widget_id=widget)
         assert isinstance(widget, _widgets.core.Widget)
         try:
@@ -1475,7 +1477,7 @@ def _build_widget_surface(self):
         sx = self._scroll.get_scrollbar_thickness(_locals.ORIENTATION_HORIZONTAL, real=True)
         sy = self._scroll.get_scrollbar_thickness(_locals.ORIENTATION_VERTICAL, real=True)
 
-        # Remove the thick of the scrollbar to avoid displaying an horizontal one
+        # Remove the thick of the scrollbar to avoid displaying a horizontal one
         # If overflow in both axis
         if max_x > self._width and max_y > self._height - menubar_height:
             width, height = max_x + sy * 0.5, max_y + sx * 0.25
@@ -1524,7 +1526,7 @@ def _check_id_duplicated(self, widget_id):
         :type widget_id: str
         :return: None
         """
-        assert isinstance(widget_id, str)
+        assert _utils.isinstance_str(widget_id)
         for widget in self._widgets:  # type: _widgets.core.Widget
             if widget.get_id() == widget_id:
                 raise IndexError('widget ID="{0}" already exists on the menu'.format(widget_id))
@@ -2541,7 +2543,7 @@ def get_widget(self, widget_id, recursive=False):
         :return: Widget object
         :rtype: :py:class:`pygame_menu.widgets.core.widget.Widget`, None
         """
-        assert isinstance(widget_id, str)
+        assert _utils.isinstance_str(widget_id)
         assert isinstance(recursive, bool)
         for widget in self._widgets:  # type: _widgets.core.Widget
             if widget.get_id() == widget_id:
@@ -2651,7 +2653,7 @@ def set_attribute(self, key, value):
         :type value: any
         :return: None
         """
-        assert isinstance(key, str)
+        assert _utils.isinstance_str(key)
         self._attributes[key] = value
 
     def get_attribute(self, key, default=None):
@@ -2665,7 +2667,7 @@ def get_attribute(self, key, default=None):
         :return: Attribute data
         :rtype: any
         """
-        assert isinstance(key, str)
+        assert _utils.isinstance_str(key)
         if not self.has_attribute(key):
             return default
         return self._attributes[key]
@@ -2679,7 +2681,7 @@ def has_attribute(self, key):
         :return: True if exists
         :rtype: bool
         """
-        assert isinstance(key, str)
+        assert _utils.isinstance_str(key)
         return key in self._attributes.keys()
 
     def remove_attribute(self, key):

pygame_menu/sound.py

@@ -48,6 +48,8 @@
     AUDIO_ALLOW_CHANNELS_CHANGE = False
     AUDIO_ALLOW_FREQUENCY_CHANGE = False
 
+from pygame_menu.utils import isinstance_str
+
 # Sound types
 SOUND_TYPE_CLICK_MOUSE = '__pygame_menu_sound_click_mouse__'
 SOUND_TYPE_CLOSE_MENU = '__pygame_menu_sound_close_menu__'
@@ -118,7 +120,7 @@ def __init__(self,
         assert isinstance(size, int)
         assert isinstance(channels, int)
         assert isinstance(buffer, int)
-        assert isinstance(devicename, str)
+        assert isinstance_str(devicename)
         assert isinstance(allowedchanges, int)
         assert isinstance(force_init, bool)
         assert frequency > 0, 'frequency must be greater than zero'
@@ -227,8 +229,9 @@ def set_sound(self, sound_type, sound_file, volume=0.5, loops=0, maxtime=0, fade
         :return: The status of the sound load, *True* if the sound was loaded
         :rtype: bool
         """
-        assert isinstance(sound_type, str)
-        assert isinstance(sound_file, (str, type(None)))
+        assert isinstance_str(sound_type)
+        if sound_file is not None:
+            assert isinstance_str(sound_file)
         assert isinstance(volume, float)
         assert isinstance(loops, int)
         assert isinstance(maxtime, (int, float))

pygame_menu/themes.py

@@ -71,7 +71,7 @@ class Theme(object):
     :type focus_background_color: tuple, list
     :param menubar_close_button: Draw a back-box button on header to close the menu, if user moves through nested submenus this buttons turns to a back-arrow
     :type menubar_close_button: bool
-    :param scrollarea_outer_margin: Outer scroll area margin (px), the tuple is added to computed scroll area width/height, it can add an margin to bottom/right scrolls after widgets. If value less than 1 use percentage of width/height. Default *(0,0)*. It cannot be negative values
+    :param scrollarea_outer_margin: Outer scroll area margin (px), the tuple is added to computed scroll area width/height, it can add a margin to bottom/right scrolls after widgets. If value less than 1 use percentage of width/height. Default *(0,0)*. It cannot be negative values
     :type scrollarea_outer_margin: tuple, list
     :param scrollbar_color: Scrollbars color
     :type scrollbar_color: tuple, list
@@ -399,54 +399,89 @@ def _get(params, key, allowed_types=None, default=None):
         """
         Return a value from a dictionary.
 
-        :param params: parameters dictionary
+        Custom types (str)
+            -   alignment           pygame-menu alignment (locals)
+            -   callable            Is callable type, same as ``"function"``
+            -   color               Check color
+            -   color_image         Color or :py:class:`pygame_menu.baseimage.BaseImage`
+            -   color_image_none    Color, :py:class:`pygame_menu.baseimage.BaseImage`, or None
+            -   color_none          Color or None
+            -   cursor              Cursor object (pygame)
+            -   font                Font type
+            -   image               Value must be ``BaseImage``
+            -   none                None only
+            -   position            pygame-menu position (locals)}
+            -   tuple2              Only valid numeric tuples ``(x, y)`` or ``[x, y]``
+            -   type                Type-class (bool, str, etc...)
+
+        :param params: Parameters dictionary
         :type params: dict
-        :param key: key to look for
+        :param key: Key to look for
         :type key: str
-        :param allowed_types: list of allowed types
+        :param allowed_types: List of allowed types
         :type allowed_types: any
-        :param default: default value to return
+        :param default: Default value to return
         :type default: any
         :return: The value associated to the key
         :rtype: any
         """
-        if key not in params:
-            return default
-
-        value = params.pop(key)
-        if allowed_types:
+        value = params.pop(key, default)
+        if allowed_types is not None:
+            other_types = []  # Contain other types to check from
             if not isinstance(allowed_types, (tuple, list)):
                 allowed_types = (allowed_types,)
             for val_type in allowed_types:
-                if val_type == 'color':
-                    _utils.assert_color(value)
-                elif val_type == 'color_none':
-                    if value is None:
-                        return value
+
+                if val_type == 'alignment':
+                    _utils.assert_alignment(value)
+
+                elif val_type == callable or val_type == 'function' or val_type == 'callable':
+                    assert _utils.is_callable(value), \
+                        'value must be callable type'
+
+                elif val_type == 'color':
                     _utils.assert_color(value)
+
                 elif val_type == 'color_image':
-                    if isinstance(value, BaseImage):
-                        return value
-                    _utils.assert_color(value)
+                    if not isinstance(value, BaseImage):
+                        _utils.assert_color(value)
+
                 elif val_type == 'color_image_none':
-                    if value is None:
-                        return value
-                    elif isinstance(value, BaseImage):
-                        return value
-                    _utils.assert_color(value)
+                    if not (value is None or isinstance(value, BaseImage)):
+                        _utils.assert_color(value)
+
+                elif val_type == 'color_none':
+                    if value is not None:
+                        _utils.assert_color(value)
+
+                elif val_type == 'image':
+                    assert isinstance(value, BaseImage), \
+                        'value must be BaseImage type'
+
+                elif val_type == 'none':
+                    assert value is None
+
                 elif val_type == 'position':
                     _utils.assert_position(value)
-                elif val_type == 'alignment':
-                    _utils.assert_alignment(value)
+
+                elif val_type == 'type':
+                    assert isinstance(value, type), \
+                        'value is not type-class'
+
                 elif val_type == 'tuple2':
                     _utils.assert_vector2(value)
 
-            all_types = ('color', 'color_none', 'color_image', 'color_image_none',
-                         'position', 'alignment', 'tuple2')
-            others = tuple(t for t in allowed_types if t not in all_types)
-            if others:
+                else:  # Unknown type
+                    assert isinstance(val_type, type), \
+                        'allowed type "{0}" is not a type-class'.format(val_type)
+                    other_types.append(val_type)
+
+            # Check other types
+            if len(other_types) > 0:
+                others = tuple(other_types)
                 msg = 'Theme.{} type shall be in {} types (got {})'.format(key, others, type(value))
                 assert isinstance(value, others), msg
+
         return value