Write a new naming guideline for python/python3 modules?

Chen Lei supercyper1 at gmail.com
Wed Sep 15 17:11:35 UTC 2010


Hi all,

It seems the current python modules naming guideline is ambiguous,
different package maintainers use different naming conventions. It
have also caused much controversy between submitter and reviewer which
is just a waste of time, so I think it's worth to write a new
python/python3 modules naming guideline for fedora. The purpose of
this discussion is decreasing inconsistent package names of python
modules in fedora. Personally, I don't mind how to name a package in
fedora as long as the naming guideline is clear and won't create much
divergence.

e.g.
1. https://bugzilla.redhat.com/show_bug.cgi?id=603245
The module name for this package is zmq, the tarball name for this
package is pyzmq. The submitter determined to use python-zmq as the
pkgname, however there are some other choice for the pkgname(e.g.
pyzmq, python-pyzmq)

2. https://bugzilla.redhat.com/show_bug.cgi?id=623425
The module name for this package is Pyside, the tarball name for this
package is pyside. The submitter determined to use python-pyside as
the pkgname, however there are some other choice for the pkgname(e.g.
python-PySide, pyside, PySide)

3. https://bugzilla.redhat.com/show_bug.cgi?id=608509
The module and tarball name for this package is subvertpy. the
submitter determined to use subvertpy as the pkgname, however there
are some other choice for the pkgname(e.g. python-subvertpy)

4. https://bugzilla.redhat.com/show_bug.cgi?id=606019
The module name for this package is setuptools, the tarball name for
this package is distribute. The submitter determined to use
python-distribute as the pkgname, however the
current maintainer want to keep the name of python-setuptools.

There are also some other divergence in fedora repos, e.g.
sympy/python-simpy, python-pycurl/pyflakes etc. There are much more
inconsistency if we consider python and python3 modules, e.g.
PyQt4/python3-PyQt4 pyke/python3-pyke.

I remember David Malcolm already wrote a naming guideline proposal for
python3 modules one year ago[1], no one objects his proposal, so I
think we can write a new packaging guideline draft based on his
proposal.

First of all, I think we should remove exception rule from guideline -
"There is an exception to this rule. If the upstream source has "py"
(or "Py") in its name, you can use that name for the package"  since
we have several python runtimes in fedora/EPEL(e.g. python2/python3
for F13+ python2.4/2.6 for EPEL5) now.

Here is my draft refer to the debian naming policy[2]:
Packages of python modules (thus they rely on python as a parent) use
a slightly different naming scheme. They should be preferably named
python-$NAME where the $NAME is the name of the module that you type
to import it in a script, but this is not required if the package
ships multiple modules. In the latter case the maintainer chooses the
name which represents the package most (e.g. the upstream tarball or
project name from which this software came). There is an exception to
this rule, if the python module has a period '.' in its name, we
should replace it with a dash '-'  since '.' is not an acceptable
separator for fedora.

Examples:
python-zmq/python3-zmq (tarball name pyzmq)
python-gtk/python3-gtk (tarball name pygtk)
python-PyQt4/python3-PyQt4 (tarball name PyQt)
python-MySQLdb/python3-MySQLdb (tarball name MySQL-python)
python-twisted-core (tarball name TwistedCore, the package ships
multiple modules)
python-twisted-news (tarball name TwistedNews module name twisted.news)
python-AppTools (tarball name AppTools, the package ships multiple modules)


[1]http://lists.fedoraproject.org/pipermail/python-devel/2009-October/000191.html
[2]http://www.debian.org/doc/packaging-manuals/python-policy/ch-module_packages.html


Thought?


Regards,
Chen Lei


More information about the python-devel mailing list