diff mbox series

ref-manual: classes.rst: add python-setuptools3_rust and python_pyo3 classes

Message ID 20230214103611.39995-1-michael.opdenacker@bootlin.com
State New
Headers show
Series ref-manual: classes.rst: add python-setuptools3_rust and python_pyo3 classes | expand

Commit Message

Michael Opdenacker Feb. 14, 2023, 10:36 a.m. UTC
From: Michael Opdenacker <michael.opdenacker@bootlin.com>

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Cc: Tim Orling <ticotimo@gmail.com>
Cc: Alex Kiernan <alex.kiernan@gmail.com>
---
 documentation/ref-manual/classes.rst | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

Comments

Quentin Schulz Feb. 14, 2023, 10:47 a.m. UTC | #1
Hi Michael,

On 2/14/23 11:36, Michael Opdenacker via lists.yoctoproject.org wrote:
> From: Michael Opdenacker <michael.opdenacker@bootlin.com>
> 
> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
> Cc: Tim Orling <ticotimo@gmail.com>
> Cc: Alex Kiernan <alex.kiernan@gmail.com>
> ---
>   documentation/ref-manual/classes.rst | 23 +++++++++++++++++++++++
>   1 file changed, 23 insertions(+)
> 
> diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
> index b5443c0d0a..2a20e095aa 100644
> --- a/documentation/ref-manual/classes.rst
> +++ b/documentation/ref-manual/classes.rst
> @@ -2231,6 +2231,29 @@ The :ref:`ref-classes-python_poetry_core` class enables building Python modules
>   
>   Internally this uses the :ref:`ref-classes-python_pep517` class.
>   
> +.. _ref-classes-python_pyo3:
> +
> +``python_pyo3``
> +===============
> +
> +The :ref:`ref-classes-python_pyo3` class helps make sure that Python extensions
> +written in Rust, built with `PyO3 <https://urldefense.com/v3/__https://pyo3.rs/__;!!OOPJP91ZZw!lUmmEd0Wm4WxY9M9HTZWiO0-ZsqjgcTyYAJUyB67dTareG7k2qSXlVhMahJEHKctv3RUlbC9ktSk6nAqGyaXU0KPVeK04K2IInSKPfUkDa-AOrVgVDTq$ >`__ and
> +:ref:`ref-classes-python-setuptools3_rust`, properly set up the environment
> +for cross compilation.
> +
> +.. _ref-classes-python-setuptools3_rust:
> +
> +``python-setuptools3_rust``
> +===========================
> +
> +The :ref:`ref-classes-python-setuptools3_rust` class enables building Python
> +extensions implemented in Rust with `PyO3 <https://urldefense.com/v3/__https://pyo3.rs/__;!!OOPJP91ZZw!lUmmEd0Wm4WxY9M9HTZWiO0-ZsqjgcTyYAJUyB67dTareG7k2qSXlVhMahJEHKctv3RUlbC9ktSk6nAqGyaXU0KPVeK04K2IInSKPfUkDa-AOrVgVDTq$ >`__, which allows
> +to compile and distribute Python extensions written in Rust as easily
> +as if they were written in C.
> +
> +This class inherits the :ref:`ref-classes-setuptools3` and
> +:ref:`ref-classes-python_pyo3` classes.
> +

I guess one is likely to use python-setuptools3_rust more than 
python_pyo3 no? Is python_pyo3 supposed to be an internal class?

Cheers,
Quentin
Michael Opdenacker Feb. 14, 2023, 11:28 a.m. UTC | #2
Hi Quentin,

Thanks for the review!

On 14.02.23 at 11:47, Quentin Schulz via lists.yoctoproject.org wrote:
> Hi Michael,
>
> On 2/14/23 11:36, Michael Opdenacker via lists.yoctoproject.org wrote:
>> From: Michael Opdenacker <michael.opdenacker@bootlin.com>
>>
>> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
>> Cc: Tim Orling <ticotimo@gmail.com>
>> Cc: Alex Kiernan <alex.kiernan@gmail.com>
>> ---
>>   documentation/ref-manual/classes.rst | 23 +++++++++++++++++++++++
>>   1 file changed, 23 insertions(+)
>>
>> diff --git a/documentation/ref-manual/classes.rst 
>> b/documentation/ref-manual/classes.rst
>> index b5443c0d0a..2a20e095aa 100644
>> --- a/documentation/ref-manual/classes.rst
>> +++ b/documentation/ref-manual/classes.rst
>> @@ -2231,6 +2231,29 @@ The :ref:`ref-classes-python_poetry_core` 
>> class enables building Python modules
>>     Internally this uses the :ref:`ref-classes-python_pep517` class.
>>   +.. _ref-classes-python_pyo3:
>> +
>> +``python_pyo3``
>> +===============
>> +
>> +The :ref:`ref-classes-python_pyo3` class helps make sure that Python 
>> extensions
>> +written in Rust, built with `PyO3 
>> <https://urldefense.com/v3/__https://pyo3.rs/__;!!OOPJP91ZZw!lUmmEd0Wm4WxY9M9HTZWiO0-ZsqjgcTyYAJUyB67dTareG7k2qSXlVhMahJEHKctv3RUlbC9ktSk6nAqGyaXU0KPVeK04K2IInSKPfUkDa-AOrVgVDTq$ 
>> >`__ and
>> +:ref:`ref-classes-python-setuptools3_rust`, properly set up the 
>> environment
>> +for cross compilation.
>> +
>> +.. _ref-classes-python-setuptools3_rust:
>> +
>> +``python-setuptools3_rust``
>> +===========================
>> +
>> +The :ref:`ref-classes-python-setuptools3_rust` class enables 
>> building Python
>> +extensions implemented in Rust with `PyO3 
>> <https://urldefense.com/v3/__https://pyo3.rs/__;!!OOPJP91ZZw!lUmmEd0Wm4WxY9M9HTZWiO0-ZsqjgcTyYAJUyB67dTareG7k2qSXlVhMahJEHKctv3RUlbC9ktSk6nAqGyaXU0KPVeK04K2IInSKPfUkDa-AOrVgVDTq$ 
>> >`__, which allows
>> +to compile and distribute Python extensions written in Rust as easily
>> +as if they were written in C.
>> +
>> +This class inherits the :ref:`ref-classes-setuptools3` and
>> +:ref:`ref-classes-python_pyo3` classes.
>> +
>
> I guess one is likely to use python-setuptools3_rust more than 
> python_pyo3 no? Is python_pyo3 supposed to be an internal class?


Correct. I should mention this. I'll send a V2.
Thanks again
Michael.
diff mbox series

Patch

diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index b5443c0d0a..2a20e095aa 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -2231,6 +2231,29 @@  The :ref:`ref-classes-python_poetry_core` class enables building Python modules
 
 Internally this uses the :ref:`ref-classes-python_pep517` class.
 
+.. _ref-classes-python_pyo3:
+
+``python_pyo3``
+===============
+
+The :ref:`ref-classes-python_pyo3` class helps make sure that Python extensions
+written in Rust, built with `PyO3 <https://pyo3.rs/>`__ and
+:ref:`ref-classes-python-setuptools3_rust`, properly set up the environment
+for cross compilation.
+
+.. _ref-classes-python-setuptools3_rust:
+
+``python-setuptools3_rust``
+===========================
+
+The :ref:`ref-classes-python-setuptools3_rust` class enables building Python
+extensions implemented in Rust with `PyO3 <https://pyo3.rs/>`__, which allows
+to compile and distribute Python extensions written in Rust as easily
+as if they were written in C.
+
+This class inherits the :ref:`ref-classes-setuptools3` and
+:ref:`ref-classes-python_pyo3` classes.
+
 .. _ref-classes-pixbufcache:
 
 ``pixbufcache``