Fix setup.py in python_moztelemetry

RESOLVED FIXED

Status

Cloud Services
Metrics: Pipeline
P2
normal
RESOLVED FIXED
2 years ago
2 years ago

People

(Reporter: mreid, Assigned: mdoglio)

Tracking

(Blocks: 1 bug)

Firefox Tracking Flags

(Not tracked)

Details

(Reporter)

Description

2 years ago
When running `python setup.py sdist upload` from the python_moztelemetry repo, the resulting package does not include histogram_tools.py, nor does it fetch that file when installing from PyPI.

That file should ideally be downloaded during pip install, or if not, included in the dist tarball uploaded to PyPI.

Steps to reproduce:
- git clone git@github.com:mozilla/python_moztelemetry.git
- increment the package version in setup.py
- python setup.py sdist upload
- cd <some other dir>
- virtualenv foo
- source foo/bin/activate
- pip install python_moztelemetry
- python -c "import moztelemetry"

If you see an error like:
ImportError: No module named histogram_tools

then the package is broken.

The success case should either be quiet or print a warning like:
Unable to parse whitelist...
(Reporter)

Updated

2 years ago
Blocks: 1255748

Comment 1

2 years ago
Over to Mauro
Assignee: nobody → mdoglio
Priority: -- → P2
(Assignee)

Comment 2

2 years ago
I was able to reproduce this on my local machine using easy_install. On the other hand, `pip install` works as expected.
Before I spend time debugging this, do we have a reason to not include a copy of histogram_tools.py in the repository?
Looking at the changelog on m-c it doesn't seem to be updated very often.
Imho adding that file to the python_moztelemetry repo would make both testing and deploying the library more deterministic. In exchange for that we would have to bump up the package version when histogram_tools is updated, which is a little bit more work. But again, it doesn't seem to happen very often.
:mreid any opinion on that?
(Assignee)

Updated

2 years ago
Flags: needinfo?(mreid)
(Reporter)

Comment 3

2 years ago
I think it's a good idea to include the histogram_tools.py file in the pip package. That way the code in the package is always the same for a given version, regardless of when you install it.

I'm not sure the best way to enforce / encourage the version bump when that file changes in the tree.
Flags: needinfo?(mreid)
(Assignee)

Comment 4

2 years ago
I think it's up to the reviewer of the patch on mozilla-central to bump up the version on the github repo. I'll try to come up with some notification service on the long term.
I'm copying histogram_tools.py to the python_moztelemetry repository as part of https://github.com/mozilla/python_moztelemetry/pull/63/
(Assignee)

Comment 5

2 years ago
histogram_tools.py was added to the repository in https://github.com/mozilla/python_moztelemetry/commit/1ee48482f6aa43e944327f7a7183bc48bfe8ac36
Status: NEW → RESOLVED
Last Resolved: 2 years ago
Resolution: --- → FIXED
You need to log in before you can comment on or make changes to this bug.