[mlir:python] Improve mlir_(attribute|type|value)_subclass for nanobinds stubgen
#127584
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This PR sets the `__module__` attribute of the classes generated by the nanobind adaptors for attributes, types, and values (via `mlir_(attribute|type|value)_subclass`). By default, the `__module__` property is set to `importlib._bootstrap`, which isn't where we want the new class to live. The new logic sets the property to the name of the module provided as `scope` instead. This also makes nanobind's `stubgen` generate stubs for those classes properly, which ignores classes whose `__module__` does not correspond to the module it is generating stubs for. This resolves llvm#127518. Signed-off-by: Ingo Müller <[email protected]>
|
@hawkinsp: You might also be interested. |
|
@llvm/pr-subscribers-mlir Author: Ingo Müller (ingomueller-net) ChangesThis PR sets the Full diff: https://github.com/llvm/llvm-project/pull/127584.diff 1 Files Affected:
diff --git a/mlir/include/mlir/Bindings/Python/NanobindAdaptors.h b/mlir/include/mlir/Bindings/Python/NanobindAdaptors.h
index 517351cac6dbc..11338b2d49308 100644
--- a/mlir/include/mlir/Bindings/Python/NanobindAdaptors.h
+++ b/mlir/include/mlir/Bindings/Python/NanobindAdaptors.h
@@ -349,6 +349,7 @@ class pure_subclass {
thisClass = metaclass(derivedClassName, nanobind::make_tuple(superClass),
attributes);
scope.attr(derivedClassName) = thisClass;
+ thisClass.attr("__module__") = scope.attr("__name__");
}
template <typename Func, typename... Extra>
|
hawkinsp
approved these changes
Feb 18, 2025
This commit overwrites the signature of the `isinstance` member functions created by `mlir_(attribute|type|value)_subclass` by adding a `nanobind::signature` argument to the `def` call that creates the functions. This improves the typing information that `stubgen` creates for such classes. Signed-off-by: Ingo Müller <[email protected]>
This commit fixes three occurrences of the same grammar issue in some comment and adds a clang-format suppression for a specific ordering of includes. Signed-off-by: Ingo Müller <[email protected]>
ingomueller-net
changed the title
__module__ classes generated by nanobind adaptors.mlir_(attribute|type|value)_subclass for nanobinds stubgen
|
Thanks, @hawkinsp, for the review! I realized that some more tweaks are required to generate fully correct stubs and expanded the scope of this PR to include them. |
makslevental
approved these changes
Feb 18, 2025
Prakhar-Dixit
pushed a commit
to Prakhar-Dixit/llvm-project
that referenced
this pull request
Feb 19, 2025
…obind`s `stubgen` (llvm#127584) This PR makes several improvements to the stubs that are created by `mlir_(attribute|type|value)_subclass`. First, the PR sets the `__module__` attribute of the classes generated by the nanobind adaptors for attributes, types, and values (via `mlir_(attribute|type|value)_subclass`). By default, the `__module__` property is set to `importlib._bootstrap`, which isn't where we want the new class to live. The new logic sets the property to the name of the module provided as `scope` instead. This also makes nanobind's `stubgen` generate stubs for those classes properly, which ignores classes whose `__module__` does not correspond to the module it is generating stubs for. This resolves llvm#127518. Second, the PR overwrites the function signatures generated by `stubgen` to a format that uses the desired type names (e.g., `mlir.ir.Attribute` instead of `MlirAttribute`). Finally, the PR piggy-backs some minor doc and style improvements to `PythonAdaptors.h`. --------- Signed-off-by: Ingo Müller <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR makes several improvements to the stubs that are created by
mlir_(attribute|type|value)_subclass.First, the PR sets the
__module__attribute of the classes generated by the nanobind adaptors for attributes, types, and values (viamlir_(attribute|type|value)_subclass). By default, the__module__property is set toimportlib._bootstrap, which isn't where we want the new class to live. The new logic sets the property to the name of the module provided asscopeinstead. This also makes nanobind'sstubgengenerate stubs for those classes properly, which ignores classes whose__module__does not correspond to the module it is generating stubs for. This resolves #127518.Second, the PR overwrites the function signatures generated by
stubgento a format that uses the desired type names (e.g.,mlir.ir.Attributeinstead ofMlirAttribute).Finally, the PR piggy-backs some minor doc and style improvements to
PythonAdaptors.h.