cms/source/TemplateModule.py

#
# i-scream central monitoring system
# http://www.i-scream.org
# Copyright (C) 2000-2003 i-scream
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
#

"""Module one line description...
<detail>...

"""

# $Id: TemplateModule.py,v 1.5 2003/11/19 00:09:09 ajm Exp $
# $Source: /cvs/i-scream/cms/source/TemplateModule.py,v $ 
__version__ = "$Revision: 1.5 $"

#---IMPORTS---

#---MODULE CONSTANTS---

#---EXCEPTIONS---

#---CLASSES---

#<CLASS>
class TemplateClass:
    """Class one line description...
    <detail>
    """

#---CLASS CONSTANTS---

#---CONSTRUCTORS---
    
    def __init__(self):
        pass

#---PUBLIC METHODS---

#---PRIVATE METHODS---

#---ACCESSOR/MUTATOR METHODS---

#---PRIVATE ATTRIBUTES---

#</CLASS>

#---MODULE METHODS---

#---MODULE INSTANTIATION/TESTING---

def main():
    """Main one line description...
    <detail> 
    """
    pass

if __name__ == "__main__":
    main()
Revision:	1.6
Committed:	Thu Nov 20 13:07:31 2003 UTC (20 years, 11 months ago) by ajm
Content type:	text/x-python
Branch:	MAIN
Changes since 1.5:	+10 -6 lines
Log Message:	differentiated between class and module constants. added section for module exceptions. removed module attributes - baaaa'd. explicitly stated that class attributes should be private.
#	User	Rev	Content
1	ajm	1.1	#
2			# i-scream central monitoring system
3			# http://www.i-scream.org
4			# Copyright (C) 2000-2003 i-scream
5			#
6			# This program is free software; you can redistribute it and/or
7			# modify it under the terms of the GNU General Public License
8			# as published by the Free Software Foundation; either version 2
9			# of the License, or (at your option) any later version.
10			#
11			# This program is distributed in the hope that it will be useful,
12			# but WITHOUT ANY WARRANTY; without even the implied warranty of
13			# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14			# GNU General Public License for more details.
15			#
16			# You should have received a copy of the GNU General Public License
17			# along with this program; if not, write to the Free Software
18			# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19	ajm	1.2	#
20	ajm	1.1
21			"""Module one line description...
22			<detail>...
23
24			"""
25
26	ajm	1.6	# $Id: TemplateModule.py,v 1.5 2003/11/19 00:09:09 ajm Exp $
27	ajm	1.2	# $Source: /cvs/i-scream/cms/source/TemplateModule.py,v $
28	ajm	1.6	__version__ = "$Revision: 1.5 $"
29	ajm	1.1
30			#---IMPORTS---
31
32	ajm	1.6	#---MODULE CONSTANTS---
33
34			#---EXCEPTIONS---
35
36			#---CLASSES---
37	ajm	1.1
38			#<CLASS>
39			class TemplateClass:
40			"""Class one line description...
41			<detail>
42			"""
43
44	ajm	1.6	#---CLASS CONSTANTS---
45
46	ajm	1.1	#---CONSTRUCTORS---
47
48	tdb	1.3	def __init__(self):
49	ajm	1.1	pass
50
51			#---PUBLIC METHODS---
52
53			#---PRIVATE METHODS---
54
55			#---ACCESSOR/MUTATOR METHODS---
56
57	ajm	1.6	#---PRIVATE ATTRIBUTES---
58	ajm	1.1
59			#</CLASS>
60
61			#---MODULE METHODS---
62
63			#---MODULE INSTANTIATION/TESTING---
64
65	tdb	1.3	def main():
66	ajm	1.1	"""Main one line description...
67			<detail>
68			"""
69			pass
70
71			if __name__ == "__main__":
72			main()