[OpenSPARC-T2-DV] / tools / src / nas,5.n2.os.2 / lib / python / html / python / lib / pyclbr-class-objects.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<link rel="STYLESHEET" href="lib.css" type='text/css' />
<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
<link rel='start' href='../index.html' title='Python Documentation Index' />
<link rel="first" href="lib.html" title='Python Library Reference' />
<link rel='contents' href='contents.html' title="Contents" />
<link rel='index' href='genindex.html' title='Index' />
<link rel='last' href='about.html' title='About this document...' />
<link rel='help' href='about.html' title='About this document...' />
<link rel="next" href="pyclbr-function-objects.html" />
<link rel="prev" href="module-pyclbr.html" />
<link rel="parent" href="module-pyclbr.html" />
<link rel="next" href="pyclbr-function-objects.html" />
<meta name='aesop' content='information' />
<title>18.7.1 Class Descriptor Objects </title>
</head>
<body>
<DIV CLASS="navigation">
<div id='top-navigation-panel' xml:id='top-navigation-panel'>
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="18.7 pyclbr  "
  href="module-pyclbr.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></A></td>
<td class='online-navigation'><a rel="parent" title="18.7 pyclbr  "
  href="module-pyclbr.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="18.7.2 Function Descriptor Objects"
  href="pyclbr-function-objects.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></A></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></A></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="module-pyclbr.html">18.7 pyclbr  </A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module-pyclbr.html">18.7 pyclbr  </A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="pyclbr-function-objects.html">18.7.2 Function Descriptor Objects</A>
</div>
<hr /></div>
</DIV>
<!--End of Navigation Panel-->

<H2><A NAME="SECTION0020710000000000000000"></A><A NAME="pyclbr-class-objects"></A>
<BR>
18.7.1 Class Descriptor Objects 
</H2>

<P>
The class descriptor objects used as values in the dictionary returned
by <tt class="function">readmodule()</tt> and <tt class="function">readmodule_ex()</tt>
provide the following data members:

<P>
<dl><dt><b><tt id='l2h-4982' xml:id='l2h-4982' class="member">module</tt></b></dt>
<dd>
  The name of the module defining the class described by the class
  descriptor.
</dl>

<P>
<dl><dt><b><tt id='l2h-4983' xml:id='l2h-4983' class="member">name</tt></b></dt>
<dd>
  The name of the class.
</dl>

<P>
<dl><dt><b><tt id='l2h-4984' xml:id='l2h-4984' class="member">super</tt></b></dt>
<dd>
  A list of class descriptors which describe the immediate base
  classes of the class being described.  Classes which are named as
  superclasses but which are not discoverable by
  <tt class="function">readmodule()</tt> are listed as a string with the class name
  instead of class descriptors.
</dl>

<P>
<dl><dt><b><tt id='l2h-4985' xml:id='l2h-4985' class="member">methods</tt></b></dt>
<dd>
  A dictionary mapping method names to line numbers.
</dl>

<P>
<dl><dt><b><tt id='l2h-4986' xml:id='l2h-4986' class="member">file</tt></b></dt>
<dd>
  Name of the file containing the <code>class</code> statement defining the class.
</dl>

<P>
<dl><dt><b><tt id='l2h-4987' xml:id='l2h-4987' class="member">lineno</tt></b></dt>
<dd>
  The line number of the <code>class</code> statement within the file named by
  <tt class="member">file</tt>.
</dl>

<P>

<DIV CLASS="navigation">
<div class='online-navigation'>
<p></p><hr />
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="18.7 pyclbr  "
  href="module-pyclbr.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></A></td>
<td class='online-navigation'><a rel="parent" title="18.7 pyclbr  "
  href="module-pyclbr.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="18.7.2 Function Descriptor Objects"
  href="pyclbr-function-objects.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></A></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></A></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="module-pyclbr.html">18.7 pyclbr  </A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module-pyclbr.html">18.7 pyclbr  </A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="pyclbr-function-objects.html">18.7.2 Function Descriptor Objects</A>
</div>
</div>
<hr />
<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
</DIV>
<!--End of Navigation Panel-->
<ADDRESS>
See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
</ADDRESS>
</BODY>
</HTML>
Commit	Line	Data
86530b38 AT	1	<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
	2	<html>
	3	<head>
	4	<link rel="STYLESHEET" href="lib.css" type='text/css' />
	5	<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
	6	<link rel='start' href='../index.html' title='Python Documentation Index' />
	7	<link rel="first" href="lib.html" title='Python Library Reference' />
	8	<link rel='contents' href='contents.html' title="Contents" />
	9	<link rel='index' href='genindex.html' title='Index' />
	10	<link rel='last' href='about.html' title='About this document...' />
	11	<link rel='help' href='about.html' title='About this document...' />
	12	<link rel="next" href="pyclbr-function-objects.html" />
	13	<link rel="prev" href="module-pyclbr.html" />
	14	<link rel="parent" href="module-pyclbr.html" />
	15	<link rel="next" href="pyclbr-function-objects.html" />
	16	<meta name='aesop' content='information' />
	17	<title>18.7.1 Class Descriptor Objects </title>
	18	</head>
	19	<body>
	20	<DIV CLASS="navigation">
	21	<div id='top-navigation-panel' xml:id='top-navigation-panel'>
	22	<table align="center" width="100%" cellpadding="0" cellspacing="2">
	23	<tr>
	24	<td class='online-navigation'><a rel="prev" title="18.7 pyclbr "
	25	href="module-pyclbr.html"><img src='../icons/previous.png'
	26	border='0' height='32' alt='Previous Page' width='32' /></A></td>
	27	<td class='online-navigation'><a rel="parent" title="18.7 pyclbr "
	28	href="module-pyclbr.html"><img src='../icons/up.png'
	29	border='0' height='32' alt='Up One Level' width='32' /></A></td>
	30	<td class='online-navigation'><a rel="next" title="18.7.2 Function Descriptor Objects"
	31	href="pyclbr-function-objects.html"><img src='../icons/next.png'
	32	border='0' height='32' alt='Next Page' width='32' /></A></td>
	33	<td align="center" width="100%">Python Library Reference</td>
	34	<td class='online-navigation'><a rel="contents" title="Table of Contents"
	35	href="contents.html"><img src='../icons/contents.png'
	36	border='0' height='32' alt='Contents' width='32' /></A></td>
	37	<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
	38	border='0' height='32' alt='Module Index' width='32' /></a></td>
	39	<td class='online-navigation'><a rel="index" title="Index"
	40	href="genindex.html"><img src='../icons/index.png'
	41	border='0' height='32' alt='Index' width='32' /></A></td>
	42	</tr></table>
	43	<div class='online-navigation'>
	44	<b class="navlabel">Previous:</b>
	45	<a class="sectref" rel="prev" href="module-pyclbr.html">18.7 pyclbr </A>
	46	<b class="navlabel">Up:</b>
	47	<a class="sectref" rel="parent" href="module-pyclbr.html">18.7 pyclbr </A>
	48	<b class="navlabel">Next:</b>
	49	<a class="sectref" rel="next" href="pyclbr-function-objects.html">18.7.2 Function Descriptor Objects</A>
	50	</div>
	51	<hr /></div>
	52	</DIV>
	53	<!--End of Navigation Panel-->
	54
	55	<H2><A NAME="SECTION0020710000000000000000"></A><A NAME="pyclbr-class-objects"></A>
	56	<BR>
	57	18.7.1 Class Descriptor Objects
	58	</H2>
	59
	60	<P>
	61	The class descriptor objects used as values in the dictionary returned
	62	by <tt class="function">readmodule()</tt> and <tt class="function">readmodule_ex()</tt>
	63	provide the following data members:
	64
65	<P>
66	<dl><dt><b><tt id='l2h-4982' xml:id='l2h-4982' class="member">module</tt></b></dt>
67	<dd>
68	The name of the module defining the class described by the class
69	descriptor.
70	</dl>
71
72	<P>
73	<dl><dt><b><tt id='l2h-4983' xml:id='l2h-4983' class="member">name</tt></b></dt>
74	<dd>
75	The name of the class.
76	</dl>
77
78	<P>
79	<dl><dt><b><tt id='l2h-4984' xml:id='l2h-4984' class="member">super</tt></b></dt>
80	<dd>
81	A list of class descriptors which describe the immediate base
82	classes of the class being described. Classes which are named as
83	superclasses but which are not discoverable by
84	<tt class="function">readmodule()</tt> are listed as a string with the class name
85	instead of class descriptors.
86	</dl>
87
88	<P>
89	<dl><dt><b><tt id='l2h-4985' xml:id='l2h-4985' class="member">methods</tt></b></dt>
90	<dd>
91	A dictionary mapping method names to line numbers.
92	</dl>
93
94	<P>
95	<dl><dt><b><tt id='l2h-4986' xml:id='l2h-4986' class="member">file</tt></b></dt>
96	<dd>
97	Name of the file containing the <code>class</code> statement defining the class.
98	</dl>
99
100	<P>
101	<dl><dt><b><tt id='l2h-4987' xml:id='l2h-4987' class="member">lineno</tt></b></dt>
102	<dd>
103	The line number of the <code>class</code> statement within the file named by
104	<tt class="member">file</tt>.
105	</dl>
106
107	<P>
108
109	<DIV CLASS="navigation">
110	<div class='online-navigation'>
111	<p></p><hr />
112	<table align="center" width="100%" cellpadding="0" cellspacing="2">
113	<tr>
114	<td class='online-navigation'><a rel="prev" title="18.7 pyclbr "
115	href="module-pyclbr.html"><img src='../icons/previous.png'
116	border='0' height='32' alt='Previous Page' width='32' /></A></td>
117	<td class='online-navigation'><a rel="parent" title="18.7 pyclbr "
118	href="module-pyclbr.html"><img src='../icons/up.png'
119	border='0' height='32' alt='Up One Level' width='32' /></A></td>
120	<td class='online-navigation'><a rel="next" title="18.7.2 Function Descriptor Objects"
121	href="pyclbr-function-objects.html"><img src='../icons/next.png'
122	border='0' height='32' alt='Next Page' width='32' /></A></td>
123	<td align="center" width="100%">Python Library Reference</td>
124	<td class='online-navigation'><a rel="contents" title="Table of Contents"
125	href="contents.html"><img src='../icons/contents.png'
126	border='0' height='32' alt='Contents' width='32' /></A></td>
127	<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
128	border='0' height='32' alt='Module Index' width='32' /></a></td>
129	<td class='online-navigation'><a rel="index" title="Index"
130	href="genindex.html"><img src='../icons/index.png'
131	border='0' height='32' alt='Index' width='32' /></A></td>
132	</tr></table>
133	<div class='online-navigation'>
134	<b class="navlabel">Previous:</b>
135	<a class="sectref" rel="prev" href="module-pyclbr.html">18.7 pyclbr </A>
136	<b class="navlabel">Up:</b>
137	<a class="sectref" rel="parent" href="module-pyclbr.html">18.7 pyclbr </A>
138	<b class="navlabel">Next:</b>
139	<a class="sectref" rel="next" href="pyclbr-function-objects.html">18.7.2 Function Descriptor Objects</A>
140	</div>
141	</div>
142	<hr />
143	<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
144	</DIV>
145	<!--End of Navigation Panel-->
146	<ADDRESS>
147	See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
148	</ADDRESS>
149	</BODY>
150	</HTML>