8000 517: Change build_backend to build-backend (#139) · python/peps@b12bc6a · GitHub
[go: up one dir, main page]

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit b12bc6a

Browse files
takluyverbrettcannon
authored andcommitted
517: Change build_backend to build-backend (#139)
The key is in the build-system table, so making this a dash would improve consistency. On English keyboards, it also avoids needing to press shift. There seemed to be a consensus on distutils-sig in favour of this change.
1 parent 024a7d5 commit b12bc6a

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

pep-0517.txt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -103,15 +103,15 @@ to it as the ``setup.py``\-style.
103103
Here we define a new style of source tree based around the
104104
``pyproject.toml`` file defined in PEP 518, extending the
105105
``[build-system]`` table in that file with one additional key,
106-
``build_backend``. Here's an example of how it would look::
106+
``build-backend``. Here's an example of how it would look::
107107

108108
[build-system]
109109
# Defined by PEP 518:
110110
requires = ["flit"]
111111
# Defined by this PEP:
112-
build_backend = "flit.api:main"
112+
build-backend = "flit.api:main"
113113

114-
``build_backend`` is a string naming a Python object that will be
114+
``build-backend`` is a string naming a Python object that will be
115115
used to perform the build (see below for details). This is formatted
116116
following the same ``module:object`` syntax as a ``setuptools`` entry
117117
point. For instance, if the string is ``"flit.api:main"`` as in the
@@ -123,7 +123,7 @@ equivalent of::
123123

124124
It's also legal to leave out the ``:object`` part, e.g. ::
125125

126-
build_backend = "flit.api"
126+
build-backend = "flit.api"
127127

128128
which acts like::
129129

@@ -141,11 +141,11 @@ And we import ``module_path`` and then lookup
141141
``module_path.object_path`` (or just ``module_path`` if
142142
``object_path`` is missing).
143143

144-
If the ``pyproject.toml`` file is absent, or the ``build_backend``
144+
If the ``pyproject.toml`` file is absent, or the ``build-backend``
145145
key is missing, the source tree is not using this specification, and
146146
tools should fall back to running ``setup.py``.
147147

148-
Where the ``build_backend`` key exists, it takes precedence over
148+
Where the ``build-backend`` key exists, it takes precedence over
149149
``setup.py``, and source trees need not include ``setup.py`` at all.
150150
Projects may still wish to include a ``setup.py`` for compatibility
151151
with tools that do not use this spec.

0 commit comments

Comments
 (0)
0