Skip to content

Commit 3191bac

Browse files
authored
refactor: Stop recording errors in the loader
These errors are not actionable anyway. They just create noise. Issue #111: #111 PR #114: #114
1 parent c4f6bdc commit 3191bac

File tree

2 files changed

+1
-17
lines changed

2 files changed

+1
-17
lines changed

src/pytkdocs/loader.py

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -410,7 +410,6 @@ def get_module_documentation(self, node: ObjectNode, select_members=None) -> Mod
410410
try:
411411
code = Path(node.file_path).read_text()
412412
except (OSError, UnicodeDecodeError):
413-
self.errors.append(f"Couldn't read source for '{path}': {error}")
414413
source = None
415414
else:
416415
source = Source(code, 1) if code else None
@@ -628,13 +627,11 @@ def get_function_documentation(self, node: ObjectNode) -> Function:
628627
try:
629628
signature = inspect.signature(function)
630629
except TypeError as error:
631-
self.errors.append(f"Couldn't get signature for '{path}': {error}")
632630
signature = None
633631

634632
try:
635633
source = Source(*inspect.getsourcelines(function))
636634
except OSError as error:
637-
self.errors.append(f"Couldn't read source for '{path}': {error}")
638635
source = None
639636

640637
properties: List[str] = []
@@ -677,15 +674,13 @@ def get_property_documentation(self, node: ObjectNode) -> Attribute:
677674
try:
678675
signature = inspect.signature(sig_source_func)
679676
except (TypeError, ValueError) as error:
680-
self.errors.append(f"Couldn't get signature for '{path}': {error}")
681677
attr_type = None
682678
else:
683679
attr_type = signature.return_annotation
684680

685681
try:
686682
source = Source(*inspect.getsourcelines(sig_source_func))
687683
except (OSError, TypeError) as error:
688-
self.errors.append(f"Couldn't get source for '{path}': {error}")
689684
source = None
690685

691686
return Attribute(
@@ -879,7 +874,6 @@ def get_method_documentation(self, node: ObjectNode, properties: Optional[List[s
879874
try:
880875
source = Source(*inspect.getsourcelines(method))
881876
except OSError as error:
882-
self.errors.append(f"Couldn't read source for '{path}': {error}")
883877
source = None
884878
except TypeError:
885879
source = None
@@ -898,7 +892,6 @@ def get_method_documentation(self, node: ObjectNode, properties: Optional[List[s
898892
# raise a ValueError().
899893
signature = inspect.signature(method)
900894
except ValueError as error:
901-
self.errors.append(f"Couldn't read signature for '{path}': {error}")
902895
signature = None
903896

904897
return Method(

tests/test_loader.py

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -116,16 +116,7 @@ def test_inheriting_typing_NamedTuple():
116116
"""
117117
loader = Loader()
118118
loader.get_object_documentation("tests.fixtures.inheriting_typing_NamedTuple")
119-
120-
if sys.version_info > (3, 7, 99):
121-
assert len(loader.errors) == 1
122-
else:
123-
# there are 4 class-attributes, 2 errors (source, signature) per attribute
124-
assert len(loader.errors) >= 8
125-
for error in loader.errors[-8:]:
126-
assert "itemgetter" in error
127-
for error in loader.errors[:-8]:
128-
assert "could not get source code" in error
119+
assert len(loader.errors) == 0
129120

130121

131122
def test_nested_class():

0 commit comments

Comments
 (0)