linkchecker/linkcheck/logger/dot.py
Bastian Kleineidam 06dcf13629 Updated copyright.
2010-11-05 12:27:29 +01:00

79 lines
3 KiB
Python

# -*- coding: iso-8859-1 -*-
# Copyright (C) 2005-2010 Bastian Kleineidam
#
# 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.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
"""
A DOT graph format logger. The specification has been taken from
http://www.graphviz.org/doc/info/lang.html
"""
from .graph import GraphLogger
class DOTLogger (GraphLogger):
"""
Generates .dot sitemap graphs. Use graphviz to see the sitemap graph.
"""
def start_output (self):
"""Write start of checking info as DOT comment."""
super(DOTLogger, self).start_output()
if self.has_part("intro"):
self.write_intro()
self.writeln()
self.writeln(u"digraph G {")
self.writeln(u" graph [")
self.writeln(u" charset=\"%s\"," % self.output_encoding)
self.writeln(u" ];")
self.flush()
def comment (self, s, **args):
"""Write DOT comment."""
self.write(u"// ")
self.writeln(s=s, **args)
def log_url (self, url_data):
"""Write one node."""
node = self.get_node(url_data)
if node is not None:
self.writeln(u' "%s" [' % dotquote(node["label"]))
if self.has_part("realurl"):
self.writeln(u' href="%s",' % dotquote(node["url"]))
if node["dltime"] >= 0 and self.has_part("dltime"):
self.writeln(u" dltime=%d," % node["dltime"])
if node["dlsize"] >= 0 and self.has_part("dlsize"):
self.writeln(u" dlsize=%d," % node["dlsize"])
if node["checktime"] and self.has_part("checktime"):
self.writeln(u" checktime=%d," % node["checktime"])
if self.has_part("extern"):
self.writeln(u" extern=%d," % node["extern"])
self.writeln(u" ];")
def write_edge (self, node):
"""Write edge from parent to node."""
source = dotquote(self.nodes[node["parent_url"]]["label"])
target = dotquote(node["label"])
self.writeln(u' "%s" -> "%s" [' % (source, target))
self.writeln(u' label="%s",' % dotquote(node["edge"]))
if self.has_part("result"):
self.writeln(u" valid=%d," % node["valid"])
self.writeln(u" ];")
def end_graph (self):
"""Write end of graph marker."""
self.writeln(u"}")
def dotquote (s):
return s.replace('"', '\\"')