PEP 517: Clear up ambiguity about metadata_directory (#292)

An ambiguity in the wording made it look like metadata_directory for build_wheel
would be the same directory as was passed in to the prepare_wheel_metadata hook.
It makes more sense for it to be the .dist-info directory returned from prepare_wheel_metadata.
This commit is contained in:
Thomas Kluyver 2017-06-16 07:59:09 +01:00 committed by Nick Coghlan
parent 89b7ed494c
commit 82ea79a94a
1 changed files with 5 additions and 5 deletions

View File

@ -211,9 +211,9 @@ Must build a .whl file, and place it in the specified ``wheel_directory``.
If the build frontend has previously called ``prepare_wheel_metadata`` and
depends on the wheel resulting from this call to have metadata
matching this earlier call, then it should provide the path to the
previous ``metadata_directory`` as an argument. If this argument is
provided, then ``build_wheel`` MUST produce a wheel with identical
matching this earlier call, then it should provide the path to the created
``.dist-info`` directory as the ``metadata_directory`` argument. If this
argument is provided, then ``build_wheel`` MUST produce a wheel with identical
metadata. The directory passed in by the build frontend MUST be
identical to the directory created by ``prepare_wheel_metadata``,
including any unrecognized files it created.
@ -696,8 +696,8 @@ in its subprocess runner like::
unzip_metadata(output_dir/*.whl)
def build_wheel(output_dir, config_settings, metadata_dir):
if os.path.exists(metadata_dir / "PIP_ALREADY_BUILT_WHEELS"):
copy(metadata_dir / *.whl, output_dir)
if os.path.exists(metadata_dir.parent / "PIP_ALREADY_BUILT_WHEELS"):
copy(metadata_dir.parent / *.whl, output_dir)
else:
backend.build_wheel(output_dir, config_settings, metadata_dir)