Docstring -> Validator.

Author: rossbar

numpydoc/__main__.py

@@ -6,13 +6,13 @@
 import ast
 
 from .docscrape_sphinx import get_doc_object
-from .validate import validate, Docstring
+from .validate import validate, Validator
 
 
 def render_object(import_path, config=None):
     """Test numpydoc docstring generation for a given object"""
-    # TODO: Move Docstring._load_obj to a better place than validate
-    print(get_doc_object(Docstring(import_path).obj,
+    # TODO: Move Validator._load_obj to a better place than validate
+    print(get_doc_object(Validator._load_obj(import_path),
                          config=dict(config or [])))
     return 0
 

numpydoc/tests/test_validate.py

@@ -1312,12 +1312,12 @@ def test_bad_docstrings(self, capsys, klass, func, msgs):
             assert msg in " ".join(err[1] for err in result["errors"])
 
 
-class TestDocstringClass:
+class TestValidatorClass:
     @pytest.mark.parametrize("invalid_name", ["unknown_mod", "unknown_mod.MyClass"])
     def test_raises_for_invalid_module_name(self, invalid_name):
         msg = 'No module can be imported from "{}"'.format(invalid_name)
         with pytest.raises(ImportError, match=msg):
-            numpydoc.validate.Docstring(invalid_name)
+            numpydoc.validate.Validator._load_obj(invalid_name)
 
     @pytest.mark.parametrize(
         "invalid_name", ["datetime.BadClassName", "datetime.bad_method_name"]
@@ -1327,4 +1327,4 @@ def test_raises_for_invalid_attribute_name(self, invalid_name):
         obj_name, invalid_attr_name = name_components[-2], name_components[-1]
         msg = "'{}' has no attribute '{}'".format(obj_name, invalid_attr_name)
         with pytest.raises(AttributeError, match=msg):
-            numpydoc.validate.Docstring(invalid_name)
+            numpydoc.validate.Validator._load_obj(invalid_name)

numpydoc/validate.py

@@ -121,17 +121,18 @@ def error(code, **kwargs):
     return (code, ERROR_MSGS[code].format(**kwargs))
 
 
-class Docstring:
+class Validator:
     # TODO Can all this class be merged into NumpyDocString?
-    def __init__(self, name):
-        self.name = name
-        obj = self._load_obj(name)
-        self.doc = get_doc_object(obj)
+    def __init__(self, doc_object):
+        self.doc = doc_object
         self.obj = self.doc._obj
         self.code_obj = inspect.unwrap(self.obj)
         self.raw_doc = self.obj.__doc__ or ""
         self.clean_doc = pydoc.getdoc(self.obj)
-#        self.doc = NumpyDocString(self.clean_doc)
+
+    @property
+    def name(self):
+        return '.'.join([self.obj.__module__, self.obj.__name__])
 
     @staticmethod
     def _load_obj(name):
@@ -150,7 +151,7 @@ def _load_obj(name):
 
         Examples
         --------
-        >>> Docstring._load_obj('datetime.datetime')
+        >>> Validator._load_obj('datetime.datetime')
         <class 'datetime.datetime'>
         """
         for maxsplit in range(0, name.count(".") + 1):
@@ -469,7 +470,8 @@ def validate(obj_name):
     they are validated, are not documented more than in the source code of this
     function.
     """
-    doc = Docstring(obj_name)
+    obj = Validator._load_obj(obj_name)
+    doc = Validator(get_doc_object(obj))
 
     errs = []
     if not doc.raw_doc: