Image._init() - Code Metrics - Inspection of "Add Console, Image classes. Add Google style docs." - HexDecimal/libtcod-cffi - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — doc-style ( 67e2d5 )

by Kyle

created 2016-10-26 11:37 UTC

Image._init() A

↳ Parent: Image

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
c	1
b	0
f	0
dl	0
loc	3
rs	10

"""This module focuses on improvements to the Python libtcod API.
"""
from __future__ import absolute_import as _

import os as _os

import sys as _sys

import platform as _platform

import weakref as _weakref
import functools as _functools

from tcod.libtcod import lib, ffi

def _unpack_char_p(char_p):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
    if char_p == ffi.NULL:

        return ''
    return ffi.string(char_p).decode()


def _int(int_or_str):
    'return an integer where a single character string may be expected'
    if isinstance(int_or_str, str):
        return ord(int_or_str)
    if isinstance(int_or_str, bytes):
        return int_or_str[0]
    return int(int_or_str) # check for __count__

def _cdata(cdata):
    """covert value into a cffi.CData instance"""
    try: # first check for _CDataWrapper
        cdata = cdata.cdata
    except AttributeError: # assume cdata is valid
try:
    raises_exception()
except:  # Could be removed
    pass
        pass
    except KeyError:
try:
    raises_exception()
except:  # Could be removed
    pass
        pass
    if cdata is None or cdata == 0: # convert None to NULL
        cdata = ffi.NULL

    return cdata

if _sys.version_info[0] == 2: # Python 2
    def _bytes(string):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        if isinstance(string, unicode):

            return string.encode()
        return string

    def _unicode(string):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        if not isinstance(string, unicode):

            return string.decode()
        return string

else: # Python 3
    def _bytes(string):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        if isinstance(string, str):
            return string.encode()
        return string

    def _unicode(string):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        if isinstance(string, bytes):
            return string.decode()
        return string

class _PropagateException():
    """ context manager designed to propagate exceptions outside of a cffi
    callback context.  normally cffi suppresses the exception

    when propagate is called this class will hold onto the error until the
    control flow leaves the context, then the error will be raised

    with _PropagateException as propagate:
    # give propagate as onerror parameter for ffi.def_extern
    """

    def __init__(self):
        self.exc_info = None # (exception, exc_value, traceback)

    def propagate(self, *exc_info):
        """ set an exception to be raised once this context exits

        if multiple errors are caught, only keep the first exception raised
        """
        if not self.exc_info:
            self.exc_info = exc_info

    def __enter__(self):
        """ once in context, only the propagate call is needed to use this
        class effectively
        """
        return self.propagate

    def __exit__(self, type, value, traceback):

        """ if we're holding on to an exception, raise it now

        prefers our held exception over any current raising error

        self.exc_info is reset now in case of nested manager shenanigans
        """
        if self.exc_info:
            type, value, traceback = self.exc_info
a, b = ("a", "b", "c")  # only 2 labels for 3 values
            self.exc_info = None
        if type:
            # Python 2/3 compatible throw
            exception = type(value)
            exception.__traceback__ = traceback
            raise exception

class _CDataWrapper(object):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""

    def __init__(self, *args, **kargs):
        self.cdata = self._get_cdata_from_args(*args, **kargs)
        if self.cdata == None:
            self.cdata = ffi.NULL

        super(_CDataWrapper, self).__init__()

    def _get_cdata_from_args(self, *args, **kargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        if len(args) == 1 and isinstance(args[0], ffi.CData) and not kargs:

            return args[0]
        else:
            return None


    def __hash__(self):
        return hash(self.cdata)

    def __eq__(self, other):
        try:
            return self.cdata == other.cdata
        except AttributeError:
            return NotImplemented

    def __getattr__(self, attr):
        if 'cdata' in self.__dict__:
            return getattr(self.__dict__['cdata'], attr)
        raise AttributeError(attr)

    def __setattr__(self, attr, value):
        if hasattr(self, 'cdata') and hasattr(self.cdata, attr):
            setattr(self.cdata, attr, value)
        else:
            super(_CDataWrapper, self).__setattr__(attr, value)

def _assert_cdata_is_not_null(func):
    """Any BSP methods which use a cdata object in a TCOD call need to have
    a sanity check, otherwise it may end up passing a NULL pointer"""
    if __debug__:
        @_functools.wraps(func)
        def check_sanity(*args, **kargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
            assert self.cdata != ffi.NULL and self.cdata is not None, \

                   'cannot use function, cdata is %r' % self.cdata

            return func(*args, **kargs)
    return func

class BSP(_CDataWrapper):
    """

    .. attribute:: x
    .. attribute:: y
    .. attribute:: w
    .. attribute:: h

    :param int x: rectangle left coordinate
    :param int y: rectangle top coordinate
    :param int w: rectangle width
    :param int h: rectangle height

    .. versionchanged:: 2.0
       You can create BSP's with this class contructor instead of using
       :any:`bsp_new_with_size`.

    """

    def __init__(self, *args, **kargs):
        self._reference = None # to prevent garbage collection
        self._children = _weakref.WeakSet() # used by _invalidate_children
        super(BSP, self).__init__(*args, **kargs)
        if self._get_cdata_from_args(*args, **kargs) is None:
            self._init(*args, **kargs)

    def _init(self, x, y, w, h):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        self.cdata = ffi.gc(lib.TCOD_bsp_new_with_size(x, y, w, h),

                             lib.TCOD_bsp_delete)


    def _pass_reference(self, reference):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        self._reference = reference
        self._reference._children.add(self)
        return self

    def _invalidate_children(self):
        """Invalidates BSP instances known to be based off of this one."""
        for child in self._children:
            child._reference = None
            child._invalidate_children()
            child.cdata = ffi.NULL

        self._children.clear()

    def __repr__(self):
        """Provide a useful readout when printed."""
        if not self.cdata:
            return '<%s NULL!>' % self.__class__.__name__

        status = 'leaf'
        if not self.is_leaf():
            status = ('split at dicision=%i,orientation=%r' %
                      (self.get_division(), self.get_orientation()))

        return ('<%s(x=%i,y=%i,w=%i,h=%i)depth=%i,%s>' %
                (self.__class__.__name__,
                 self.x, self.y, self.w, self.h, self.get_depth(), status))

    def get_depth(self):
        """Return the depth of this node.

        :rtype: int

        .. versionadded:: 2.0
        """
        return self.cdata.level

    def get_division(self):
        """Return the point where this node was divided into parts.

        :rtype: :any:`int` or :any:`None`

        .. versionadded:: 2.0
        """
        if self.is_leaf():
            return None
        return self.cdata.position

    def get_orientation(self):
        """

        :rtype: str

        .. versionadded:: 2.0
        """
        if self.is_leaf():
            return ''
        elif self.cdata.horizontal:
            return 'horizontal'
        else:
            return 'vertical'

    @_assert_cdata_is_not_null
    def split_once(self, orientation, position):
        """

        :rtype: tuple

        .. versionadded:: 2.0
        """
        # orientation = horz
        if orientation[:1].lower() == 'h':
            lib.TCOD_bsp_split_once(self.cdata, True, position)

        elif orientation[:1].lower() == 'v':
            lib.TCOD_bsp_split_once(self.cdata, False, position)

        else:
            raise ValueError("orientation must be 'horizontal' or 'vertical'"
                             "\nNot %r" % orientation)
        return self.get_children()

    @_assert_cdata_is_not_null
    def split_recursive(self, depth, min_width, min_height,
                        max_horz_ratio, max_vert_raito, random=None):
        """

        :rtype: iter

        .. versionadded:: 2.0
        """
        lib.TCOD_bsp_split_recursive(self.cdata, random or ffi.NULL,

                                      depth, min_width, min_height,
                                      max_horz_ratio, max_vert_raito)
        return self.walk()

    @_assert_cdata_is_not_null
    def resize(self, x, y, w, h):
        """Resize this BSP to the provided rectangle.

        :param int x: rectangle left coordinate
        :param int y: rectangle top coordinate
        :param int w: rectangle width
        :param int h: rectangle height

        .. versionadded:: 2.0
        """
        lib.TCOD_bsp_resize(self.cdata, x, y, w, h)


    @_assert_cdata_is_not_null
    def get_left(self):
        """Return this BSP's 'left' child.

        Returns None if this BSP is a leaf node.

        :return: BSP's left/top child or None.
        :rtype: :any:`BSP` or :any:`None`

        .. versionadded:: 2.0
        """
        if self.is_leaf():
            return None
        return BSP(lib.TCOD_bsp_left(self.cdata))._pass_reference(self)


    @_assert_cdata_is_not_null
    def get_right(self):
        """Return this BSP's 'right' child.

        Returns None if this BSP is a leaf node.

        :return: BSP's right/bottom child or None.
        :rtype: :any:`BSP` or :any:`None`

        .. versionadded:: 2.0
        """
        if self.is_leaf():
            return None
        return BSP(lib.TCOD_bsp_right(self.cdata))._pass_reference(self)


    @_assert_cdata_is_not_null
    def get_parent(self):
        """Return this BSP's parent node.

        :return: Returns the parent node as a BSP instance.
                 Returns None if this BSP has no parent.
        :rtype: :any:`BSP` or :any:`None`

        .. versionadded:: 2.0
        """
        node = BSP(lib.TCOD_bsp_father(self.cdata))._pass_reference(self)

        if node.cdata == ffi.NULL:

            return None
        return node

    @_assert_cdata_is_not_null
    def get_children(self):
        """Return as a tuple, this instances immediate children, if any.

        :return: Returns a tuple of (left, right) BSP instances.
                 The returned tuple is empty if this BSP has no children.
        :rtype: tuple

        .. versionadded:: 2.0
        """
        if self.is_leaf():
            return ()
        return (BSP(lib.TCOD_bsp_left(self.cdata))._pass_reference(self),

                BSP(lib.TCOD_bsp_right(self.cdata))._pass_reference(self))


    @_assert_cdata_is_not_null
    def walk(self):
        """Iterate over this BSP's hieracrhy.

        The iterator will include the instance which called it.
        It will traverse its own children and grandchildren, in no particular
        order.

        :return: Returns an iterator of BSP instances.
        :rtype: iter

        .. versionadded:: 2.0
        """
        for child in self.get_children():
            for grandchild in child.walk():
                yield grandchild
        yield self

    @_assert_cdata_is_not_null
    def is_leaf(self):
        """Returns True if this node is a leaf.  False when this node has children.


        :rtype: bool

        .. versionadded:: 2.0
        """
        return bool(lib.TCOD_bsp_is_leaf(self.cdata))


    @_assert_cdata_is_not_null
    def contains(self, x, y):
        """Returns True if this node contains these coordinates.

        :rtype: bool

        .. versionadded:: 2.0
        """
        return bool(lib.TCOD_bsp_contains(self.cdata, x, y))


    @_assert_cdata_is_not_null
    def find_node(self, x, y):
        """Return the deepest node which contains these coordinates.

        :rtype: :any:`BSP` or :any:`None`

        .. versionadded:: 2.0
        """
        node = BSP(lib.TCOD_bsp_find_node(self.cdata,

                                           x, y))._pass_reference(self)
        if node.cdata == ffi.NULL:

            node = None
        return node

class HeightMap(_CDataWrapper):
    """libtcod HeightMap instance
    """

    def __init__(self, *args, **kargs):
        super(HeightMap, self).__init__(*args, **kargs)
        if not self.cdata:
            self._init(*args, **kargs)

    def _init(self, width, height):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        self.cdata = ffi.gc(lib.TCOD_heightmap_new(width, height),

                            lib.TCOD_heightmap_delete)



class Key(_CDataWrapper):
    """Key Event instance
    """

    def __init__(self, *args):
        super(Key, self).__init__(*args)
        if self.cdata == ffi.NULL:

            self.cdata = ffi.new('TCOD_key_t*')


    def __getattr__(self, attr):
        if attr == 'c':
            return ord(getattr(self.cdata, attr))
        else:
            return super(Key, self).__getattr__(attr)

class Mouse(_CDataWrapper):
    """Mouse event instance
    """

    def __init__(self, *args):
        super(Mouse, self).__init__(*args)
        if self.cdata == ffi.NULL:

            self.cdata = ffi.new('TCOD_mouse_t*')



class Console(_CDataWrapper):
    """

    .. versionadded:: 2.0
    """

    def __init__(self, *args, **kargs):
class SomeParent:
    def __init__(self):
        self.x = 1

class SomeChild(SomeParent):
    def __init__(self):
        # Initialize the super class
        SomeParent.__init__(self)
        self.cdata = self._get_cdata_from_args(*args, **kargs)
        if self.cdata is None:
            self._init(*args, **kargs)

    def _init(self, width, height):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        self.cdata = ffi.gc(lib.TCOD_console_new(width, height),

                            lib.TCOD_console_delete)


class Image(_CDataWrapper):
    """

    .. versionadded:: 2.0
    """
    def __init__(self, *args, **kargs):
        super(Console, self).__init__(*args, **kargs)

        if not self.cdata:
            self._init(*args, **kargs)

    def _init(self, width, height):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        self.cdata = ffi.gc(lib.TCOD_image_new(width, height),

                            lib.TCOD_image_delete)


def clipboard_set(string):
    """Set the clipboard contents to string.

    .. versionadded:: 2.0
    """
    lib.TCOD_sys_clipboard_set(_bytes(string))


def clipboard_get():
    """Return the current contents of the clipboard.

    .. versionadded:: 2.0
    """
    return _unpack_char_p(lib.TCOD_sys_clipboard_get())


@ffi.def_extern()
def _pycall_bsp_callback(node, handle):
    """static bool _pycall_bsp_callback(TCOD_bsp_t *node, void *userData);"""
    func, userData, propagate = ffi.from_handle(handle)

    try:
        return func(BSP(node), userData)
    except BaseException:
        propagate(*_sys.exc_info())
        return False


__all__ = [_name for _name in list(globals()) if _name[0] != '_']


1			"""This module focuses on improvements to the Python libtcod API.
2			"""
3			from __future__ import absolute_import as _
4
5			import os as _os
			0 ignored issues – show Unused Code introduced 2016-10-14 03:53 UTC by Report Bug Copy Issue Report Unused os imported as _os Loading history...
6			import sys as _sys
7
8			import platform as _platform
			0 ignored issues – show Unused Code introduced 2016-10-14 03:53 UTC by Report Bug Copy Issue Report Unused platform imported as _platform Loading history...
9			import weakref as _weakref
10			import functools as _functools
11
12			from tcod.libtcod import lib, ffi
13
14			def _unpack_char_p(char_p):
			0 ignored issues – show Coding Style introduced 2016-10-12 22:48 UTC by Report Bug Copy Issue Report This function should have a docstring. The coding style of this project requires that you add a docstring to this code element. Below, you find an example for methods: class SomeClass: def some_method(self): """Do x and return foo.""" If you would like to know more about docstrings, we recommend to read PEP-257: Docstring Conventions. Loading history...
15			if char_p == ffi.NULL:
			0 ignored issues – show Bug introduced 2016-10-16 23:42 UTC by Report Bug Copy Issue Report The Instance of `_MockFFI` does not seem to have a member named `NULL`. This check looks for calls to members that are non-existent. These calls will fail. The member could have been renamed or removed. Loading history...
16			return ''
17			return ffi.string(char_p).decode()
			0 ignored issues – show Bug introduced 2016-10-16 23:42 UTC by Report Bug Copy Issue Report The Instance of `_MockFFI` does not seem to have a member named `string`. This check looks for calls to members that are non-existent. These calls will fail. The member could have been renamed or removed. Loading history...
18
19			def _int(int_or_str):
20			'return an integer where a single character string may be expected'
21			if isinstance(int_or_str, str):
22			return ord(int_or_str)
23			if isinstance(int_or_str, bytes):
24			return int_or_str[0]
25			return int(int_or_str) # check for __count__
26
27			def _cdata(cdata):
28			"""covert value into a cffi.CData instance"""
29			try: # first check for _CDataWrapper
30			cdata = cdata.cdata
31			except AttributeError: # assume cdata is valid
			0 ignored issues – show Unused Code introduced 2016-10-16 05:14 UTC by Report Bug Copy Issue Report This except handler seems to be unused and could be removed. Except handlers which only contain `pass` and do not have an `else` clause can usually simply be removed: try: raises_exception() except: # Could be removed pass Loading history...
32			pass
33			except KeyError:
			0 ignored issues – show Unused Code introduced 2016-10-16 05:14 UTC by Report Bug Copy Issue Report This except handler seems to be unused and could be removed. Except handlers which only contain `pass` and do not have an `else` clause can usually simply be removed: try: raises_exception() except: # Could be removed pass Loading history...

HexDecimal / libtcod-cffi

Push — doc-style ( 67e2d5 )

Image._init() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like