Re: [gentoo-dev] python-namespaces.eclass

[Brian Harring]

On Sun, Apr 03, 2011 at 07:38:17PM +0200, Arfrever Frehtes Taifersar Arahesis wrote:
> I would like to add python-namespaces.eclass. This eclass will be used by a small number of
> special packages, which will provide Python namespaces. These packages will be used as
> dependencies of other packages already present in the tree.
>
> Ebuilds using this eclass must set PYTHON_NAMESPACES variable before inheriting this eclass.
> Example (from net-zope/namespaces-zope):

namespaces-zope's invocation of the mod_optimize/cleanup crap isn't 
needed since it's EAPI>=3; EAPI3 preserves mtime.

What other consumers are expected for this beyond namespaces-zope?


>   PYTHON_NAMESPACES="Products Shared Shared.DC five +zope zope.app"
>
> This eclass provides 3 public functions:
>   python-namespaces_src_install()
>   python-namespaces_pkg_postinst()
>   python-namespaces_pkg_postrm()
>
> --
> Arfrever Frehtes Taifersar Arahesis
>
> # Copyright 1999-2011 Gentoo Foundation
> # Distributed under the terms of the GNU General Public License v2
> # $Header: $
>
> # @ECLASS: python-namespaces.eclass
> # @MAINTAINER:
> # Gentoo Python Project <python@g.o>
> # @BLURB: Eclass for packages installing Python namespaces
> # @DESCRIPTION:
> # The python-namespaces eclass defines phase functions for packages installing Python namespaces.

^^^ This isn't a useful description.  What is it doing to the phase 
functions?  What's the purpose for someone who isn't intimately 
familiar w/ python setuptools/namespaces?  Etc.

Seriously, I just spent a good 10 minutes digging through this crap 
trying to figure out what you were up to- that is *exactly* what the 
description should convey.

Same goes for the code; this needs to be peppered with 
clear/descriptive comments.  The description for PYTHON_NAMESPACES for 
example on it's own doesn't make clear that it screws with 
REQUIRED_USE (let alone exactly it's intent).

General commentary: If you want to do magic like this, it needs to be 
documented clearly so everyone else can figure out wtf it is exactly 
intending on doing (including what it actually is doing)- if it can't 
be documented to that level it doesn't belong in the tree, only in 
your personal overlay.

As mentioned by others, if you're going to use [[ ]] stop doing
unnecessarily quoting w/ that construct- fix your editor if it 
doesn't color it correctly.

~harring