fix: Don't render pybind11 KeysView, ValuesView, ItemsView class defs

sizmailov · Mar 4, 2024 · a251317 · a251317
1 parent f783045
commit a251317
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 0 deletions.
diff --git a/pybind11_stubgen/__init__.py b/pybind11_stubgen/__init__.py
@@ -20,6 +20,7 @@
 from pybind11_stubgen.parser.mixins.filter import (
     FilterClassMembers,
     FilterInvalidIdentifiers,
+    FilterPybind11ViewClasses,
     FilterPybindInternals,
     FilterTypingModuleAttributes,
 )
@@ -273,6 +274,7 @@ class Parser(
         FixValueReprRandomAddress,
         FixRedundantBuiltinsAnnotation,
         FilterPybindInternals,
+        FilterPybind11ViewClasses,
         FixRedundantMethodsFromBuiltinObject,
         RemoveSelfAnnotation,
         FixPybind11EnumStrDoc,

diff --git a/pybind11_stubgen/parser/mixins/filter.py b/pybind11_stubgen/parser/mixins/filter.py
@@ -125,3 +125,22 @@ def handle_class_member(
             self.report_error(InvalidIdentifierError(path[-1], path.parent))
             return None
         return super().handle_class_member(path, class_, obj)
+
+
+class FilterPybind11ViewClasses(IParser):
+    def handle_module_member(
+        self, path: QualifiedName, module: types.ModuleType, obj: Any
+    ) -> (
+        Docstring | Import | Alias | Class | list[Function] | Attribute | Module | None
+    ):
+        result = super().handle_module_member(path, module, obj)
+
+        if isinstance(result, Class) and str(result.name) in [
+            "ItemsView",
+            "KeysView",
+            "ValuesView",
+        ]:
+            # TODO: check obj is a subclass of pybind11_object
+            return None
+
+        return result