[BUG] [easy_install] bug on checking the path of the distribution location

spxd commented 1 year ago

setuptools version

setuptools===68.2.2

Python version

Python 3.10

OS

Windows 11

Additional environment information

No response

Description

I can see if the package source path is already added to the PYTHONPATH then it's failing add the package source directory to the easy-install.pth when I run the "pip install -e ." easy_install.py

    def add(self, dist):
        """Add `dist` to the distribution map"""
        new_path = dist.location not in self.paths and (
            dist.location not in self.sitedirs
            or
            # account for '.' being in PYTHONPATH
            dist.location == os.getcwd()
        )
        if new_path:
            self.paths.append(dist.location)
            self.dirty = True
        super().add(dist)

In def add(self, dist) function in easy_install.py

dist.location == os.getcwd()

This code will return False, because the dist.location is already normcased during finalize_options in develop.py

target = _path.normpath(self.egg_base)

This target is passed as the location in Distribution

   # Make a distribution for the package's source
   self.dist = pkg_resources.Distribution(
       target,
       pkg_resources.PathMetadata(target, os.path.abspath(ei.egg_info)),
       project_name=ei.egg_name,
   )

For example, if the dist.location and os.getcwd() is dist.location = 'c:\users\abc\work\helloworld'
os.getcwd() = 'C:\Users\abc\work\helloworld'

The result is False, even though they are pointing same path.

it should be updated to

dist.location == os.path.normcase(os.getcwd())

easy_install.py

    def add(self, dist):
        """Add `dist` to the distribution map"""
        new_path = dist.location not in self.paths and (
            dist.location not in self.sitedirs
            or
            # account for '.' being in PYTHONPATH
            # dist.location is _path.nomcased but the os.getcwd() is not
            dist.location == os.path.normcase(os.getcwd())
        )
        if new_path:
            self.paths.append(dist.location)
            self.dirty = True
        super().add(dist)

Expected behavior

The path of source code should be added to the easy-install.pth file when it's installed as editable.

How to Reproduce

Add "." (current path) to the PYTHONPATH then run the "pip install -e ."

Output

If the easy-install.pth is not exist. it will not dump any error. But if there is easy-install.pth file exist, it will show this erro.

      File "C:\Users\...\lib\site-packages\setuptools\command\easy_install.py", line 1690, in save
        self.dirty |= last_dirty or self.paths != self._init_paths
    TypeError: unsupported operand type(s) for |=: 'list' and 'bool'

abravalheri commented 1 year ago

Hi @spxd, I can see that you already did a very in-depth investigation. Thank you very much for that. Would you like to provide a PR as well?

I can see if the package source path is already added to the PYTHONPATH then it's failing add the package source directory to the easy-install.pth when I run the "pip install -e ."

Note however that the latest versions of pip may not use the develop command, but instead rely on PEP 660. It was planned that pip 23.1+ would already adopt this behaviour by default, but that got postponed for a while. Instead pip will use internal heuristics to decide when to run python setup.py develop or when to use PEP 660 build APIs.

If you want to opt-in for the "new behaviour" you can use pip install --use-pep517 -e .

spxd commented 1 year ago

Hi @abravalheri,

Thanks for the response, I tried to upload the code updated but it seems I don't have permission.

remote: Permission to pypa/setuptools.git denied to spxd.

Can I have permission ? Thanks.

abravalheri commented 1 year ago

Hi @spxd please have a look on:

The process should not require especial permissions.

spxd commented 1 year ago

Thanks @abravalheri ! I could make PR successfully.

pypa / setuptools