mirror of
https://fuchsia.googlesource.com/third_party/github.com/pylint-dev/pylint
synced 2024-09-21 07:58:04 +00:00
3feb461aad
With this change, we moved away from depending on logilab-common, having in Pylint all the components that were used from logilab-common. The API should be considered an implementation detail and can change at some point in the future. Closes issue #621.
125 lines
4.1 KiB
Python
125 lines
4.1 KiB
Python
# copyright 2003-2015 LOGILAB S.A. (Paris, FRANCE), all rights reserved.
|
|
# contact http://www.logilab.fr/ -- mailto:contact@logilab.fr
|
|
#
|
|
# This file is part of pylint.
|
|
#
|
|
# pylint is free software: you can redistribute it and/or modify it under
|
|
# the terms of the GNU Lesser General Public License as published by the Free
|
|
# Software Foundation, either version 2.1 of the License, or (at your option) any
|
|
# later version.
|
|
#
|
|
# pylint 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 Lesser General Public License for more
|
|
# details.
|
|
#
|
|
# You should have received a copy of the GNU Lesser General Public License along
|
|
# with pylint. If not, see <http://www.gnu.org/licenses/>.
|
|
"""Universal report objects and some formatting drivers.
|
|
|
|
A way to create simple reports using python objects, primarily designed to be
|
|
formatted as text and html.
|
|
"""
|
|
import os
|
|
import sys
|
|
|
|
import six
|
|
|
|
|
|
# pylint: disable=method-hidden; Weird API in compute_content.
|
|
|
|
class BaseWriter(object):
|
|
"""base class for ureport writers"""
|
|
|
|
def format(self, layout, stream=None, encoding=None):
|
|
"""format and write the given layout into the stream object
|
|
|
|
unicode policy: unicode strings may be found in the layout;
|
|
try to call stream.write with it, but give it back encoded using
|
|
the given encoding if it fails
|
|
"""
|
|
if stream is None:
|
|
stream = sys.stdout
|
|
if not encoding:
|
|
encoding = getattr(stream, 'encoding', 'UTF-8')
|
|
self.encoding = encoding or 'UTF-8'
|
|
self.__compute_funcs = []
|
|
self.out = stream
|
|
self.begin_format()
|
|
layout.accept(self)
|
|
self.end_format()
|
|
|
|
def format_children(self, layout):
|
|
"""recurse on the layout children and call their accept method
|
|
(see the Visitor pattern)
|
|
"""
|
|
for child in getattr(layout, 'children', ()):
|
|
child.accept(self)
|
|
|
|
def writeln(self, string=u''):
|
|
"""write a line in the output buffer"""
|
|
self.write(string + os.linesep)
|
|
|
|
def write(self, string):
|
|
"""write a string in the output buffer"""
|
|
try:
|
|
self.out.write(string)
|
|
except UnicodeEncodeError:
|
|
self.out.write(string.encode(self.encoding))
|
|
|
|
def begin_format(self):
|
|
"""begin to format a layout"""
|
|
self.section = 0
|
|
|
|
def end_format(self):
|
|
"""finished to format a layout"""
|
|
|
|
def get_table_content(self, table):
|
|
"""trick to get table content without actually writing it
|
|
|
|
return an aligned list of lists containing table cells values as string
|
|
"""
|
|
result = [[]]
|
|
cols = table.cols
|
|
for cell in self.compute_content(table):
|
|
if cols == 0:
|
|
result.append([])
|
|
cols = table.cols
|
|
cols -= 1
|
|
result[-1].append(cell)
|
|
# fill missing cells
|
|
while len(result[-1]) < cols:
|
|
result[-1].append(u'')
|
|
return result
|
|
|
|
def compute_content(self, layout):
|
|
"""trick to compute the formatting of children layout before actually
|
|
writing it
|
|
|
|
return an iterator on strings (one for each child element)
|
|
"""
|
|
# use cells !
|
|
def write(data):
|
|
try:
|
|
stream.write(data)
|
|
except UnicodeEncodeError:
|
|
stream.write(data.encode(self.encoding))
|
|
def writeln(data=u''):
|
|
try:
|
|
stream.write(data + os.linesep)
|
|
except UnicodeEncodeError:
|
|
stream.write(data.encode(self.encoding) + os.linesep)
|
|
self.write = write
|
|
self.writeln = writeln
|
|
self.__compute_funcs.append((write, writeln))
|
|
for child in layout.children:
|
|
stream = six.StringIO()
|
|
child.accept(self)
|
|
yield stream.getvalue()
|
|
self.__compute_funcs.pop()
|
|
try:
|
|
self.write, self.writeln = self.__compute_funcs[-1]
|
|
except IndexError:
|
|
del self.write
|
|
del self.writeln
|