Move getdoc from utils.misc to utils.text

pekkaklarck · pekkaklarck · commit ab2dc88090f1 · 2018-07-05T19:42:20.000+03:00
diff --git a/src/robot/utils/__init__.py b/src/robot/utils/__init__.py
@@ -50,7 +50,7 @@
 from .markupwriters import HtmlWriter, XmlWriter, NullMarkupWriter
 from .importer import Importer
 from .match import eq, Matcher, MultiMatcher
-from .misc import (getdoc, plural_or_not, printable_name, roundup, seq2str,
+from .misc import (plural_or_not, printable_name, roundup, seq2str,
                    seq2str2)
 from .normalizing import lower, normalize, NormalizedDict
 from .platform import (IRONPYTHON, JYTHON, PY2, PY3, PYPY, PYTHON, UNIXY,
@@ -70,7 +70,7 @@
 from .setter import setter, SetterAwareType
 from .sortable import Sortable
 from .text import (cut_long_message, format_assign_message,
-                   pad_console_length, get_console_length, split_tags_from_doc,
-                   split_args_from_name_or_path)
+                   get_console_length, getdoc, pad_console_length,
+                   split_tags_from_doc, split_args_from_name_or_path)
 from .unic import prepr, unic
 from .utf8reader import Utf8Reader
diff --git a/src/robot/utils/misc.py b/src/robot/utils/misc.py
@@ -15,11 +15,10 @@
 
 from __future__ import division
 
-import inspect
 from operator import add, sub
 
 from .platform import PY2
-from .robottypes import is_integer, is_unicode
+from .robottypes import is_integer
 from .unic import unic
 
 
@@ -125,13 +124,3 @@ def seq2str2(sequence):
     if not sequence:
         return '[ ]'
     return '[ %s ]' % ' | '.join(unic(item) for item in sequence)
-
-
-def getdoc(item):
-    doc = inspect.getdoc(item) or u''
-    if is_unicode(doc):
-        return doc
-    try:
-        return doc.decode('UTF-8')
-    except UnicodeDecodeError:
-        return unic(doc)
diff --git a/src/robot/utils/text.py b/src/robot/utils/text.py
@@ -13,11 +13,13 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 
+import inspect
 import os.path
 import re
 
 from .charwidth import get_char_width
 from .misc import seq2str2
+from .robottypes import is_unicode
 from .unic import unic
 
 
@@ -149,3 +151,13 @@ def split_tags_from_doc(doc):
         doc = '\n'.join(lines[:-1]).rstrip()
         tags = [tag.strip() for tag in match.group(1).split(',')]
     return doc, tags
+
+
+def getdoc(item):
+    doc = inspect.getdoc(item) or u''
+    if is_unicode(doc):
+        return doc
+    try:
+        return doc.decode('UTF-8')
+    except UnicodeDecodeError:
+        return unic(doc)
diff --git a/utest/utils/test_misc.py b/utest/utils/test_misc.py
@@ -1,8 +1,7 @@
 import unittest
 
-from robot.utils import IRONPYTHON, PY2
 from robot.utils.asserts import assert_equal
-from robot.utils.misc import getdoc, printable_name, seq2str, roundup
+from robot.utils.misc import printable_name, seq2str, roundup
 
 
 class TestRoundup(unittest.TestCase):
@@ -141,50 +140,5 @@ def test_printable_name_with_code_style(self):
             assert_equal(printable_name(inp, code_style=True), exp)
 
 
-class TestGetdoc(unittest.TestCase):
-
-    def test_no_doc(self):
-        def func():
-            pass
-        assert_equal(getdoc(func), '')
-
-    def test_one_line_doc(self):
-        def func():
-            """My documentation."""
-        assert_equal(getdoc(func), 'My documentation.')
-
-    def test_multiline_doc(self):
-        class Class:
-            """My doc.
-
-            In multiple lines.
-            """
-        assert_equal(getdoc(Class), 'My doc.\n\nIn multiple lines.')
-        assert_equal(getdoc(Class), getdoc(Class()))
-
-    def test_unicode_doc(self):
-        class Class:
-            def meth(self):
-                u"""Hyv\xe4 \xe4iti!"""
-        assert_equal(getdoc(Class.meth), u'Hyv\xe4 \xe4iti!')
-        assert_equal(getdoc(Class.meth), getdoc(Class().meth))
-
-    if PY2:
-
-        def test_non_ascii_doc_in_utf8(self):
-            def func():
-                """Hyv\xc3\xa4 \xc3\xa4iti!"""
-            expected = u'Hyv\xe4 \xe4iti!' \
-                if not IRONPYTHON else u'Hyv\xc3\xa4 \xc3\xa4iti!'
-            assert_equal(getdoc(func), expected)
-
-        def test_non_ascii_doc_not_in_utf8(self):
-            def func():
-                """Hyv\xe4 \xe4iti!"""
-            expected = 'Hyv\\xe4 \\xe4iti!' \
-                if not IRONPYTHON else u'Hyv\xe4 \xe4iti!'
-            assert_equal(getdoc(func), expected)
-
-
 if __name__ == "__main__":
     unittest.main()
diff --git a/utest/utils/test_text.py b/utest/utils/test_text.py
@@ -2,9 +2,9 @@
 import os
 from os.path import abspath
 
-from robot.utils.asserts import *
-
-from robot.utils.text import (cut_long_message, get_console_length,
+from robot.utils.asserts import assert_equal, assert_true
+from robot.utils import IRONPYTHON, PY2
+from robot.utils.text import (cut_long_message, get_console_length, getdoc,
                               pad_console_length, split_tags_from_doc,
                               split_args_from_name_or_path,
                               _count_line_lengths, _MAX_ERROR_LINES,
@@ -275,5 +275,50 @@ def test_existing_path_with_colons(self):
             os.rmdir(path)
 
 
+class TestGetdoc(unittest.TestCase):
+
+    def test_no_doc(self):
+        def func():
+            pass
+        assert_equal(getdoc(func), '')
+
+    def test_one_line_doc(self):
+        def func():
+            """My documentation."""
+        assert_equal(getdoc(func), 'My documentation.')
+
+    def test_multiline_doc(self):
+        class Class:
+            """My doc.
+
+            In multiple lines.
+            """
+        assert_equal(getdoc(Class), 'My doc.\n\nIn multiple lines.')
+        assert_equal(getdoc(Class), getdoc(Class()))
+
+    def test_unicode_doc(self):
+        class Class:
+            def meth(self):
+                u"""Hyv\xe4 \xe4iti!"""
+        assert_equal(getdoc(Class.meth), u'Hyv\xe4 \xe4iti!')
+        assert_equal(getdoc(Class.meth), getdoc(Class().meth))
+
+    if PY2:
+
+        def test_non_ascii_doc_in_utf8(self):
+            def func():
+                """Hyv\xc3\xa4 \xc3\xa4iti!"""
+            expected = u'Hyv\xe4 \xe4iti!' \
+                if not IRONPYTHON else u'Hyv\xc3\xa4 \xc3\xa4iti!'
+            assert_equal(getdoc(func), expected)
+
+        def test_non_ascii_doc_not_in_utf8(self):
+            def func():
+                """Hyv\xe4 \xe4iti!"""
+            expected = 'Hyv\\xe4 \\xe4iti!' \
+                if not IRONPYTHON else u'Hyv\xe4 \xe4iti!'
+            assert_equal(getdoc(func), expected)
+
+
 if __name__ == '__main__':
     unittest.main()
