def testNpDocName(self):
np_utils.set_np_doc_form('inlined')
@np_utils.np_doc('foo')
def f():
"""f docstring."""
return
expected = """TensorFlow variant of NumPy's `foo`.
f docstring.
"""
self.assertEqual(expected, f.__doc__)
def testNpDocInvalid(self, invalid_flag):
def np_fun(x):
"""np_fun docstring."""
return
np_utils.set_np_doc_form(invalid_flag)
@np_utils.np_doc(None, np_fun=np_fun)
def f():
"""f docstring."""
return
expected = """TensorFlow variant of NumPy's `np_fun`.
Unsupported arguments: `x`.
f docstring.
"""
self.assertEqual(expected, f.__doc__)
def testNpDocLink(self, version, link):
def np_fun(x):
"""np_fun docstring."""
return
np_utils.set_np_doc_form(version)
@np_utils.np_doc(None, np_fun=np_fun)
def f():
"""f docstring."""
return
expected = """TensorFlow variant of NumPy's `np_fun`.
Unsupported arguments: `x`.
f docstring.
See the NumPy documentation for `numpy.np_fun`: %s"""
expected = expected % (link)
self.assertEqual(expected, f.__doc__)
def testNpDocInlined(self):
def np_fun(x):
"""np_fun docstring."""
return
np_utils.set_np_doc_form('inlined')
@np_utils.np_doc(None, np_fun=np_fun)
def f():
"""f docstring."""
return
expected = """TensorFlow variant of NumPy's `np_fun`.
Unsupported arguments: `x`.
f docstring.
Documentation for `numpy.np_fun`:
np_fun docstring."""
self.assertEqual(expected, f.__doc__)
def tearDown(self):
np_utils.set_np_doc_form(self._old_np_doc_form)
np_utils.set_is_sig_mismatch_an_error(
self._old_is_sig_mismatch_an_error)
super(UtilsTest, self).tearDown()
