luxolus
/
pyo3
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #3418 from smheidrich/mention-inability-to-derive-from-python-classes-in-docs 

Mention inability to subclass Python classes in docs
This commit is contained in:
David Hewitt 2023-08-29 05:07:21 +00:00 committed by GitHub
parent abc942a453 2855b9d508
commit 0de17149f2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
guide/src/class.md
View File

@ -267,6 +267,10 @@ Consult the table below to determine which type your constructor should return:
By default, `object`, i.e. `PyAny` is used as the base class. To override this default,
use the `extends` parameter for `pyclass` with the full path to the base class.
Currently, only classes defined in Rust and builtins provided by PyO3 can be inherited
from; inheriting from other classes defined in Python is not yet supported
([#991](https://github.com/PyO3/pyo3/issues/991)).
For convenience, `(T, U)` implements `Into<PyClassInitializer<T>>` where `U` is the
base class of `T`.
@ -340,7 +344,7 @@ impl SubSubClass {
# });
```
You can also inherit native types such as `PyDict`, if they implement
You can inherit native types such as `PyDict`, if they implement
[`PySizedLayout`]({{#PYO3_DOCS_URL}}/pyo3/type_object/trait.PySizedLayout.html).
This is not supported when building for the Python limited API (aka the `abi3` feature of PyO3).