Hardcode packages variable in setup.py to prevent installation of files in 'tests' directory by Nowa-Ammerlaan · Pull Request #32 · vidify/vidify

Nowa-Ammerlaan · 2019-12-09T15:55:19Z

Hello,

I've ran into a small problem with the setup.py file. Portage (gentoo's package manager) kept complaining about my ebuild:

>>> Failed to emerge dev-python/spotify-music-videos-1.8, Log file:

>>>  '/var/tmp/portage/dev-python/spotify-music-videos-1.8/temp/build.log'

* Messages for package dev-python/spotify-music-videos-1.8:

* ERROR: dev-python/spotify-music-videos-1.8::localrepo failed (install phase):
*   Package installs 'tests' package which is forbidden and likely a bug in the build system.
* 
* Call stack:
*     ebuild.sh, line  125:  Called src_install
*   environment, line 3423:  Called distutils-r1_src_install
*   environment, line 1119:  Called _distutils-r1_run_foreach_impl 'distutils-r1_python_install'
*   environment, line  466:  Called python_foreach_impl 'distutils-r1_run_phase' 'distutils-r1_python_install'
*   environment, line 2970:  Called multibuild_foreach_variant '_python_multibuild_wrapper' 'distutils-r1_run_phase' 'distutils-r1_python_install'
*   environment, line 2284:  Called _multibuild_run '_python_multibuild_wrapper' 'distutils-r1_run_phase' 'distutils-r1_python_install'
*   environment, line 2282:  Called _python_multibuild_wrapper 'distutils-r1_run_phase' 'distutils-r1_python_install'
*   environment, line  803:  Called distutils-r1_run_phase 'distutils-r1_python_install'
*   environment, line 1087:  Called distutils-r1_python_install
*   environment, line 1005:  Called die
* The specific snippet of code:
*               die "Package installs '${p}' package which is forbidden and likely a bug in the build system.";

I was a bit confused about this, as I also wrote ebuilds for some dependencies (lyricwikia, python-vlc) which also have a 'tests' directory, yet portage was absolutely fine with these ebuilds.

In my initial ebuild I fixed this by just patching out the whole 'tests' directory prior to installing. However, this solution is imperfect so I kept looking for what was differentiating this repository from the lyricwikia one.

It took some time but I finally found the problem, in setup.py. The line packages=find_packages(), causes setuptools to find all directories, including 'tests', (which shouldn't be installed). Hardcoding it to ['spotify-videos'] similarly to the setup.py's I found in other repositories fixes the problem.

[EDIT]: See also: gentoo/gentoo#13870

…es in 'tests' directory

…fy song Commit number 5, move some deps that were here to deps of this package. And improved the patch to actually fix the issue in setup.py, instead of just removing the 'tests' directory, see also: vidify/vidify#32 Bug: https://bugs.gentoo.org/701922 Signed-off-by: Andrew Ammerlaan <andrewammerlaan@riseup.net> Package-Manager: Portage-2.3.80, Repoman-2.3.19 Package-Manager: Portage-2.3.81, Repoman-2.3.20

marioortizmanero · 2019-12-09T17:30:32Z

Thanks for your contribution :)) I initially just used a lazy find_packages() but yeah, hardcoding them is a better idea since it's just one. Let me do a couple tests and I'll merge it.

Edit: it seems you missed a , after the packages parameter. Can you fix that so that I can merge the PR?

setup.py

Nowa-Ammerlaan · 2019-12-09T17:39:33Z

it seems you missed a , after the packages parameter. Can you fix that so that I can merge the PR?

Aah I missed that one, that's what I get for being lazy and just copying the change instead of applying the patch I pushed to my branch of the Gentoo repo earlier (I had it with the ',' there). Thanks for catching that

marioortizmanero · 2019-12-09T19:31:42Z

Sorry, one last thing: the module name is spotify_videos, not spotify-videos.

Nowa-Ammerlaan · 2019-12-09T19:39:52Z

Sorry, one last thing: the module name is spotify_videos, not spotify-videos.

Oops, sorry about that, I had it correct in the patch I uploaded to the Gentoo repo, but then made a mistake copying it (again).

I think there's a lesson for me here: always apply the patch that has been proven to work instead of being lazy and thinking I can get away with copying the changes :D

marioortizmanero · 2019-12-09T20:00:15Z

Don't worry it works perfectly now :)

marioortizmanero · 2019-12-10T14:32:52Z

@AndrewAmmerlaan I've released the 1.8.1 version with this hotfix, in case you wanted to download the .tar.gz file for the Gentoo installation: https://github.com/marioortizmanero/spotify-music-videos/releases/tag/1.8.1

…fy song Version bump to 1.8.1 and remove now obsolete patch, changed src_uri because this version is not on pypi yet see also: vidify/vidify#32 Bug: https://bugs.gentoo.org/701922 Signed-off-by: Andrew Ammerlaan <andrewammerlaan@riseup.net> Package-Manager: Portage-2.3.81, Repoman-2.3.20

Nowa-Ammerlaan · 2019-12-10T16:36:44Z

@AndrewAmmerlaan I've released the 1.8.1 version with this hotfix, in case you wanted to download the .tar.gz file for the Gentoo installation: https://github.com/marioortizmanero/spotify-music-videos/releases/tag/1.8.1

Awesome, thank you, I've updated the ebuild and removed the patch form my pull request in the gentoo repository

…fy song Version bump to 1.8.1 and remove now obsolete patch, changed src_uri because this version is not on pypi yet see also: vidify/vidify#32 Bug: https://bugs.gentoo.org/701922 Signed-off-by: Andrew Ammerlaan <andrewammerlaan@riseup.net> Package-Manager: Portage-2.3.82, Repoman-2.3.20

…fy song Bug: https://bugs.gentoo.org/701922 Signed-off-by: Andrew Ammerlaan <andrewammerlaan@riseup.net> Package-Manager: Portage-2.3.80, Repoman-2.3.19 Package-Manager: Portage-2.3.80, Repoman-2.3.19 dev-python/spotify-music-videos: Show Youtube videos/lyrics for Spotify song Version bump to 1.8.1 and remove now obsolete patch, changed src_uri because this version is not on pypi yet see also: vidify/vidify#32 Bug: https://bugs.gentoo.org/701922 Signed-off-by: Andrew Ammerlaan <andrewammerlaan@riseup.net> Package-Manager: Portage-2.3.82, Repoman-2.3.20

…fy song Bug: https://bugs.gentoo.org/701922 Signed-off-by: Andrew Ammerlaan <andrewammerlaan@riseup.net> Package-Manager: Portage-2.3.80, Repoman-2.3.19 Package-Manager: Portage-2.3.80, Repoman-2.3.19 dev-python/spotify-music-videos: Show Youtube videos/lyrics for Spotify song Version bump to 1.8.1 and remove now obsolete patch, changed src_uri because this version is not on pypi yet see also: vidify/vidify#32 Bug: https://bugs.gentoo.org/701922 Signed-off-by: Andrew Ammerlaan <andrewammerlaan@riseup.net> Package-Manager: Portage-2.3.82, Repoman-2.3.20 dev-python/spotify-music-videos: Show Youtube videos/lyrics for Spotify song Version bump to 1.8.1 and remove now obsolete patch, changed src_uri because this version is not on pypi yet see also: vidify/vidify#32 Bug: https://bugs.gentoo.org/701922 Signed-off-by: Andrew Ammerlaan <andrewammerlaan@riseup.net> Package-Manager: Portage-2.3.82, Repoman-2.3.20

…fy song Bug: https://bugs.gentoo.org/701922 Signed-off-by: Andrew Ammerlaan <andrewammerlaan@riseup.net> Package-Manager: Portage-2.3.80, Repoman-2.3.19 Package-Manager: Portage-2.3.80, Repoman-2.3.19 dev-python/spotify-music-videos: Show Youtube videos/lyrics for Spotify song Version bump to 1.8.1 and remove now obsolete patch, changed src_uri because this version is not on pypi yet see also: vidify/vidify#32 Bug: https://bugs.gentoo.org/701922 Signed-off-by: Andrew Ammerlaan <andrewammerlaan@riseup.net> Package-Manager: Portage-2.3.82, Repoman-2.3.20 dev-python/spotify-music-videos: Show Youtube videos/lyrics for Spotify song Version bump to 1.8.1 and remove now obsolete patch, changed src_uri because this version is not on pypi yet see also: vidify/vidify#32 Bug: https://bugs.gentoo.org/701922 Signed-off-by: Andrew Ammerlaan <andrewammerlaan@riseup.net> Package-Manager: Portage-2.3.82, Repoman-2.3.20 dev-python/spotify-music-videos: Show Youtube videos/lyrics for Spoti… …fy song Bug: https://bugs.gentoo.org/701922 Signed-off-by: Andrew Ammerlaan <andrewammerlaan@riseup.net> Package-Manager: Portage-2.3.82, Repoman-2.3.20

…fy song Bug: https://bugs.gentoo.org/701922 Signed-off-by: Andrew Ammerlaan <andrewammerlaan@riseup.net> Package-Manager: Portage-2.3.80, Repoman-2.3.19 Package-Manager: Portage-2.3.80, Repoman-2.3.19 dev-python/spotify-music-videos: Show Youtube videos/lyrics for Spotify song Version bump to 1.8.1 and remove now obsolete patch, changed src_uri because this version is not on pypi yet see also: vidify/vidify#32 Bug: https://bugs.gentoo.org/701922 Signed-off-by: Andrew Ammerlaan <andrewammerlaan@riseup.net> Package-Manager: Portage-2.3.82, Repoman-2.3.20 dev-python/spotify-music-videos: Show Youtube videos/lyrics for Spotify song Version bump to 1.8.1 and remove now obsolete patch, changed src_uri because this version is not on pypi yet see also: vidify/vidify#32 Bug: https://bugs.gentoo.org/701922 Signed-off-by: Andrew Ammerlaan <andrewammerlaan@riseup.net> Package-Manager: Portage-2.3.82, Repoman-2.3.20 dev-python/spotify-music-videos: Show Youtube videos/lyrics for Spoti… …fy song Bug: https://bugs.gentoo.org/701922 Signed-off-by: Andrew Ammerlaan <andrewammerlaan@riseup.net> Package-Manager: Portage-2.3.82, Repoman-2.3.20 dev-python/spotify-music-videos: Package-Manager: Portage-2.3.82, Repoman-2.3.20

Hardcode packages variable in setup.py to prevent installation of fil…

dcf9915

…es in 'tests' directory

marioortizmanero reviewed Dec 9, 2019

View reviewed changes

setup.py Outdated Show resolved Hide resolved

Fix missing ,

a3e48fa

fix spotify-videos --> spotify_videos

6e29262

marioortizmanero merged commit a7c9abe into vidify:master Dec 9, 2019

Nowa-Ammerlaan deleted the setup.py-fix branch December 9, 2019 20:02

Nowa-Ammerlaan mentioned this pull request Dec 10, 2019

dev-python/spotify-music-videos: Show Youtube videos/lyrics for Spotify song gentoo/gentoo#13870

Closed

Nowa-Ammerlaan mentioned this pull request Dec 31, 2019

Fix setup.py, added find_packages again but this time using the exclude= option #34

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Hardcode packages variable in setup.py to prevent installation of files in 'tests' directory#32

Hardcode packages variable in setup.py to prevent installation of files in 'tests' directory#32
marioortizmanero merged 3 commits intovidify:masterfrom
Nowa-Ammerlaan:setup.py-fix

Nowa-Ammerlaan commented Dec 9, 2019 •

edited

Loading

Uh oh!

marioortizmanero commented Dec 9, 2019 •

edited

Loading

Uh oh!

Uh oh!

Nowa-Ammerlaan commented Dec 9, 2019 •

edited

Loading

Uh oh!

marioortizmanero commented Dec 9, 2019

Uh oh!

Nowa-Ammerlaan commented Dec 9, 2019 •

edited

Loading

Uh oh!

marioortizmanero commented Dec 9, 2019

Uh oh!

marioortizmanero commented Dec 10, 2019

Uh oh!

Nowa-Ammerlaan commented Dec 10, 2019 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

Nowa-Ammerlaan commented Dec 9, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

marioortizmanero commented Dec 9, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Nowa-Ammerlaan commented Dec 9, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

marioortizmanero commented Dec 9, 2019

Uh oh!

Nowa-Ammerlaan commented Dec 9, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

marioortizmanero commented Dec 9, 2019

Uh oh!

marioortizmanero commented Dec 10, 2019

Uh oh!

Nowa-Ammerlaan commented Dec 10, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Nowa-Ammerlaan commented Dec 9, 2019 •

edited

Loading

marioortizmanero commented Dec 9, 2019 •

edited

Loading

Nowa-Ammerlaan commented Dec 9, 2019 •

edited

Loading

Nowa-Ammerlaan commented Dec 9, 2019 •

edited

Loading

Nowa-Ammerlaan commented Dec 10, 2019 •

edited

Loading