← Back to team overview

dolfin team mailing list archive

Re: [Bug 793512] [NEW] Classes are indexed twice in Python Programmer's Reference

 

On Monday June 6 2011 10:52:37 Kristian B. Ølgaard wrote:
> On 6 June 2011 18:03, Johan Hake <793512@xxxxxxxxxxxxxxxxxx> wrote:
> > On Monday June 6 2011 08:01:19 Kristian B. Ølgaard wrote:
> >> On 6 June 2011 15:03, Marie Rognes <793512@xxxxxxxxxxxxxxxxxx> wrote:
> >> > Public bug reported:
> >> > 
> >> > 
> >> > Python classes are indexed (at least) twice in the Python Programmer's
> >> > Reference, for instance the index points to the class FunctionSpace in
> >> > both dolfin.functions and dolfin.functions.functionspace:
> >> > 
> >> >  FunctionSpace (class in dolfin.cpp)
> >> > 
> >> >      (class in dolfin.functions)
> >> >      (class in dolfin.functions.functionspace)
> >> > 
> >> > Is this intended? If so, it is confusing.
> >> 
> >> Not all classes are indexed twice, e.g., the FiniteElement is only
> >> defined in dolfin.cpp.
> >> What part is it that you find confusing?
> >> The dolfin.cpp.FunctionSpace and
> >> dolfin.functions.functionspace.FunctionSpace are two
> >> different classes so there should be two entries.
> >> The FunctionSpace class from dolfin.functions is picked up because
> >> FunctionSpace is included in the __all__ variable
> >> in dolfin.functions.__init__.py.
> >> So perhaps we could skip extracting functions and classes from
> >> __init__.py files, and just hope that no one actually defines a class
> >> or a function in these files?
> > 
> > I think that assumption should be safe. I can add a comment to all
> > __init__.py files stating that no classes or functions should be defined
> > there.
> 
> That's probably a good idea, then I think we can safely ignore __all__
> in __init__.py.

I jumped to it and it should already be pushed.

Johan

> Kristian
> 
> > Johan
> > 
> > Johan
> > 
> >> Kristian
> >> 
> >> > ** Affects: dolfin
> >> >     Importance: Undecided
> >> >         Status: New
> >> > 
> >> > --
> >> > You received this bug notification because you are a member of DOLFIN
> >> > Core Team, which is subscribed to DOLFIN.
> >> > https://bugs.launchpad.net/bugs/793512
> >> > 
> >> > Title:
> >> >  Classes are indexed twice in Python Programmer's Reference
> >> > 
> >> > Status in DOLFIN:
> >> >  New
> >> > 
> >> > Bug description:
> >> > 
> >> >  Python classes are indexed (at least) twice in the Python
> >> > Programmer's Reference, for instance the index points to the class
> >> > FunctionSpace in both dolfin.functions and
> >> > dolfin.functions.functionspace:
> >> > 
> >> >    FunctionSpace (class in dolfin.cpp)
> >> > 
> >> >        (class in dolfin.functions)
> >> >        (class in dolfin.functions.functionspace)
> >> > 
> >> >  Is this intended? If so, it is confusing.
> > 
> > --
> > You received this bug notification because you are a member of DOLFIN
> > Core Team, which is subscribed to DOLFIN.
> > https://bugs.launchpad.net/bugs/793512
> > 
> > Title:
> >  Classes are indexed twice in Python Programmer's Reference
> > 
> > Status in DOLFIN:
> >  New
> > 
> > Bug description:
> > 
> >  Python classes are indexed (at least) twice in the Python Programmer's
> > Reference, for instance the index points to the class FunctionSpace in
> > both dolfin.functions and dolfin.functions.functionspace:
> > 
> >    FunctionSpace (class in dolfin.cpp)
> > 
> >        (class in dolfin.functions)
> >        (class in dolfin.functions.functionspace)
> > 
> >  Is this intended? If so, it is confusing.

-- 
You received this bug notification because you are a member of DOLFIN
Team, which is subscribed to DOLFIN.
https://bugs.launchpad.net/bugs/793512

Title:
  Classes are indexed twice in Python Programmer's Reference

Status in DOLFIN:
  New

Bug description:
  
  Python classes are indexed (at least) twice in the Python Programmer's Reference, for instance the index points to the class FunctionSpace in both dolfin.functions and dolfin.functions.functionspace:

    FunctionSpace (class in dolfin.cpp)

        (class in dolfin.functions)
        (class in dolfin.functions.functionspace) 

  Is this intended? If so, it is confusing.


References