Re: [Sunuml-developers] Local source directories and the CamelCasetopic

[Ricardo C. <ric...@ho...>]

I agree.

 

Regards,

 

Ricardo

 

  _____  

From: Steven Gay [mailto:laz...@gm...] 
Sent: Lunes, 10 de Noviembre del 2008 18:43
To: sun...@li...
Subject: Re: [Sunuml-developers] Local source directories and the
CamelCasetopic

 

 

short question: Should we create the source code in a directory named
"/sunuml/src" (it's the way I know)?
Someone - I don't know anymore who - started to store python source code in
"/sunuml/core".


If we want to put all source in a folder then sunuml/src is cleaner.

However it depends if we want to divide our code in sub parts: such as
compiled modules .pyc as you would do for C++ dlls.


In this case the following is very nice (for c++ projects) because it
permits to use simple relative paths for includes :

/sunuml/core/src/core/
/sunuml/core/build/

/sunuml/utilities/src/utilities/
/sunuml/utilities/build/


You then include with  include "core/xxx.py" or "utilities/yyy.py".


Using such a structure would permit us to create stable compiled modules....
and avoid that we rebuild all at each small modifications.

See one of my projects
http://www.opengameengine.org/wiki/index.php?title=Project_Structure#Oge_fol
ders_structure


Shall we structure our project around modules from the start?

Note: the .pyc being copied in a common sunuml/lib  (folder which must not
be committed).
 




I think that maybe a point in the middle will be better.

- Use CamelCase methods when the class we make extends directly from a
wxPython class, because if you override methods from the upperclass you
are forced to use that standard, and I think all methods should have the
same standard inside a class. This should be used for example on a
subclass of wx.Frame.

- Use mixedCase standard when making our own classes and model classes.
I would prefer to use this standard everywhere but on the other classes
it would be prone to error mixing the standards.


OK - I will wiki this.