logging messages about bad version numbers should include the project name

[nickwilson]

BPO	14778
Nosy	@tarekziade, @merwok
Files	bad_version_number_with_name.patch

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = 'https://github.com/merwok'
closed_at = <Date 2014-03-12.10:41:59.661>
created_at = <Date 2012-05-10.23:14:00.723>
labels = ['easy']
title = 'logging messages about bad version numbers should include the project name'
updated_at = <Date 2014-03-12.10:41:59.660>
user = 'https://bugs.python.org/nickwilson'

bugs.python.org fields:

activity = <Date 2014-03-12.10:41:59.660>
actor = 'eric.araujo'
assignee = 'eric.araujo'
closed = True
closed_date = <Date 2014-03-12.10:41:59.661>
closer = 'eric.araujo'
components = ['Distutils2']
creation = <Date 2012-05-10.23:14:00.723>
creator = 'nick.wilson'
dependencies = []
files = ['25589']
hgrepos = []
issue_num = 14778
keywords = ['patch', 'easy']
message_count = 8.0
messages = ['160381', '160383', '160630', '160632', '160634', '160659', '160665', '213245']
nosy_count = 5.0
nosy_names = ['tarek', 'eric.araujo', 'alexis', 'nick.wilson', 'sigi']
pr_nums = []
priority = 'normal'
resolution = 'out of date'
stage = 'resolved'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue14778'
versions = ['3rd party', 'Python 3.3']

[nickwilson]

IrrationalVersionError in packaging/distutils2 should include the name of the project responsible for the error. It currently only includes the version:

  >>> import packaging.pypi.xmlrpc
  >>> client = packaging.pypi.xmlrpc.Client()
  >>> client.search_projects('req')
  Irrational version error found: 0.0.0-prealpha
  Irrational version error found: 0.1dev-20110502
  ...

[merwok]

Setting to easy for the next sprints. To do: add an argument to the IrrationalVersion constructor, add a test to make sure the result of __str__ includes it, and adapt the rest of the codebase to pass the project name when the exception is raised.

[sigi]

I took a look at the code and I don't think that adding an argument to the IrrationalVersionError constructor is the right way to go.

The exception is raised in places where we don't know for which project we are raising the exception (eg in packaging.version.NormalizedVersion).

Wouldn't it be better to make packaging.pypi.xmlrpc.Client just print the
package name with the exception?

I would be glad to contribute a patch.

[merwok]

You are right. When the NormalizedVersion class is used standalone, there is no project name to pass, so it is the responsibility of higher-level code (the Metadata class I think here) to raise or log messages including the project name.

To make a patch, you can use the hg.python.org/distutils2 repo (also mirrored on Bitbucket under the python_mirrors user account for easing cloning) or the CPython repository. Thanks!

[merwok]

BTW there could be an optional argument in the exception constructor for the project name, but that does not seem clean to me.

[sigi]

The optional argument approach doesn't seem clean to me either.

I think the correct approach is - as you wrote - to change the higher level code to include the project name in the exception message.

[sigi]

I wrote a trivial patch against the CPython repository that adds the name to the exception message. Did I forget anything? What kind of test would make sense?

[merwok]

distutils2 development has stopped.