diff options
Diffstat (limited to 'silx/utils')
| -rw-r--r-- | silx/utils/ExternalResources.py | 321 | ||||
| -rw-r--r-- | silx/utils/enum.py | 79 | ||||
| -rw-r--r-- | silx/utils/proxy.py | 39 | ||||
| -rw-r--r-- | silx/utils/test/__init__.py | 8 | ||||
| -rw-r--r-- | silx/utils/test/test_enum.py | 96 | ||||
| -rw-r--r-- | silx/utils/test/test_external_resources.py | 99 | ||||
| -rw-r--r-- | silx/utils/test/test_number.py | 3 | ||||
| -rw-r--r-- | silx/utils/test/test_proxy.py | 53 | ||||
| -rw-r--r-- | silx/utils/test/test_weakref.py | 6 |
9 files changed, 695 insertions, 9 deletions
diff --git a/silx/utils/ExternalResources.py b/silx/utils/ExternalResources.py new file mode 100644 index 0000000..7d9008b --- /dev/null +++ b/silx/utils/ExternalResources.py @@ -0,0 +1,321 @@ +# coding: utf-8 +# /*########################################################################## +# +# Copyright (c) 2016-2018 European Synchrotron Radiation Facility +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), to deal +# in the Software without restriction, including without limitation the rights +# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +# copies of the Software, and to permit persons to whom the Software is +# furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. +# +# ###########################################################################*/ +"""Helper to access to external resources. +""" + +__authors__ = ["Thomas Vincent", "J. Kieffer"] +__license__ = "MIT" +__date__ = "08/03/2019" + + +import os +import threading +import json +import logging +import tempfile +import unittest +import six + +logger = logging.getLogger(__name__) + + +class ExternalResources(object): + """Utility class which allows to download test-data from www.silx.org + and manage the temporary data during the tests. + + """ + + def __init__(self, project, + url_base, + env_key=None, + timeout=60): + """Constructor of the class + + :param str project: name of the project, like "silx" + :param str url_base: base URL for the data, like "http://www.silx.org/pub" + :param str env_key: name of the environment variable which contains the + test_data directory, like "SILX_DATA". + If None (default), then the name of the + environment variable is built from the project argument: + "<PROJECT>_DATA". + The environment variable is optional: in case it is not set, + a directory in the temporary folder is used. + :param timeout: time in seconds before it breaks + """ + self.project = project + self._initialized = False + self.sem = threading.Semaphore() + + self.env_key = env_key or (self.project.upper() + "_TESTDATA") + self.url_base = url_base + self.all_data = set() + self.timeout = timeout + self._data_home = None + + @property + def data_home(self): + """Returns the data_home path and make sure it exists in the file + system.""" + if self._data_home is not None: + return self._data_home + + data_home = os.environ.get(self.env_key) + if data_home is None: + try: + import getpass + name = getpass.getuser() + except Exception: + if "getlogin" in dir(os): + name = os.getlogin() + elif "USER" in os.environ: + name = os.environ["USER"] + elif "USERNAME" in os.environ: + name = os.environ["USERNAME"] + else: + name = "uid" + str(os.getuid()) + + basename = "%s_testdata_%s" % (self.project, name) + data_home = os.path.join(tempfile.gettempdir(), basename) + if not os.path.exists(data_home): + os.makedirs(data_home) + self._data_home = data_home + return data_home + + def _initialize_data(self): + """Initialize for downloading test data""" + if not self._initialized: + with self.sem: + if not self._initialized: + self.testdata = os.path.join(self.data_home, "all_testdata.json") + if os.path.exists(self.testdata): + with open(self.testdata) as f: + self.all_data = set(json.load(f)) + self._initialized = True + + def clean_up(self): + pass + + def getfile(self, filename): + """Downloads the requested file from web-server available + at https://www.silx.org/pub/silx/ + + :param: relative name of the image. + :return: full path of the locally saved file. + """ + logger.debug("ExternalResources.getfile('%s')", filename) + + if not self._initialized: + self._initialize_data() + + fullfilename = os.path.abspath(os.path.join(self.data_home, filename)) + + if not os.path.isfile(fullfilename): + logger.debug("Trying to download image %s, timeout set to %ss", + filename, self.timeout) + dictProxies = {} + if "http_proxy" in os.environ: + dictProxies['http'] = os.environ["http_proxy"] + dictProxies['https'] = os.environ["http_proxy"] + if "https_proxy" in os.environ: + dictProxies['https'] = os.environ["https_proxy"] + if dictProxies: + proxy_handler = six.moves.urllib.request.ProxyHandler(dictProxies) + opener = six.moves.urllib.request.build_opener(proxy_handler).open + else: + opener = six.moves.urllib.request.urlopen + + logger.debug("wget %s/%s", self.url_base, filename) + try: + data = opener("%s/%s" % (self.url_base, filename), + data=None, timeout=self.timeout).read() + logger.info("Image %s successfully downloaded.", filename) + except six.moves.urllib.error.URLError: + raise unittest.SkipTest("network unreachable.") + + if not os.path.isdir(os.path.dirname(fullfilename)): + # Create sub-directory if needed + os.makedirs(os.path.dirname(fullfilename)) + + try: + with open(fullfilename, "wb") as outfile: + outfile.write(data) + except IOError: + raise IOError("unable to write downloaded \ + data to disk at %s" % self.data_home) + + if not os.path.isfile(fullfilename): + raise RuntimeError( + "Could not automatically \ + download test images %s!\n \ If you are behind a firewall, \ + please set both environment variable http_proxy and https_proxy.\ + This even works under windows ! \n \ + Otherwise please try to download the images manually from \n%s/%s" + % (filename, self.url_base, filename)) + + if filename not in self.all_data: + self.all_data.add(filename) + image_list = list(self.all_data) + image_list.sort() + try: + with open(self.testdata, "w") as fp: + json.dump(image_list, fp, indent=4) + except IOError: + logger.debug("Unable to save JSON list") + + return fullfilename + + def getdir(self, dirname): + """Downloads the requested tarball from the server + https://www.silx.org/pub/silx/ + and unzips it into the data directory + + :param: relative name of the image. + :return: list of files with their full path. + """ + lodn = dirname.lower() + if (lodn.endswith("tar") or lodn.endswith("tgz") or + lodn.endswith("tbz2") or lodn.endswith("tar.gz") or + lodn.endswith("tar.bz2")): + import tarfile + engine = tarfile.TarFile.open + elif lodn.endswith("zip"): + import zipfile + engine = zipfile.ZipFile + else: + raise RuntimeError("Unsupported archive format. Only tar and zip " + "are currently supported") + full_path = self.getfile(dirname) + with engine(full_path, mode="r") as fd: + output = os.path.join(self.data_home, dirname + "__content") + fd.extractall(output) + if lodn.endswith("zip"): + result = [os.path.join(output, i) for i in fd.namelist()] + else: + result = [os.path.join(output, i) for i in fd.getnames()] + return result + + def get_file_and_repack(self, filename): + """ + Download the requested file, decompress and repack it to bz2 and gz. + + :param str filename: name of the image. + :rtype: str + :return: full path of the locally saved file + """ + if not self._initialized: + self._initialize_data() + if filename not in self.all_data: + self.all_data.add(filename) + image_list = list(self.all_data) + image_list.sort() + try: + with open(self.testdata, "w") as fp: + json.dump(image_list, fp, indent=4) + except IOError: + logger.debug("Unable to save JSON list") + baseimage = os.path.basename(filename) + logger.info("UtilsTest.getimage('%s')" % baseimage) + + if not os.path.exists(self.data_home): + os.makedirs(self.data_home) + fullimagename = os.path.abspath(os.path.join(self.data_home, baseimage)) + + if baseimage.endswith(".bz2"): + bzip2name = baseimage + basename = baseimage[:-4] + gzipname = basename + ".gz" + elif baseimage.endswith(".gz"): + gzipname = baseimage + basename = baseimage[:-3] + bzip2name = basename + ".bz2" + else: + basename = baseimage + gzipname = baseimage + "gz2" + bzip2name = basename + ".bz2" + + fullimagename_gz = os.path.abspath(os.path.join(self.data_home, gzipname)) + fullimagename_raw = os.path.abspath(os.path.join(self.data_home, basename)) + fullimagename_bz2 = os.path.abspath(os.path.join(self.data_home, bzip2name)) + + # The files are recreated from the bz2 file + if not os.path.isfile(fullimagename_bz2): + self.getfile(bzip2name) + if not os.path.isfile(fullimagename_bz2): + raise RuntimeError("Could not automatically \ + download test images %s!\n \ If you are behind a firewall, \ + please set the environment variable http_proxy.\n \ + Otherwise please try to download the images manually from \n \ + %s" % (self.url_base, filename)) + + try: + import bz2 + except ImportError: + raise RuntimeError("bz2 library is needed to decompress data") + try: + import gzip + except ImportError: + gzip = None + + raw_file_exists = os.path.isfile(fullimagename_raw) + gz_file_exists = os.path.isfile(fullimagename_gz) + if not raw_file_exists or not gz_file_exists: + with open(fullimagename_bz2, "rb") as f: + data = f.read() + decompressed = bz2.decompress(data) + + if not raw_file_exists: + try: + with open(fullimagename_raw, "wb") as fullimage: + fullimage.write(decompressed) + except IOError: + raise IOError("unable to write decompressed \ + data to disk at %s" % self.data_home) + + if not gz_file_exists: + if gzip is None: + raise RuntimeError("gzip library is expected to recompress data") + try: + gzip.open(fullimagename_gz, "wb").write(decompressed) + except IOError: + raise IOError("unable to write gzipped \ + data to disk at %s" % self.data_home) + + return fullimagename + + def download_all(self, imgs=None): + """Download all data needed for the test/benchmarks + + :param imgs: list of files to download, by default all + :return: list of path with all files + """ + if not self._initialized: + self._initialize_data() + if not imgs: + imgs = self.all_data + res = [] + for fn in imgs: + logger.info("Downloading from silx.org: %s", fn) + res.append(self.getfile(fn)) + return res diff --git a/silx/utils/enum.py b/silx/utils/enum.py new file mode 100644 index 0000000..fece575 --- /dev/null +++ b/silx/utils/enum.py @@ -0,0 +1,79 @@ +# coding: utf-8 +# /*########################################################################## +# +# Copyright (c) 2019 European Synchrotron Radiation Facility +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), to deal +# in the Software without restriction, including without limitation the rights +# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +# copies of the Software, and to permit persons to whom the Software is +# furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. +# +# ###########################################################################*/ +"""An :class:`.Enum` class with additional features.""" + +from __future__ import absolute_import + +__authors__ = ["T. Vincent"] +__license__ = "MIT" +__date__ = "29/04/2019" + + +import enum + + +class Enum(enum.Enum): + """Enum with additional class methods.""" + + @classmethod + def from_value(cls, value): + """Convert a value to corresponding Enum member + + :param value: The value to compare to Enum members + If it is already a member of Enum, it is returned directly. + :return: The corresponding enum member + :rtype: Enum + :raise ValueError: In case the conversion is not possible + """ + if isinstance(value, cls): + return value + for member in cls: + if value == member.value: + return member + raise ValueError("Cannot convert: %s" % value) + + @classmethod + def members(cls): + """Returns a tuple of all members. + + :rtype: Tuple[Enum] + """ + return tuple(member for member in cls) + + @classmethod + def names(cls): + """Returns a tuple of all member names. + + :rtype: Tuple[str] + """ + return tuple(member.name for member in cls) + + @classmethod + def values(cls): + """Returns a tuple of all member values. + + :rtype: Tuple + """ + return tuple(member.value for member in cls) diff --git a/silx/utils/proxy.py b/silx/utils/proxy.py index 7d7d662..8711799 100644 --- a/silx/utils/proxy.py +++ b/silx/utils/proxy.py @@ -1,7 +1,7 @@ # coding: utf-8 # /*########################################################################## # -# Copyright (c) 2016-2018 European Synchrotron Radiation Facility +# Copyright (c) 2016-2019 European Synchrotron Radiation Facility # # Permission is hereby granted, free of charge, to any person obtaining a copy # of this software and associated documentation files (the "Software"), to deal @@ -30,6 +30,8 @@ __authors__ = ["V. Valls"] __license__ = "MIT" __date__ = "02/10/2017" + +import functools import six @@ -202,3 +204,38 @@ class Proxy(object): __irepeat__ = property(lambda self: self.__obj.__irepeat__) __call__ = property(lambda self: self.__obj.__call__) + + +def _docstring(dest, origin): + """Implementation of docstring decorator. + + It patches dest.__doc__. + """ + if not isinstance(dest, type) and isinstance(origin, type): + # func is not a class, but origin is, get the method with the same name + try: + origin = getattr(origin, dest.__name__) + except AttributeError: + raise ValueError( + "origin class has no %s method" % dest.__name__) + + dest.__doc__ = origin.__doc__ + return dest + + +def docstring(origin): + """Decorator to initialize the docstring from another source. + + This is useful to duplicate a docstring for inheritance and composition. + + If origin is a method or a function, it copies its docstring. + If origin is a class, the docstring is copied from the method + of that class which has the same name as the method/function + being decorated. + + :param origin: + The method, function or class from which to get the docstring + :raises ValueError: + If the origin class has not method n case the + """ + return functools.partial(_docstring, origin=origin) diff --git a/silx/utils/test/__init__.py b/silx/utils/test/__init__.py index f16cbdc..029523c 100644 --- a/silx/utils/test/__init__.py +++ b/silx/utils/test/__init__.py @@ -1,7 +1,7 @@ # coding: utf-8 # /*########################################################################## # -# Copyright (c) 2016 European Synchrotron Radiation Facility +# Copyright (c) 2016-2019 European Synchrotron Radiation Facility # # Permission is hereby granted, free of charge, to any person obtaining a copy # of this software and associated documentation files (the "Software"), to deal @@ -24,7 +24,7 @@ # ###########################################################################*/ __authors__ = ["T. Vincent", "P. Knobel"] __license__ = "MIT" -__date__ = "24/05/2018" +__date__ = "08/03/2019" import unittest @@ -36,6 +36,8 @@ from . import test_deprecation from . import test_proxy from . import test_debug from . import test_number +from . import test_external_resources +from . import test_enum def suite(): @@ -48,4 +50,6 @@ def suite(): test_suite.addTest(test_proxy.suite()) test_suite.addTest(test_debug.suite()) test_suite.addTest(test_number.suite()) + test_suite.addTest(test_external_resources.suite()) + test_suite.addTest(test_enum.suite()) return test_suite diff --git a/silx/utils/test/test_enum.py b/silx/utils/test/test_enum.py new file mode 100644 index 0000000..a72da46 --- /dev/null +++ b/silx/utils/test/test_enum.py @@ -0,0 +1,96 @@ +# coding: utf-8 +# /*########################################################################## +# +# Copyright (c) 2019 European Synchrotron Radiation Facility +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), to deal +# in the Software without restriction, including without limitation the rights +# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +# copies of the Software, and to permit persons to whom the Software is +# furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. +# +# ###########################################################################*/ +"""Tests of Enum class with extra class methods""" + +from __future__ import absolute_import + +__authors__ = ["T. Vincent"] +__license__ = "MIT" +__date__ = "29/04/2019" + + +import sys +import unittest + +import enum +from silx.utils.enum import Enum + + +class TestEnum(unittest.TestCase): + """Tests for enum module.""" + + def test(self): + """Test with Enum""" + class Success(Enum): + A = 1 + B = 'B' + self._check_enum_content(Success) + + @unittest.skipIf(sys.version_info.major <= 2, 'Python3 only') + def test(self): + """Test Enum with member redefinition""" + with self.assertRaises(TypeError): + class Failure(Enum): + A = 1 + A = 'B' + + def test_unique(self): + """Test with enum.unique""" + with self.assertRaises(ValueError): + @enum.unique + class Failure(Enum): + A = 1 + B = 1 + + @enum.unique + class Success(Enum): + A = 1 + B = 'B' + self._check_enum_content(Success) + + def _check_enum_content(self, enum_): + """Check that the content of an enum is: <A: 1, B: 2>. + + :param Enum enum_: + """ + self.assertEqual(enum_.members(), (enum_.A, enum_.B)) + self.assertEqual(enum_.names(), ('A', 'B')) + self.assertEqual(enum_.values(), (1, 'B')) + + self.assertEqual(enum_.from_value(1), enum_.A) + self.assertEqual(enum_.from_value('B'), enum_.B) + with self.assertRaises(ValueError): + enum_.from_value(3) + + +def suite(): + test_suite = unittest.TestSuite() + loadTests = unittest.defaultTestLoader.loadTestsFromTestCase + test_suite.addTest(loadTests(TestEnum)) + return test_suite + + +if __name__ == '__main__': + unittest.main(defaultTest='suite') diff --git a/silx/utils/test/test_external_resources.py b/silx/utils/test/test_external_resources.py new file mode 100644 index 0000000..8576029 --- /dev/null +++ b/silx/utils/test/test_external_resources.py @@ -0,0 +1,99 @@ +# coding: utf-8 +# /*########################################################################## +# +# Copyright (c) 2016-2018 European Synchrotron Radiation Facility +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), to deal +# in the Software without restriction, including without limitation the rights +# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +# copies of the Software, and to permit persons to whom the Software is +# furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. +# +# ###########################################################################*/ +"""Test for resource files management.""" + +__authors__ = ["T. Vincent"] +__license__ = "MIT" +__date__ = "08/03/2019" + + +import os +import unittest +import shutil +import socket +import six + +from silx.utils.ExternalResources import ExternalResources + + +def isSilxWebsiteAvailable(): + try: + six.moves.urllib.request.urlopen('http://www.silx.org', timeout=1) + return True + except six.moves.urllib.error.URLError: + return False + except socket.timeout: + # This exception is still received in Python 2.7 + return False + + +class TestExternalResources(unittest.TestCase): + """This is a test for the ExternalResources""" + + @classmethod + def setUpClass(cls): + if not isSilxWebsiteAvailable(): + raise unittest.SkipTest("Network or silx website not available") + + def setUp(self): + self.resources = ExternalResources("toto", "http://www.silx.org/pub/silx/") + + def tearDown(self): + if self.resources.data_home: + shutil.rmtree(self.resources.data_home) + self.resources = None + + def test_download(self): + "test the download from silx.org" + f = self.resources.getfile("lena.png") + self.assertTrue(os.path.exists(f)) + di = self.resources.getdir("source.tar.gz") + for fi in di: + self.assertTrue(os.path.exists(fi)) + + def test_download_all(self): + "test the download of all files from silx.org" + filename = self.resources.getfile("lena.png") + directory = "source.tar.gz" + filelist = self.resources.getdir(directory) + # download file and remove it to create a json mapping file + os.remove(filename) + directory_path = os.path.commonprefix(filelist) + # Make sure we will rmtree a dangerous path like "/" + self.assertIn(self.resources.data_home, directory_path) + shutil.rmtree(directory_path) + filelist = self.resources.download_all() + self.assertGreater(len(filelist), 1, "At least 2 items were downloaded") + + +def suite(): + loadTests = unittest.defaultTestLoader.loadTestsFromTestCase + test_suite = unittest.TestSuite() + test_suite.addTest(loadTests(TestExternalResources)) + return test_suite + + +if __name__ == '__main__': + unittest.main(defaultTest='suite') diff --git a/silx/utils/test/test_number.py b/silx/utils/test/test_number.py index c900b32..e4f6bd8 100644 --- a/silx/utils/test/test_number.py +++ b/silx/utils/test/test_number.py @@ -148,7 +148,8 @@ class TestConversionTypes(testutils.ParametricTestCase): self.skipIfFloat80NotSupported() if pkg_resources.parse_version(numpy.version.version) <= pkg_resources.parse_version("1.10.4"): self.skipTest("numpy > 1.10.4 expected") - value = "1000000000.00001013332" + # value does not fit even in a 128 bits mantissa + value = "1.0340282366920938463463374607431768211456" func = testutils.test_logging(number._logger.name, warning=1) func = func(number.min_numerical_convertible_type) dtype = func(value) diff --git a/silx/utils/test/test_proxy.py b/silx/utils/test/test_proxy.py index 081d3d4..72b4d21 100644 --- a/silx/utils/test/test_proxy.py +++ b/silx/utils/test/test_proxy.py @@ -1,7 +1,7 @@ # coding: utf-8 # /*########################################################################## # -# Copyright (c) 2016 European Synchrotron Radiation Facility +# Copyright (c) 2016-2019 European Synchrotron Radiation Facility # # Permission is hereby granted, free of charge, to any person obtaining a copy # of this software and associated documentation files (the "Software"), to deal @@ -32,7 +32,7 @@ __date__ = "02/10/2017" import unittest import pickle import numpy -from ..proxy import Proxy +from silx.utils.proxy import Proxy, docstring class Thing(object): @@ -282,12 +282,61 @@ class TestPickle(unittest.TestCase): self.assertEqual(obj.value, obj2.value) +class TestDocstring(unittest.TestCase): + """Test docstring decorator""" + + class Base(object): + def method(self): + """Docstring""" + pass + + def test_inheritance(self): + class Derived(TestDocstring.Base): + @docstring(TestDocstring.Base) + def method(self): + pass + + self.assertEqual(Derived.method.__doc__, + TestDocstring.Base.method.__doc__) + + def test_composition(self): + class Composed(object): + def __init__(self): + self._base = TestDocstring.Base() + + @docstring(TestDocstring.Base) + def method(self): + return self._base.method() + + @docstring(TestDocstring.Base.method) + def renamed(self): + return self._base.method() + + self.assertEqual(Composed.method.__doc__, + TestDocstring.Base.method.__doc__) + + self.assertEqual(Composed.renamed.__doc__, + TestDocstring.Base.method.__doc__) + + def test_function(self): + def f(): + """Docstring""" + pass + + @docstring(f) + def g(): + pass + + self.assertEqual(f.__doc__, g.__doc__) + + def suite(): loadTests = unittest.defaultTestLoader.loadTestsFromTestCase test_suite = unittest.TestSuite() test_suite.addTest(loadTests(TestProxy)) test_suite.addTest(loadTests(TestPickle)) test_suite.addTest(loadTests(TestInheritedProxy)) + test_suite.addTest(loadTests(TestDocstring)) return test_suite diff --git a/silx/utils/test/test_weakref.py b/silx/utils/test/test_weakref.py index 16d3cf5..001193d 100644 --- a/silx/utils/test/test_weakref.py +++ b/silx/utils/test/test_weakref.py @@ -1,7 +1,7 @@ # coding: utf-8 # /*########################################################################## # -# Copyright (c) 2016 European Synchrotron Radiation Facility +# Copyright (c) 2016-2019 European Synchrotron Radiation Facility # # Permission is hereby granted, free of charge, to any person obtaining a copy # of this software and associated documentation files (the "Software"), to deal @@ -304,10 +304,10 @@ class TestWeakList(unittest.TestCase): self.assertEqual(len(new_list), 1) def testStr(self): - self.assertNotEquals(self.list.__str__(), "[]") + self.assertNotEqual(self.list.__str__(), "[]") def testRepr(self): - self.assertNotEquals(self.list.__repr__(), "[]") + self.assertNotEqual(self.list.__repr__(), "[]") def testSort(self): # only a coverage |