summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/classes.rst
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/ref-manual/classes.rst')
-rw-r--r--documentation/ref-manual/classes.rst45
1 files changed, 28 insertions, 17 deletions
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index e26e4343a1..4dd0901623 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -616,7 +616,7 @@ Python modules built with ``flit_core.buildapi`` are pure Python (no
616``C`` or ``Rust`` extensions). 616``C`` or ``Rust`` extensions).
617 617
618The resulting ``wheel`` (See `PEP-427 <https://www.python.org/dev/peps/pep-0427/>`__) 618The resulting ``wheel`` (See `PEP-427 <https://www.python.org/dev/peps/pep-0427/>`__)
619is installed with the :ref:`pip_install_wheel <ref-classes-pip_install_wheel>` class. 619is installed with the :ref:`python_pep517 <ref-classes-python_pep517>` class.
620 620
621.. _ref-classes-fontcache: 621.. _ref-classes-fontcache:
622 622
@@ -1978,25 +1978,20 @@ When inherited by a recipe, the ``perlnative`` class supports using the
1978native version of Perl built by the build system rather than using the 1978native version of Perl built by the build system rather than using the
1979version provided by the build host. 1979version provided by the build host.
1980 1980
1981.. _ref-classes-pip_install_wheel: 1981.. _ref-classes-python_pep517:
1982 1982
1983``pip_install_wheel.bbclass`` 1983``python_pep517.bbclass``
1984============================= 1984=============================
1985 1985
1986The ``pip_install_wheel`` class uses ``pip`` to install a Python ``wheel`` 1986The ``python_pep517`` class installs a Python ``wheel`` binary archive (see
1987binary archive format (See `PEP-427 <https://www.python.org/dev/peps/pep-0427/>`__) 1987`PEP-517 <https://peps.python.org/pep-0517/>`__).
1988 1988
1989The Python ``wheel`` can be built with several classes, including :ref:`flit_core <ref-classes-flit_core>`, 1989The Python ``wheel`` can be built with several classes, including :ref:`flit_core <ref-classes-flit_core>`,
1990:ref:`setuptools_build_meta <ref-classes-setuptools_build_meta>`, and :ref:`setuptools3 <ref-classes-setuptools3>`. 1990:ref:`setuptools_build_meta <ref-classes-setuptools_build_meta>`, and :ref:`setuptools3 <ref-classes-setuptools3>`.
1991 1991
1992The absolute path to the built ``wheel`` to be installed is defined by :term:`PYPA_WHEEL` which can be 1992The path to the wheel to be installed is defined by :term:`PEP517_WHEEL_PATH`.
1993overriden for recipes where the filename or version number of the wheel are not easily 1993This defaults to ``${D}/dist`` and should be respected by the builder class
1994determined by the defaults. Other variables which can be used to customize the behavior 1994(such as :ref:`flit_core <ref-classes-flit_core>`).
1995of the ``pip_install_wheel`` class include:
1996
1997- :term:`PIP_INSTALL_ARGS`
1998- :term:`PIP_INSTALL_PACKAGE`
1999- :term:`PIP_INSTALL_DIST_PATH`
2000 1995
2001.. _ref-classes-pixbufcache: 1996.. _ref-classes-pixbufcache:
2002 1997
@@ -2368,7 +2363,7 @@ Python modules built with ``setuptools.build_meta`` can be pure Python or
2368include ``C`` or ``Rust`` extensions). 2363include ``C`` or ``Rust`` extensions).
2369 2364
2370The resulting ``wheel`` (See `PEP-427 <https://www.python.org/dev/peps/pep-0427/>`__) 2365The resulting ``wheel`` (See `PEP-427 <https://www.python.org/dev/peps/pep-0427/>`__)
2371is installed with the :ref:`pip_install_wheel <ref-classes-pip_install_wheel>` class. 2366is installed with the :ref:`python_pep517 <ref-classes-python_pep517>` class.
2372 2367
2373.. _ref-classes-setuptools3: 2368.. _ref-classes-setuptools3:
2374 2369
@@ -2393,9 +2388,25 @@ uses these build systems, the recipe needs to inherit the ``setuptools3`` class.
2393 2388
2394 .. note:: 2389 .. note::
2395 2390
2396 The ``setuptools3`` class ``do_install()`` task now calls ``pip install`` 2391 The ``setuptools3`` class ``do_install()`` task now installs the ``wheel``
2397 to install the ``wheel`` binary archive. In current versions of 2392 binary archive. In current versions of ``setuptools`` the legacy ``setup.py
2398 ``setuptools`` the legacy ``setup.py install`` method is deprecated. 2393 install`` method is deprecated. If the ``setup.py`` cannot be used with
2394 wheels, for example it creates files outside of the Python module or
2395 standard entry points, then :ref:`setuptools3_legacy
2396 <ref-classes-setuptools3_legacy>` should be used.
2397
2398.. _ref-classes-setuptools3_legacy:
2399
2400``setuptools3_legacy.bbclass``
2401==============================
2402
2403The ``setuptools3_legacy`` class supports Python version 3.x extensions that use
2404build systems based on ``setuptools`` (e.g. only have a ``setup.py`` and have
2405not migrated to the official ``pyproject.toml`` format). Unlike
2406``setuptools3.bbclass``, this uses the traditional ``setup.py`` ``build`` and
2407``install`` commands and not wheels. This use of ``setuptools`` like this is
2408`deprecated <https://github.com/pypa/setuptools/blob/main/CHANGES.rst#v5830>`_
2409but still relatively common.
2399 2410
2400.. _ref-classes-setuptools3-base: 2411.. _ref-classes-setuptools3-base:
2401 2412