🌐 Mailman 3 December 2003 - Python-list - python.org

Standard way of documenting python code ?
by Rony Dec. 1, 2003

Dec. 1, 2003

A question on python source documentation. Does there exist a standard for documenting code ? I've included here an example generated by pydoc of one of my modules. Is this the right way or is it overkill ? Comments are appreciated Thanks, Rony Help on module sqlquery: NAME sqlquery FILE m:\plymouth\sqlquery.py DESCRIPTION ######################################################################### # Module : sqlquery.py # Abstract : General, simple, SQL class # Contains some simple classes # connection(connectstring): connect to db and define cursor # cmd(command,logflag=None) : execute sql-command # selcmd(dict,logflag=None) : execute select statement # inscmd(dict,logflag=None) : execute insert statement # Dependancies : mylibs.sqlerreur.py # mylibs.string_man.py ######################################################################### CLASSES connection class connection | Connection to odbc source defined in connecstring | Public methods : | - close : close connection | - cmd : execute cmd and return result set | | Methods defined here: | | __init__(self, connectstring) | Create db connection from connectstring | Connect string must have the format 'odbc-source/user' | Will create cursor called self.cursor | | close(self) | Close database connection | | cmd(self, command, logresult=None) | Execute a SQL-statement, returns the resultset als list | if logresult != None then write result in log.txt | | inscmd(self, dict, logresult=None) | Execute a INSERT command. | The command is constructed out of a dictionary (dict) | The dict should contain : | "tocols" : list of destination cols as a string | "tables" : table where to insert as a string | "values" : list of values to insert as a string | Ex : | {'tocols':'AC_ID,AC_NOM', | 'table':'TBL_ACHETEUR', | 'values':'1,'+quote('RONY')} | will create : INSERT INTO TBL_ACHETEUR (AC_ID,AC_NOM) | VALUES(1,'RONY) | If logresult != None then write result in log.txt | Returns nothing | | selcmd(self, dict, logresult=None) | Execute a SELECT command. | The command is constructed out of a dictionary (dict) | The dict should contain : | "cols" : list of cols as a string | "tables" : list of tables as a string | "order" : list of orders as a string | Ex : | {'cols':'AC_ID,AC_NOM', | 'tables':'TBL_ACHETEUR', | 'order':'AC_ID'} | will create : SELECT AC_ID,AC_NOM FROM TBL_ACHETEUR | ORDER BY AC_ID | If logresult != None then write result in log.txt | Returns self.result DATA achtdict = {'cols': 'AC_ID,AC_NOM', 'order': 'AC_NOM', 'tables': 'TBL_... connectstring = 'plymouth/sa/' insachdict = {'tables': 'TBL_TMP', 'tocols': 'TP_ID,TP_NOM', 'values':... -- Rony /_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/ / bucodi(a)yahoo.fr / | www.bucodi.com - My work \ www.ifrance/karamusique -- My hobby \_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/

2 2

Re: Implementing Iterators in, e.g., Linked Lists
by Rainer Deyke Dec. 1, 2003

Dec. 1, 2003

adeleinandjeremy wrote: > AFAIU, in my LinkedList class, I can either have the LinkedList be its > own iterator by making its __iter__() method return self and defining > a next() method, or I can have a separate iterator called from > LinkedList's __iter__(). My view is that it would be best to have the > LinkedList be its own iterator - is that the case? Or is an external > iterator preferable in this case? External iterators are always preferable for two reasons. 1. They allow multiple iterators over the same collection. 2. They keep the interface of the base object clean by separating other functionality. -- Rainer Deyke - rainerd(a)eldwood.com - http://eldwood.com

1 0

I just want to say that python is a COOL language
by Posadas, Dennis Dec. 1, 2003

Dec. 1, 2003

Complete Object Oriented Language. COOL ! After years of not doing any programming, I've fallen in love w/programming again. Dennis

1 0

Re: Ques From CS Grad Student
by Peter Hansen Dec. 1, 2003

Dec. 1, 2003

suenacita1 wrote: > > Hi. I'm a masters student at the George Washington University > currently taking an Open Source Software Development course. One of > our assignments was to do a presentation on an open source project > and i chose Python. I have most of my presentation done but had a > couple questions where I want the help of the Python community to > help me answer. > > 1. How many members are involved directly, and how many peripherally? > 2. What do you use to drive releases? > 3. How often does the project release major and minor revisions? > 4. What tools do they use to manage the source? > 5. How does the Python project resolve conflicts between members? I'm sorry to say it, but the fact that you haven't got an answer to question 3, at least, hints strongly that you've made very little effort at all to research this on your own! Go to www.python.org and spend a few minutes in surfing and thought and you'll at least answer that one question on your own. I suspect several of the other questions would be almost as easily answered, perhaps with reference to the list archives. And some of the questions are next to useless, and appear to be repeated verbatim from some generic questionnaire that everyone in the course is expected to use. "Drive releases"? What is that supposed to mean? The text editor used? The revision control system? The process? What type of car they used to get to the sprints? :-) -Peter

5 6

SF bug / patch / RFE tracker search?
by jjl＠pobox.com Dec. 1, 2003

Dec. 1, 2003

I know about the script here (append a number to the URL and it'll take you to the tracker item regardless of whether it's a bug, a patch, or an RFE): http://www.python.org/sf/ but is there something similar that *searches* the database across all three categories (preferably with AND as the default operator instead of the silly OR that the SF tracker search box uses)? John

2 1

Using and Implementing iterators with classes such as linked lists
by Adelein and Jeremy Dec. 1, 2003

Dec. 1, 2003

I am taking a second programming course in Java and am currently attempting to apply what I have learned using Python instead. One thing that is puzzling me is how to use an iterator. I am writing a module containing everything I'd need for canonical linked lists. One particularly useful feature would be to use a for loop over the whole structure. For this I have learned the benefits of iterators. I have read a few book entries on Python iterators, as well as an online article by David Mertz, I believe, and PEP 234, and I may be lacking some insight but I am still confused about one thing. How does the iteration know where to begin? AFAIU, in my LinkedList class, I can either have the LinkedList be its own iterator by making its __iter__() method return self and defining a next() method, or I can have a separate iterator called from LinkedList's __iter__(). My view is that it would be best to have the LinkedList be its own iterator - is that the case? Or is an external iterator preferable in this case? My problem with implementing the former comes with this: in LinkedList I would have: ... def __init__(self): return self ... def next(self): if self.__current.next == None: raise StopIteration self.__current = self.__current.next return self.__current.next ... Now, is this good in the eyes of more experienced programmers? Also, do I really want to dedicate an instance variable to keep track of where to begin iteration (if __current is used for other purposes, iteration could conceivably begin anywhere right?)? Does this suggest that I should have a separate LinkedListIterator class? And if I do have that separate class, do I make the LinkedList.__iter__() pass on to LinkedListIterator's constructor the head node of LinkedList, or the whole linked list? Thanks in advance, Jeremy __________________________________ Do you Yahoo!? Free Pop-Up Blocker - Get it now http://companion.yahoo.com/

1 0

Bug in glob.glob for files w/o extentions in Windows
by Georgy Pruss Dec. 1, 2003

Dec. 1, 2003

On Windows XP glob.glob doesn't work properly for files without extensions. E.g. C:\Temp contains 4 files: 2 with extensions, 2 without. C:\Temp>dir /b * aaaaa.aaa bbbbb.bbb ccccc ddddd C:\Temp>dir /b *. ccccc ddddd C:\Temp>python Python 2.3 (#46, Jul 29 2003, 18:54:32) [MSC v.1200 32 bit (Intel)] on win32 Type "help", "copyright", "credits" or "license" for more information. >>> import glob >>> glob.glob( '*' ) ['aaaaa.aaa', 'bbbbb.bbb', 'ccccc', 'ddddd'] >>> glob.glob( '*.' ) [] It looks like a bug. Georgy -- Georgy Pruss E-mail: 'ZDAwMTEyMHQwMzMwQGhvdG1haWwuY29t\n'.decode('base64')

10 15

RE: Need some advice
by Robert Brewer Dec. 1, 2003

Dec. 1, 2003

Jeff Wagner wrote: > Are functions in Python another name for subroutines? No, "subroutine" in other languages is another name for "function" in Python. :) You might say Functions in VB are Subs which return values. Functions in Python are _both_; you don't have to declare a return value if you don't want to, in which case your function will return the value None. >>> def noval(): ... pass ... >>> noval() >>> noval() is None True Robert Brewer MIS Amor Ministries fumanchu(a)amor.org

1 0

Implementing Iterators in, e.g., Linked Lists
by adeleinandjeremy Dec. 1, 2003

Dec. 1, 2003

I am taking a second programming course in Java and am currently attempting to apply what I have learned using Python instead. One thing that is puzzling me is how to use an iterator. I am writing a module containing everything I'd need for canonical linked lists. One particularly useful feature would be to use a for loop over the whole structure. For this I have learned the benefits of iterators. I have read a few book entries on Python iterators, as well as an online article by David Mertz, I believe, and PEP 234, and I may be lacking some insight but I am still confused about one thing. How does the iteration know where to begin? AFAIU, in my LinkedList class, I can either have the LinkedList be its own iterator by making its __iter__() method return self and defining a next() method, or I can have a separate iterator called from LinkedList's __iter__(). My view is that it would be best to have the LinkedList be its own iterator - is that the case? Or is an external iterator preferable in this case? My problem with implementing the former comes with this: in LinkedList I would have: ... def __init__(self): return self ... def next(self): if self.__current.next == None: raise StopIteration self.__current = self.__current.next return self.__current.next ... Now, is this good in the eyes of more experienced programmers? Also, do I really want to dedicate an instance variable to keep track of where to begin iteration (if __current is used for other purposes, iteration could conceivably begin anywhere right?)? Does this suggest that I should have a separate LinkedListIterator class? And if I do have that separate class, do I make the LinkedList.__iter__() pass on to LinkedListIterator's constructor the head node of LinkedList, or the whole linked list? Thanks in advance, Jeremy

1 0

Python and Zope Jobs Yahoo Group
by Kandidates.com Dec. 1, 2003

Dec. 1, 2003

Python and Zope Jobs Yahoo Group http://groups.yahoo.com/group/pythonzopejobs

1 0