1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
|
# Copyright (c) 2002-2004 LOGILAB S.A. (Paris, FRANCE).
# http://www.logilab.fr/ -- mailto:contact@logilab.fr
#
# 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.
"""
generic classes/functions for pyreverse core/extensions
"""
import sys
import re
# why import IgnoreChild, Project ?
#from logilab.astng import ASTNGManager #, IgnoreChild, Project
#from logilab.astng.manager import astng_wrapper
from logilab.astng.manager import astng_wrapper, ASTNGManager
from logilab.common.configuration import ConfigurationMixIn
from pyreverse.__pkginfo__ import version
from pyreverse import config
def time_tag():
"""
return a timestamp as string
"""
from time import time, localtime, strftime
return strftime('%b %d at %T', localtime(time()))
def LOG(msg):
"""LOG doesn't do anything by default"""
pass
def info(msg):
"""print an informal message on stdout"""
LOG(msg)
# astng utilities #############################################################
SPECIAL = re.compile('^__[A-Za-z0-9]+[A-Za-z0-9_]*__$')
PRIVATE = re.compile('^__[_A-Za-z0-9]*[A-Za-z0-9]+_?$')
PROTECTED = re.compile('^_[_A-Za-z0-9]*$')
def get_visibility(name):
"""return the visibility from a name: public, protected, private or special
"""
if SPECIAL.match(name):
visibility = 'special'
elif PRIVATE.match(name):
visibility = 'private'
elif PROTECTED.match(name):
visibility = 'protected'
else:
visibility = 'public'
return visibility
ABSTRACT = re.compile('^.*Abstract.*')
FINAL = re.compile('^[A-Z_]*$')
def is_abstract(node):
"""return true if the given class node correspond to an abstract class
definition
"""
return ABSTRACT.match(node.name)
def is_final(node):
"""return true if the given class/function node correspond to final
definition
"""
return FINAL.match(node.name)
def is_interface(node):
# bw compat
return node.type == 'interface'
def is_exception(node):
# bw compat
return node.type == 'exception'
# Helpers #####################################################################
_CONSTRUCTOR = 1
_SPECIAL = 2
_PROTECTED = 4
_PRIVATE = 8
MODES = {
'ALL' : 0,
'PUB_ONLY' : _SPECIAL + _PROTECTED + _PRIVATE,
'SPECIAL' : _SPECIAL,
'OTHER' : _PROTECTED + _PRIVATE,
}
class FilterMixIn:
"""filter nodes according to a mode and nodes' visibility
"""
options = (
("filter-mode",
{'default': 'PUB_ONLY', 'dest' : 'mode',
'type' : 'string', 'action' : 'store', 'metavar' : '<mode>',
'help' : """filter attributes and functions according to
<mode>. Correct modes are :
'PUB_ONLY' filter all non public attributes
[DEFAULT], equivalent to PRIVATE+SPECIAL_A
'ALL' no filter
'SPECIAL' filter Python special functions
except constructor
'OTHER' filter protected and private
attributes"""}),
)
def __init__(self):
self.load_defaults()
def get_mode(self):
"""return the integer value of a mode string
"""
try:
return self.__mode
except AttributeError:
mode = 0
for nummod in self.config.mode.split('+'):
try:
mode += MODES[nummod]
except KeyError, ex:
print >> sys.stderr, 'Unknown filter mode %s' % ex
self.__mode = mode
return mode
def filter(self, node):
"""return true if the node should be treated
"""
mode = self.get_mode()
visibility = get_visibility(getattr(node, 'name', node))
if mode & _SPECIAL and visibility == 'special':
return 0
if mode & _PROTECTED and visibility == 'protected':
return 0
if mode & _PRIVATE and visibility == 'private':
return 0
return 1
class RunHelper(ConfigurationMixIn):
"""command line helper
"""
name = 'main'
options = (('quiet', {'help' : 'run quietly', 'action' : 'store_true',
'short': 'q'}), )
def __init__(self, usage, option_providers):
ConfigurationMixIn.__init__(self, """\
USAGE: %%prog [options] <file or module>...
%s""" % usage, version="%%prog %s" % version)
config.insert_default_options()
manager = ASTNGManager()
# FIXME: use an infinite cache
manager._cache = {}
# add options
self.register_options_provider(manager)
for provider in option_providers:
self.register_options_provider(provider)
#self.load_file_configuration()
args = self.load_command_line_configuration()
if not args:
print self.help()
else:
global LOG
LOG = self.log
# extract project representation
project = manager.project_from_files(args, astng_wrapper)
self.do_run(project)
def do_run(self, project):
"""method to override in concrete classes"""
raise NotImplementedError()
def log(self, msg):
"""print an informal message on stdout"""
if not self.config.quiet:
print '-'*80
print msg
|
