MǬ v d dl mZ d dlmZ ddlmZ d dlmZ h dZ G d de Z G d d
e Z
d S ) ) annotations)Protocol ) Distribution)build> build_py build_ext
build_clib
build_scriptsc 8 e Zd ZU ded< ej dd ZdS )r r distributionN)__name__
__module__ __qualname____annotations___build sub_commands j/builddir/build/BUILD/cloudlinux-venv-1.0.10/venv/lib/python3.11/site-packages/setuptools/command/build.pyr r s/ &qqq)LLLr r c ` e Zd ZU dZdZded< ded< dd Zdd
Zdd Zdd
Z ddZ
ddZ dS )
SubCommanda. In order to support editable installations (see :pep:`660`) all
build subcommands **SHOULD** implement this protocol. They also **MUST** inherit
from ``setuptools.Command``.
When creating an :pep:`editable wheel <660>`, ``setuptools`` will try to evaluate
custom ``build`` subcommands using the following procedure:
1. ``setuptools`` will set the ``editable_mode`` attribute to ``True``
2. ``setuptools`` will execute the ``run()`` command.
.. important::
Subcommands **SHOULD** take advantage of ``editable_mode=True`` to adequate
its behaviour or perform optimisations.
For example, if a subcommand doesn't need to generate an extra file and
all it does is to copy a source file into the build directory,
``run()`` **SHOULD** simply "early return".
Similarly, if the subcommand creates files that would be placed alongside
Python files in the final distribution, during an editable install
the command **SHOULD** generate these files "in place" (i.e. write them to
the original source directory, instead of using the build directory).
Note that ``get_output_mapping()`` should reflect that and include mappings
for "in place" builds accordingly.
3. ``setuptools`` use any knowledge it can derive from the return values of
``get_outputs()`` and ``get_output_mapping()`` to create an editable wheel.
When relevant ``setuptools`` **MAY** attempt to use file links based on the value
of ``get_output_mapping()``. Alternatively, ``setuptools`` **MAY** attempt to use
:doc:`import hooks ` to redirect any attempt to import
to the directory with the original source code and other files built in place.
Please note that custom sub-commands **SHOULD NOT** rely on ``run()`` being
executed (or not) to provide correct return values for ``get_outputs()``,
``get_output_mapping()`` or ``get_source_files()``. The ``get_*`` methods should
work independently of ``run()``.
Fbool
editable_modestr build_libreturnNonec dS z@(Required by the original :class:`setuptools.Command` interface)Nr selfs r initialize_optionsz SubCommand.initialize_optionsX r c dS r r r! s r finalize_optionszSubCommand.finalize_options\ r$ r c dS r r r! s r runzSubCommand.run` r$ r list[str]c dS )a
Return a list of all files that are used by the command to create the expected
outputs.
For example, if your build command transpiles Java files into Python, you should
list here all the Java files.
The primary purpose of this function is to help populating the ``sdist``
with all the files necessary to build the distribution.
All files should be strings relative to the project root directory.
Nr r! s r get_source_fileszSubCommand.get_source_filesd s r c dS )a
Return a list of files intended for distribution as they would have been
produced by the build.
These files should be strings in the form of
``"{build_lib}/destination/file/path"``.
.. note::
The return value of ``get_output()`` should include all files used as keys
in ``get_output_mapping()`` plus files that are generated during the build
and don't correspond to any source file already present in the project.
Nr r! s r get_outputszSubCommand.get_outputsp s r dict[str, str]c dS )a
Return a mapping between destination files as they would be produced by the
build (dict keys) into the respective existing (source) files (dict values).
Existing (source) files should be represented as strings relative to the project
root directory.
Destination files should be strings in the form of
``"{build_lib}/destination/file/path"``.
Nr r! s r get_output_mappingz SubCommand.get_output_mapping~ s r N)r r )r r) )r r. ) r r r __doc__r r r# r& r( r+ r- r0 r r r r r s $ $L M NNN(
r r N)
__future__r typingr distr distutils.command.buildr r _ORIGINAL_SUBCOMMANDSr r r r r7 s " " " " " " 3 3 3 3 3 3PPP * * * * *F * * *t t t t t t t t t t r