def test_build_children(self, ModuleAnalyzerMock):
node = MagicMock()
node.name = "name"
node.body = ["body"]
node.mock_add_spec(ast.Module)
record = ModuleRecord(node)
record.import_string = ImportString("my_module")
record.name = "class_node"
class_node = MagicMock()
class_node.name = "ClassNode"
method_node = MagicMock()
method_node.name = "class_method"
method_node.body = ["class_method"]
method_node.mock_add_spec(ast.FunctionDef)
class_node.body = [method_node]
class_node.decorator_list = []
class_node.bases = []
class_node.mock_add_spec(ast.ClassDef)
function_node = MagicMock()
function_node.decorator_list = []
function_node.name = "function_node"
function_node.body = ["function_body"]
function_node.mock_add_spec(ast.FunctionDef)
attribute_node = MagicMock()
attribute_target = MagicMock()
attribute_target.id = "attribute_target"
attribute_target.mock_add_spec(ast.Name)
attribute_node.targets = [attribute_target]
attribute_node.value = "attribute_value"
attribute_node.mock_add_spec(ast.Assign)
import_node = MagicMock()
import_name = MagicMock()
import_name.name = "import_name"
import_name_2 = MagicMock()
import_name_2.name = "import_name_2"
import_node.names = [import_name, import_name_2]
import_node.mock_add_spec(ast.Import)
ModuleAnalyzerMock().class_nodes = [class_node]
ModuleAnalyzerMock().function_nodes = [function_node]
ModuleAnalyzerMock().attribute_nodes = [attribute_node]
ModuleAnalyzerMock().import_nodes = [import_node]
self.assertIsNone(record.build_children())
self.assertEqual(record.title, "ClassNode")
self.assertEqual(record.class_records[0].node, class_node)
self.assertEqual(record.function_records[0].node, function_node)
self.assertEqual(record.attribute_records[0].node, attribute_node)
self.assertEqual(record.import_records[0].node, import_node)
self.assertEqual(record.import_records[0].name, "import_name")
self.assertEqual(record.import_records[1].node, import_node)
self.assertEqual(record.import_records[1].name, "import_name_2")
self.assertEqual(
record.class_records[0].import_string.value, "my_module.ClassNode"
)
self.assertEqual(
record.class_records[0].method_records[0].import_string.value,
"my_module.ClassNode.class_method",
)
self.assertEqual(
record.function_records[0].import_string.value, "my_module.function_node"
)
def test_init(self): node = MagicMock() node.name = "name" node.body = ["body"] node.mock_add_spec(ast.Module) record = ModuleRecord(node) self.assertEqual(record.name, "module") self.assertEqual(record.title, "") self.assertEqual(record.import_string.value, "")
def test_render(self): node = MagicMock() node.name = "name" node.body = ["body"] node.mock_add_spec(ast.Module) record = ModuleRecord(node) record.parse() record.class_records = ["class_record"] record.function_records = ["function_record"] record.import_records = ["import_record"] self.assertEqual(record.render(), "import_record") self.assertEqual( record.render(allow_multiline=True), "import_record\n\nclass_record\n\nfunction_record", )
def test_find_record(self):
node = MagicMock()
node.name = "name"
node.body = ["body"]
node.mock_add_spec(ast.Module)
record = ModuleRecord(node)
record.import_string = "module_import"
record.import_string_map = {"test": "test_object"}
self.assertEqual(record.find_record("test"), "test_object")
self.assertEqual(record.find_record("module_import"), record)
self.assertIsNone(record.find_record("non_existing"))
def test_create_from_source(self, parse_mock): source_path = MagicMock() source_path.read_text.return_value = "line1\nline2" import_string = MagicMock() import_string.parts = ["my_dir", "my_module"] node = MagicMock() node.body = ["body"] node.mock_add_spec(ast.Module) parse_mock.return_value = node record = ModuleRecord.create_from_source(source_path, import_string) self.assertIsInstance(record, ModuleRecord) self.assertEqual(record.import_string, import_string) self.assertEqual(record.name, "my_module") self.assertEqual(record.title, "") self.assertEqual(record.source_path, source_path) self.assertEqual(record.source_lines, ["line1", "line2"])
def get_module_record(self, source_path):
# type: (Path) -> Optional[ModuleRecord]
"""
Build `ModuleRecord` for given `source_path`.
Arguments:
source_path -- Absolute path to source file.
Returns:
A new `ModuleRecord` instance or None if there is ntohing to import.
Raises:
LoaderError -- If python source cannot be loaded.
"""
if not (source_path.parent / "__init__.py").exists():
return None
if source_path.name == "__init__.py" and source_path.parent == self._root_path:
return None
import_string = self.get_import_string(source_path)
docstring_parts = []
try:
module_record = ModuleRecord.create_from_source(
source_path, ImportString(import_string))
module_record.build_children()
except Exception as e:
raise LoaderError("{} while loading {}: {}".format(
e.__class__.__name__, source_path, e))
if module_record.docstring:
docstring_parts.append(module_record.docstring)
if source_path.name == "__init__.py":
readme_md_path = source_path.parent / "README.md"
if readme_md_path.exists():
docstring_parts.append(readme_md_path.read_text())
docstring = "\n\n".join(docstring_parts)
title, docstring = extract_md_title(docstring)
if title:
module_record.title = title
module_record.docstring = docstring
return module_record
def test_iter_records(self): node = MagicMock() node.name = "name" node.body = ["body"] node.mock_add_spec(ast.Module) record = ModuleRecord(node) self.assertEqual(list(record.iter_records()), []) class_record = MagicMock() class_record.name = "class_record" class_record.iter_records.return_value = ["class_method"] private_class_record = MagicMock() private_class_record.name = "private_class_record" private_class_record.iter_records.return_value = ["private_class_method"] record.class_records = [class_record, private_class_record] function_record = MagicMock() function_record.name = "function_record" private_function_record = MagicMock() private_function_record.name = "private_function_record" record.function_records = [function_record, private_function_record] attribute_record = MagicMock() record.attribute_records = [attribute_record] self.assertEqual( list(record.iter_records()), [ class_record, "class_method", private_class_record, "private_class_method", function_record, private_function_record, ], ) record.all_names = ["class_record", "function_record"] self.assertEqual( list(record.iter_records()), [class_record, "class_method", function_record] )
def test_parse(self): node = MagicMock() node.name = "name" node.body = ["body"] node.mock_add_spec(ast.Module) record = ModuleRecord(node) record.source_lines = [ "# attribute docstring", "# attribute docstring 2", "# FIXME: ingored", "", "function_line 1", "function_line 2", "function body line", ] attribute_record = MagicMock() attribute_record.node.mock_add_spec(ast.Assign) attribute_record.node.lineno = 4 record.attribute_records = [attribute_record] method_record = MagicMock() method_record.name = "method_record" method_record.node.mock_add_spec(ast.FunctionDef) method_record_body = MagicMock() method_record_body.lineno = 999 method_record.node.body = [method_record_body] method_record.is_classmethod = False method_record.is_staticmethod = False static_method_record = MagicMock() static_method_record.name = "static_method_record" static_method_record_body = MagicMock() static_method_record_body.lineno = 999 static_method_record.node.body = [static_method_record_body] static_method_record.node.mock_add_spec(ast.FunctionDef) static_method_record.is_classmethod = True static_method_record.is_staticmethod = False class_record = MagicMock() class_record.name = "class_record" class_record.node.mock_add_spec(ast.ClassDef) class_attribute_record = MagicMock() class_attribute_record.node.mock_add_spec(ast.Assign) class_attribute_record.node.lineno = 999 class_record.attribute_records = [class_attribute_record] class_record.method_records = [method_record, static_method_record] record.class_records = [class_record] function_record = MagicMock() function_record.line_number = 5 body_mock = MagicMock() body_mock.lineno = 7 function_record.node.body = [body_mock] function_record.node.lineno = 7 function_record.node.mock_add_spec(ast.FunctionDef) record.function_records = [function_record] self.assertIsNone(record.parse()) self.assertEqual( attribute_record.docstring, "attribute docstring\n attribute docstring 2" ) self.assertEqual(class_attribute_record.docstring, "") self.assertEqual(method_record.title, "class_record().method_record") self.assertEqual( static_method_record.title, "class_record.static_method_record" ) function_record.parse_type_comments.assert_called_once_with( ["function_line 1", "function_line 2"] )