general coding issues - coding style...

[calmar]

Hi all,

since I'm just a 'handicraft'/beginner or so,

could anybody provide me with some (rough) hints, about how to enhance the code
here:

http://calmar.ws/tmp/cal.html

Cheers and thanks a lot
calmar


--
calmar

(o_ It rocks: LINUX + Command-Line-Interface
//\
V_/_ http://www.calmar.ws

[Diez B. Roggisch]

Re: general coding issues - coding style...

calmar schrieb:[color=blue]
> Hi all,
>
> since I'm just a 'handicraft'/beginner or so,
>
> could anybody provide me with some (rough) hints, about how to enhance the code
> here:[/color]

- why are these {{{ thingies there?

- use string interpolation like "Foo %s %i" % ("bar", 1) instead of
concatenating strings.

- it seems that you could benefit from a class instead of a bunch of
functions & few globals. No need to go too crazy about OO, but it has
its merits

- try using something like glade - creating GUIs by hand sucks
big-timer :)

- read up about unicode and encodings, what they mean and why and when
to use what. Really. Most problems in that field stem from people being
sort of ignorant on that topic and just wiggling themselves through all
the time - in the end, messing up stuff. It really _isn't_ that complicated.

- when creating string-keyed dicts, the idiom

dict(foo="bar",
baz="pillepalle ")

has its merits.

Besides that - looks ok to me.

Diez

[calmar]

Re: general coding issues - coding style...

On 2006-02-18, Diez B. Roggisch <deets@nospam.w eb.de> wrote:

Hi Diez,
[color=blue]
> - why are these {{{ thingies there?[/color]

markers for folding for vim

http://www.calmar.ws/tmp/sc.png

[color=blue]
> - use string interpolation like "Foo %s %i" % ("bar", 1) instead of
> concatenating strings.[/color]

I see, get's shorter and so, and I can break lines.
(seems to me, after ( or [ or so, I can use a new line without
to worry)
[color=blue]
> - it seems that you could benefit from a class instead of a bunch of
> functions & few globals. No need to go too crazy about OO, but it has
> its merits[/color]

I see. Maybe I could then build some classes for that prog,
especially since I use only one file, it probably would make
some sense for getting a better structure.
[color=blue]
>
> - try using something like glade - creating GUIs by hand sucks
> big-timer :)[/color]

I should (seriously) check out probably.
[color=blue]
> - read up about unicode and encodings, what they mean and why and when
> to use what. Really. Most problems in that field stem from people being
> sort of ignorant on that topic and just wiggling themselves through all
> the time - in the end, messing up stuff. It really _isn't_ that complicated.[/color]

I read up. In fact, basically it does not seem to be that complicate.
Unicode just a 'numbered' list of all available character, and
e.g. uft-8 a organized way to 'store' those 'numbers' wisely
into bytes.

I still have some problems with that (and gave up), but since I begin to
now understand it somebit more, I should try/check again.
[color=blue]
> - when creating string-keyed dicts, the idiom
>
> dict(foo="bar",
> baz="pillepalle ")[/color]

I see, I changed too.

Thanks a lot,
marco

--
calmar

(o_ It rocks: LINUX + Command-Line-Interface
//\
V_/_ http://www.calmar.ws

[plahey@alumni.caltech.edu]

Re: general coding issues - coding style...

Hi,

1585 if sys.path[0][-12:] == "\library.z ip": #for py2exe

how about

if sys.path[0].endswith( "\\library. zip" ):

(did you really mean one back-slash there?)


499 tuple = os.path.split(f ilename)

bad variable name... tuple(x) converts a sequence to a tuple.


You have a number of places where you check for len(x)==0:

674 if len(files) == 0:
853 if len(file_show) == 0:
950 if len(imgprocess["files_todo "]) == 0:

people usually recommend:

if not files:
if not file_show:
if not imgprocess["files_todo "]:


you should run your code through pychecker (it had a lot to say...).


You use global alot... that should be a red flag. Like the poster
above mentioned, you have things that are telling you they want to
be objects.


The #{{{ and #}}} stuff is very annoying to other programmers
(ok, to me...). You might want to investigate a Python aware
editor (like SPE, which has pychecker built in). This is
coming from someone who uses vim regularly.

[Dylan Moreland]

Re: general coding issues - coding style...


calmar wrote:[color=blue]
> On 2006-02-18, Diez B. Roggisch <deets@nospam.w eb.de> wrote:[color=green]
> > - why are these {{{ thingies there?[/color]
>
> markers for folding for vim
> http://www.calmar.ws/tmp/sc.png[/color]

I would look into one of the many Vim scripts which automatically fold
most large blocks without the ugly {{{.

[Justin Azoff]

Re: general coding issues - coding style...

Dylan Moreland wrote:[color=blue]
> I would look into one of the many Vim scripts which automatically fold
> most large blocks without the ugly {{{.[/color]

Who needs a script?
"set foldmethod=inde nt"
works pretty well for most python programs.

[calmar]

Re: general coding issues - coding style...

On 2006-02-18, Justin Azoff <justin.azoff@g mail.com> wrote:

Hi all,
[color=blue]
> Dylan Moreland wrote:[color=green]
>> I would look into one of the many Vim scripts which automatically fold
>> most large blocks without the ugly {{{.[/color]
>
> Who needs a script?
> "set foldmethod=inde nt"
> works pretty well for most python programs.
>[/color]

Well, foldmethod=mark er does not bother me, because the folds are
normally closed. With markers, it takes one line per function, with
indent I see 2, so I prefer markers.

...and since I can easily get rid of them, and add them again, I will at
least remove them before e.g. putting to the web or so.


Cheers and thanks,
calmar



--
calmar

(o_ It rocks: LINUX + Command-Line-Interface
//\
V_/_ http://www.calmar.ws

[calmar]

Re: general coding issues - coding style...

On 2006-02-18, plahey@alumni.c altech.edu <plahey@alumni. caltech.edu> wrote:

Hi,
[color=blue]
> 1585 if sys.path[0][-12:] == "\library.z ip": #for py2exe
> if sys.path[0].endswith( "\\library. zip" ):[/color]

cool, thx,
[color=blue]
> (did you really mean one back-slash there?)[/color]

(yeah, one backslash)
[color=blue]
> 499 tuple = os.path.split(f ilename)
> bad variable name... tuple(x) converts a sequence to a tuple.[/color]

I see, I changed that to
path, filen = os.path.split(f ilename)
[color=blue]
> You have a number of places where you check for len(x)==0:
> 674 if len(files) == 0:
> --> if not files:[/color]

I see. thx
[color=blue]
> you should run your code through pychecker (it had a lot to say...).[/color]

I see, cool tool that pychecker!
I can't do something against the 'not used variable' so probably?
(since pygtk just sends those items anyway)
[color=blue]
> You use global alot... that should be a red flag. Like the poster
> above mentioned, you have things that are telling you they want to
> be objects.[/color]

I will try to get some order (classes) and maybe remove them.

thanks a lot!!

cheers,
calmar

--
calmar

(o_ It rocks: LINUX + Command-Line-Interface
//\
V_/_ http://www.calmar.ws

[Bruno Desthuilliers]

Re: general coding issues - coding style...

calmar a écrit :[color=blue]
> Hi all,
>
> since I'm just a 'handicraft'/beginner or so,
>
> could anybody provide me with some (rough) hints, about how to enhance the code
> here:
>
> http://calmar.ws/tmp/cal.html[/color]

1/ learn OO and get rid of globals.
2/ use dict or list based dispatch instead of long if/elif/elif... clauses
3/ stdout is meant for *normal* program outputs. Errors and verbosity go
to stderr
4/ triple quoted strings are fine for multiline text
5/ os.path is fine for portable filepath operations
6/ things that dont change during program execution (ie : constants)
should not be defined inside a function


[color=blue]
> Cheers and thanks a lot
> calmar
>
>[/color]

[calmar]

Re: general coding issues - coding style...

On 2006-02-19, Bruno Desthuilliers <bdesth.quelque chose@free.quel quepart.fr> wrote:

Bonjour,
[color=blue]
>
> 1/ learn OO and get rid of globals.[/color]

Well I created two classes now. I put some things global (your point 6).
e.g. if it's on Windows or not, and other things.
[color=blue]
> 2/ use dict or list based dispatch instead of long if/elif/elif... clauses[/color]

when I find out what you mean, I will. Probably something lika a 'case'
thing? #python meant a list containing functions or so. So that the
values represent the functions to call, isn 'it?
[color=blue]
> 3/ stdout is meant for *normal* program outputs. Errors and verbosity go
> to stderr[/color]

yeah, changed (somebit)
[color=blue]
> 4/ triple quoted strings are fine for multiline text[/color]

yeah. I have lot of triple prints...
[color=blue]
> 5/ os.path is fine for portable filepath operations[/color]

I don't really understant what you mean here, sorry
[color=blue]
> 6/ things that dont change during program execution (ie : constants)
> should not be defined inside a function[/color]

As I mentioned above, these I placed globally:

main gtkwindows,
smwin or not,
pyexe or not,
preferred encoging

according to your statement?


Anyway, since I did lot of changes, I'm myself confused actually.

http://calmar.ws/tmp/cal.html

Will try to cleanup and implement even further all good
advices from all in some days.

Thanks a lot!!
calmar



--
calmar

(o_ It rocks: LINUX + Command-Line-Interface
//\
V_/_ http://www.calmar.ws

[JW]

Re: general coding issues - coding style...

About this line:
1585 if sys.path[0][-12:] == "\library.z ip": #for py2exe

pl... suggested:
if sys.path[0].endswith( "\\library. zip" ):

and said, "did you really mean one back-slash there?". You responded
"yeah, one backslash", but I still don't believe you. In this case, it
happens to work, but you should be aware that the back-slash is an
escape character, which causes the next character to be interpreted
differently. Try this in your interpreter:

print "\a" # System bell - might cause your speaker to beep
print "\t" # Tab character
print "\n" # Newline character / sequence

See http://www.python.org/doc/2.4.2/ref/strings.html for more details
on the escape sequences that Python recognizes. Here's a summary: if
the backslash + character is a special escape code, then replace it
with that, otherwise assume the programmer meant a real backslash.
That's dangerous, and will break when the name changes from one that
starts with an L to one that starts with an A, B, F, N, etc. The safe
way it to tell Python "Yes, I really want a backslash", which is
indicated with the double backslash:

print "\\library. zip"

If you don't use the double backslash, you'll eventually have a
problem, especially in Windows, which unfortunately uses the backslash
as a directory seperator. You might also want to look at os.sep and
the os.path.* functions, if you are interested in making your code work
on different platforms.

JW

[calmar]

Re: general coding issues - coding style...

On 2006-02-20, JW <John-Whitlock@ieee.o rg> wrote:

Hi JW,
[color=blue]
> About this line:
> 1585 if sys.path[0][-12:] == "\library.z ip": #for py2exe
>
> pl... suggested:
> if sys.path[0].endswith( "\\library. zip" ):
>
>
> print "\\library. zip"
>[/color]

Yeah, I have two backslashes, but thaks for pointing out.
[color=blue]
> If you don't use the double backslash, you'll eventually have a
> problem, especially in Windows, which unfortunately uses the backslash
> as a directory seperator. You might also want to look at os.sep and
> the os.path.* functions, if you are interested in making your code work
> on different platforms.[/color]

Yeah, I will use the os.sep variable, that's a good idea

thanks a lot,
calmar


--
calmar

(o_ It rocks: LINUX + Command-Line-Interface
//\
V_/_ http://www.calmar.ws