|
0
|
1 |
'\" te
|
|
|
2 |
.\"
|
|
11
|
3 |
.\" Copyright 2010 Sun Microsystems, Inc. All rights reserved.
|
|
0
|
4 |
.\" Use is subject to license terms.
|
|
|
5 |
.\"
|
|
11
|
6 |
.\" ident "@(#)logilab-common.3.sunman 1.2 10/03/16 SMI"
|
|
0
|
7 |
.\"
|
|
|
8 |
.TH logilab-common 3 "30 Apr 2009"
|
|
|
9 |
.SH NAME
|
|
|
10 |
logilab-common \- Common Modules used by Logilab projects
|
|
|
11 |
.SH DESCRIPTION
|
|
|
12 |
The
|
|
|
13 |
.I logilab-common
|
|
|
14 |
package contains some modules used by different Logilab
|
|
|
15 |
projects.
|
|
|
16 |
|
|
|
17 |
.LP
|
|
|
18 |
.SH Provided modules
|
|
|
19 |
.LP
|
|
|
20 |
|
|
|
21 |
A brief description of the available modules :
|
|
|
22 |
.LP
|
|
|
23 |
|
|
|
24 |
* adbh.py:
|
|
|
25 |
helper functions for using database advanced. Supported RDBMS
|
|
|
26 |
include PostgreSQL, MySQL and sqlite. See also db.py.
|
|
|
27 |
.LP
|
|
|
28 |
|
|
|
29 |
* astutils:
|
|
|
30 |
Deprecated module. Use logilab.astng.
|
|
|
31 |
.LP
|
|
|
32 |
|
|
|
33 |
* bind.py :
|
|
|
34 |
Deprecated module.
|
|
|
35 |
Provides a way to optimize globals in certain functions by binding
|
|
|
36 |
their names to values provided in a dictionnary.
|
|
|
37 |
.LP
|
|
|
38 |
|
|
|
39 |
* cache.py :
|
|
|
40 |
A cache implementation with a least recently used algorithm.
|
|
|
41 |
.LP
|
|
|
42 |
|
|
|
43 |
* clcommands.py:
|
|
|
44 |
helper functions for command line programs handling different
|
|
|
45 |
subcommands
|
|
|
46 |
.LP
|
|
|
47 |
|
|
|
48 |
* cli.py :
|
|
|
49 |
Command line interface helper classes (for interactive programs
|
|
|
50 |
using the command line)
|
|
|
51 |
.LP
|
|
|
52 |
|
|
|
53 |
* compat.py:
|
|
|
54 |
Transparent compatibility layer between different python version
|
|
|
55 |
.LP
|
|
|
56 |
|
|
|
57 |
* configuration.py :
|
|
|
58 |
Two mix-in classes to handle configuration from both command line
|
|
|
59 |
(using optik/optparse) and configuration file.
|
|
|
60 |
.LP
|
|
|
61 |
|
|
|
62 |
* corbautils.py:
|
|
|
63 |
Usefull functions for use with the OmniORB CORBA library.
|
|
|
64 |
.LP
|
|
|
65 |
|
|
|
66 |
* daemon.py :
|
|
|
67 |
A daemon mix-in class.
|
|
|
68 |
.LP
|
|
|
69 |
|
|
|
70 |
* date.py:
|
|
|
71 |
date manipulation helper functions
|
|
|
72 |
.LP
|
|
|
73 |
|
|
|
74 |
* db.py :
|
|
|
75 |
A generic method to get a database connection. See also adbh.py.
|
|
|
76 |
.LP
|
|
|
77 |
|
|
|
78 |
* debugger.py:
|
|
|
79 |
pdb customization
|
|
|
80 |
.LP
|
|
|
81 |
|
|
|
82 |
* decorators.py:
|
|
|
83 |
useful decorators (cached, timed...)
|
|
|
84 |
.LP
|
|
|
85 |
|
|
|
86 |
* deprecation.py:
|
|
|
87 |
mark functions / classes as deprecated or moved
|
|
|
88 |
.LP
|
|
|
89 |
|
|
|
90 |
* fileutils.py :
|
|
|
91 |
Some file / file path manipulation utilities.
|
|
|
92 |
.LP
|
|
|
93 |
|
|
|
94 |
* graph.py:
|
|
|
95 |
graph manipulations, dot file generation
|
|
|
96 |
.LP
|
|
|
97 |
|
|
|
98 |
* html.py :
|
|
|
99 |
Deprecated module
|
|
|
100 |
Return an html formatted traceback from python exception infos.
|
|
|
101 |
.LP
|
|
|
102 |
|
|
|
103 |
* interface.py
|
|
|
104 |
Bases class for interfaces.
|
|
|
105 |
.LP
|
|
|
106 |
|
|
|
107 |
* logger.py :
|
|
|
108 |
Deprecated module : use logging from stdlib.
|
|
|
109 |
Define a logger interface and two concrete loggers : one which prints
|
|
|
110 |
everything on stdout, the other using syslog.
|
|
|
111 |
.LP
|
|
|
112 |
|
|
|
113 |
* logging_ext.py:
|
|
|
114 |
extensions to stdlib's logging module
|
|
|
115 |
.LP
|
|
|
116 |
|
|
|
117 |
* logservice.py:
|
|
|
118 |
Deprecated module. Use logging from stdlib.
|
|
|
119 |
.LP
|
|
|
120 |
|
|
|
121 |
* modutils.py :
|
|
|
122 |
Module manipulation utilities.
|
|
|
123 |
.LP
|
|
|
124 |
|
|
|
125 |
* monclient.py:
|
|
|
126 |
Deprecated module
|
|
|
127 |
.LP
|
|
|
128 |
|
|
|
129 |
* monserver.py:
|
|
|
130 |
Deprecated module
|
|
|
131 |
.LP
|
|
|
132 |
|
|
|
133 |
* optik_ext :
|
|
|
134 |
Add an abstraction level to transparently import optik classes from
|
|
|
135 |
optparse (python >= 2.3) or the optik package. It also defines two
|
|
|
136 |
new option types (regexp, csv, color, date...)
|
|
|
137 |
.LP
|
|
|
138 |
|
|
|
139 |
* optparser.py:
|
|
|
140 |
extend optparse's OptionParser to support commands
|
|
|
141 |
.LP
|
|
|
142 |
|
|
|
143 |
* patricia.py :
|
|
|
144 |
A Python implementation of PATRICIA trie (Practical Algorithm to
|
|
|
145 |
Retrieve Information Coded in Alphanumeric).
|
|
|
146 |
.LP
|
|
|
147 |
|
|
|
148 |
* pdf_ext.py:
|
|
|
149 |
pdf and fdf file manipulations, with pdftk.
|
|
|
150 |
.LP
|
|
|
151 |
|
|
|
152 |
* pytest.py:
|
|
|
153 |
unittest runner. See testlib
|
|
|
154 |
.LP
|
|
|
155 |
|
|
|
156 |
* shellutils.py:
|
|
|
157 |
Some utilities to replace shell scripts with python scripts.
|
|
|
158 |
.LP
|
|
|
159 |
|
|
|
160 |
* sqlgen.py :
|
|
|
161 |
Helper class to generate SQL strings to use with python's DB-API.
|
|
|
162 |
.LP
|
|
|
163 |
|
|
|
164 |
* table.py:
|
|
|
165 |
manage tabular data (supports column and row names, sorting, grouping...
|
|
|
166 |
.LP
|
|
|
167 |
|
|
|
168 |
* testlib.py :
|
|
|
169 |
Generic tests execution methods.
|
|
|
170 |
.LP
|
|
|
171 |
|
|
|
172 |
* textutils.py:
|
|
|
173 |
Some text manipulation utilities (ansi colorization, line wrapping,
|
|
|
174 |
rest support...)
|
|
|
175 |
.LP
|
|
|
176 |
|
|
|
177 |
* tree.py :
|
|
|
178 |
Base class to represent tree structure, and some others to make it
|
|
|
179 |
works with the visitor implementation (see below).
|
|
|
180 |
.LP
|
|
|
181 |
|
|
|
182 |
* umessage.py:
|
|
|
183 |
unicode email support
|
|
|
184 |
.LP
|
|
|
185 |
|
|
|
186 |
* ureports:
|
|
|
187 |
Provides a way to create simple reports using python objects
|
|
|
188 |
without care of the final formatting. Some formatters text and html
|
|
|
189 |
are provided.
|
|
|
190 |
.LP
|
|
|
191 |
|
|
|
192 |
* vcgutils.py :
|
|
|
193 |
utilities functions to generate file readable with Georg Sander's vcg
|
|
|
194 |
(Visualization of Compiler Graphs).
|
|
|
195 |
.LP
|
|
|
196 |
|
|
|
197 |
* visitor.py :
|
|
|
198 |
A generic visitor pattern implementation.
|
|
|
199 |
.LP
|
|
|
200 |
|
|
|
201 |
* twisted_distutils.py
|
|
|
202 |
This module enables the installation of plugins.tml files using standard
|
|
|
203 |
distutils syntax. Note that you can use this to install files that
|
|
|
204 |
are not twisted plugins in any package directory of your application.
|
|
|
205 |
.LP
|
|
|
206 |
|
|
|
207 |
* xmlrpcutils.py:
|
|
|
208 |
Auth support for XML RPC
|
|
|
209 |
|
|
|
210 |
.LP
|
|
|
211 |
|
|
|
212 |
.SH FILES
|
|
|
213 |
.TP 2.2i
|
|
|
214 |
.B /usr/lib/python2.6/vendor-packages/logilab/common
|
|
|
215 |
shared object library files
|
|
|
216 |
|
|
|
217 |
.SH AUTHORS
|
|
|
218 |
Sylvain Thenault ([email protected])
|
|
|
219 |
|
|
|
220 |
.SH SUPPORT
|
|
|
221 |
[email protected]
|
|
|
222 |
|
|
|
223 |
.SH ATTRIBUTES
|
|
|
224 |
See
|
|
|
225 |
.BR attributes (5)
|
|
|
226 |
for descriptions of the following attributes:
|
|
|
227 |
.sp
|
|
|
228 |
.TS
|
|
|
229 |
box;
|
|
|
230 |
cbp-1 | cbp-1
|
|
|
231 |
l | l .
|
|
|
232 |
ATTRIBUTE TYPE ATTRIBUTE VALUE
|
|
|
233 |
=
|
|
11
|
234 |
Availability library/python-2/logilab-common
|
|
0
|
235 |
=
|
|
|
236 |
Interface Stability Uncommitted
|
|
|
237 |
.TE
|
|
|
238 |
.SH SEE ALSO
|
|
|
239 |
.IR logilab-astng (3),
|
|
|
240 |
.IR pylint (1)
|
|
|
241 |
.SH NOTES
|
|
|
242 |
Documentation for logilab-common is available on-line at http://www.logilab.org/project/logilab-common
|
|
|
243 |
|
|
|
244 |
Source for logilab-common is available on http://opensolaris.org.
|