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