Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove dead code related to InstallRequirement build directories #7405

Merged
merged 3 commits into from
Nov 27, 2019
Merged

Remove dead code related to InstallRequirement build directories #7405

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9886e8d
Assert that we aren't using most of "move_to_correct_build_directory"
chrahunt Nov 26, 2019
99c7598
Remove dead code from move_to_correct_build_directory
chrahunt Nov 26, 2019
dbd80ec
Remove unused code related to moving build directory
chrahunt Nov 26, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 4 additions & 64 deletions src/pip/_internal/req/req_install.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,9 +162,6 @@ def __init__(
self.conflicts_with = None
# Temporary build location
self._temp_build_dir = None # type: Optional[TempDirectory]
# Used to store the global directory where the _temp_build_dir should
# have been created. See move_to_correct_build_directory().
self._ideal_build_dir = None # type: Optional[str]
# Set to True after successful installation
self.install_succeeded = None # type: Optional[bool]
self.options = options if options else {}
Expand Down Expand Up @@ -362,15 +359,10 @@ def ensure_build_location(self, build_dir):
assert self._temp_build_dir.path
return self._temp_build_dir.path
if self.req is None:
# for requirement via a path to a directory: the name of the
# package is not available yet so we create a temp directory
# Once run_egg_info will have run, we'll be able to fix it via
# move_to_correct_build_directory().
# Some systems have /tmp as a symlink which confuses custom
# builds (such as numpy). Thus, we ensure that the real path
# is returned.
self._temp_build_dir = TempDirectory(kind="req-build")
self._ideal_build_dir = build_dir

return self._temp_build_dir.path
if self.editable:
Expand All @@ -384,19 +376,13 @@ def ensure_build_location(self, build_dir):
_make_build_dir(build_dir)
return os.path.join(build_dir, name)

def move_to_correct_build_directory(self):
def _set_requirement(self):
# type: () -> None
"""Move self._temp_build_dir to "self._ideal_build_dir/{metadata name}"

For some requirements (e.g. a path to a directory), the name of the
package is not available until we run egg_info, so the build_location
will return a temporary directory and store the _ideal_build_dir.

This is only called to "fix" the build directory after generating
metadata.
"""Set requirement after generating metadata.
"""
assert self.req is None
assert self.metadata is not None
assert self.source_dir is not None

# Construct a Requirement object from the generated metadata
if isinstance(parse_version(self.metadata["Version"]), Version):
Expand All @@ -412,52 +398,6 @@ def move_to_correct_build_directory(self):
])
)

if self.source_dir is not None:
return

assert self._temp_build_dir
assert (
self._ideal_build_dir is not None and
self._ideal_build_dir.path # type: ignore
)

# Backup directory for later use.
old_location = self._temp_build_dir
self._temp_build_dir = None # checked inside ensure_build_location

# Figure out the correct place to put the files.
new_location = self.ensure_build_location(self._ideal_build_dir)
if os.path.exists(new_location):
raise InstallationError(
'A package already exists in %s; please remove it to continue'
% display_path(new_location)
)

# Move the files to the correct location.
logger.debug(
'Moving package %s from %s to new location %s',
self, display_path(old_location.path), display_path(new_location),
)
shutil.move(old_location.path, new_location)

# Update directory-tracking variables, to be in line with new_location
self.source_dir = os.path.normpath(os.path.abspath(new_location))
self._temp_build_dir = TempDirectory(
path=new_location, kind="req-install",
)

# Correct the metadata directory
old_meta = self.metadata_directory
rel = os.path.relpath(old_meta, start=old_location.path)
new_meta = os.path.join(new_location, rel)
new_meta = os.path.normpath(os.path.abspath(new_meta))
self.metadata_directory = new_meta

# Done with any "move built files" work, since have moved files to the
# "ideal" build location. Setting to None allows to clearly flag that
# no more moves are needed.
self._ideal_build_dir = None

def warn_on_mismatching_name(self):
# type: () -> None
metadata_name = canonicalize_name(self.metadata["Name"])
Expand Down Expand Up @@ -626,7 +566,7 @@ def prepare_metadata(self):

# Act on the newly generated metadata, based on the name and version.
if not self.name:
self.move_to_correct_build_directory()
self._set_requirement()
else:
self.warn_on_mismatching_name()

Expand Down