Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
Mock for Colour
# -*- coding: utf-8 -*-
"""
Mock for Colour
===============
Defines various objects for mocking to use with
`Colour <https://github.com/colour-science/colour>`_.
References
----------
- :cite:`SphinxTeam` : Sphinx Team. (n.d.). sphinx.ext.autodoc.mock.
Retrieved May 2, 2019, from https://github.com/sphinx-doc/sphinx/blob/\
master/sphinx/ext/autodoc/mock.py
"""
from __future__ import division, unicode_literals
import os
from types import FunctionType, MethodType, ModuleType
__author__ = 'Sphinx Team, Colour Developers'
__copyright__ = 'Copyright 2007-2019 - Sphinx Team'
__copyright__ += ', '
__copyright__ += 'Copyright (C) 2013-2019 - Colour Developers'
__license__ = 'New BSD License - https://opensource.org/licenses/BSD-3-Clause'
__maintainer__ = 'Colour Developers'
__email__ = 'colour-science@googlegroups.com'
__status__ = 'Production'
__all__ = ['MockObject', 'MockModule']
class MockObject:
"""
A generic mock object used for helping to mock tricky *Colour* requirements
such as *Scipy*.
Other Parameters
----------------
\\*args : list, optional
Arguments.
\\**kwargs : dict, optional
Keywords arguments.
References
----------
:cite:`SphinxTeam`
"""
__display_name__ = 'MockObject'
def __new__(cls, *args, **kwargs):
"""
Returns a new instance of the :class:`MockObject` class.
Other Parameters
----------------
\\*args : list, optional
Arguments.
\\**kwargs : dict, optional
Keywords arguments.
"""
if len(args) == 3 and isinstance(args[1], tuple):
superclass = args[1][-1].__class__
if superclass is cls:
return _make_subclass(
args[0],
superclass.__display_name__,
superclass=superclass,
attributes=args[2])
return super().__new__(cls)
def __init__(self, *args, **kwargs):
pass
def __len__(self):
"""
Returns the length of the :class:`MockObject` class instance, i.e. 0.
"""
return 0
def __contains__(self, key):
"""
Returns whether the :class:`MockObject` class instance contains given
key.
Parameters
----------
key : unicode
Key to check whether is is contained in the :class:`MockObject`
class instance.
"""
return False
def __iter__(self):
"""
Iterates over the :class:`MockObject` class instance.
"""
return iter([])
def __mro_entries__(self, bases):
"""
If an object that is not a class object appears in the tuple of bases
of a class definition, then method __mro_entries__ is searched on it.
"""
return (self.__class__, )
def __getitem__(self, key):
"""
Returns the value at given key from the :class:`MockObject` class
instance.
Parameters
----------
key : unicode
Key to return the value at.
"""
return _make_subclass(key, self.__display_name__, self.__class__)()
def __getattr__(self, key):
"""
Returns the attribute at given key from the :class:`MockObject` class
instance.
Parameters
----------
key : unicode
Key to return the attribute at.
"""
return _make_subclass(key, self.__display_name__, self.__class__)()
def __call__(self, *args, **kwargs):
"""
Calls the :class:`MockObject` class instance.
Other Parameters
----------------
\\*args : list, optional
Arguments.
\\**kwargs : dict, optional
Keywords arguments.
"""
if args and type(args[0]) in [FunctionType, MethodType]:
return args[0]
return self
def __repr__(self):
"""
Returns an evaluable string representation of the :class:`MockObject`
class instance.
"""
return self.__display_name__
def _make_subclass(name, module, superclass=MockObject, attributes=None):
"""
A sub-class factory that makes sub-classes of given super-class type.
Parameters
----------
name : unicode
Name of the sub-class.
module : unicode
Name of the sub-class module.
superclass : object
Super-class type.
attributes : dict
Attributes to set the sub-class with.
"""
attrs = {'__module__': module, '__display_name__': module + '.' + name}
attrs.update(attributes or {})
return type(name, (superclass, ), attrs)
class MockModule(ModuleType):
"""
A mock object used to mock modules.
Parameters
----------
name : unicode
Name of the mocked module.
References
----------
:cite:`SphinxTeam`
"""
__file__ = os.devnull
def __init__(self, name):
super().__init__(name)
self.__all__ = []
self.__path__ = []
def __getattr__(self, name):
"""
Returns the attribute at given key from the :class:`MockModule` class
instance.
Parameters
----------
key : unicode
Key to return the attribute at.
"""
return _make_subclass(name, self.__name__)()
def __repr__(self):
"""
Returns an evaluable string representation of the :class:`MockModule`
class instance.
"""
return self.__name__
if __name__ == '__main__':
import sys
for module in ('scipy', 'scipy.interpolate', 'scipy.spatial',
'scipy.spatial.distance', 'scipy.optimize'):
sys.modules[module] = MockModule(module)
import colour
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.