def __init__(self, board, availableMap=None):
super(HTMLBoard, self).__init__(board)
if availableMap is None:
self._availableMap = AvailableMap(board)
else:
self._availableMap = availableMap
class HTMLBoard(Board):
"""The HTMLBoard class' main goal is to provide assistance during debugging.
Being able to see a visual representation of the combined Board and
AvailableMap makes it far easier to test new functionality and fix bugs.
"""
def __init__(self, board, availableMap=None):
super(HTMLBoard, self).__init__(board)
if availableMap is None:
self._availableMap = AvailableMap(board)
else:
self._availableMap = availableMap
def _createCell(self, value):
"""Creates and returns an HTML element using the supplied values.
value - Can be either a list() or a single string value.
"""
cellString = """<div class="cell">"""
replacement = dict(x1=' ', x2=' ', x3=' ', x4=' ',
x5=' ', x6=' ', x7=' ', x8=' ',
x9=' ')
if isinstance(value, ListType):
# A list of values indicates we are dealing with an AvailableMap
cellString += """<div class="insidecell">
<span>$x1</span>
<span>$x2</span>
<span>$x3</span>
</div>
<div class="insidecell">
<span>$x4</span>
<span>$x5</span>
<span>$x6</span>
</div>
<div class="insidecell">
<span>$x7</span>
<span>$x8</span>
<span>$x9</span>
</div>"""
template = Template(cellString)
for i in xrange(1, 10):
if str(i) in value:
replacement['x' + str(i)] = i
cellString = template.substitute(replacement)
else:
# Dealing with a regular Board so each cell only has a single value
cellString += """<div class="">
<span class="single">""" + value + """</span>
</div>"""
cellString += """</div>"""
return cellString
def getHTML(self, includeAvailableMap=True):
"""Returns a HTML string representation of a combined Board and
AvailableMap.
includeAvailableMap - If False, will only generate Board values
"""
htmlString = """<style type="text/css">
div.cell {
border-style: solid;
border-width: 1px;
float: left;
width: 60px;
height: 60px;
text-align: center;
color: black;
}
div.insidecell {
color: gray;
}
span.single {
font-size: 3em;
}
</style>"""
for y in xrange(self.getDimensions()):
for x in xrange(self.getDimensions()):
value = self.getPosition(x, y)
if value is Board.EMPTY_VALUE and includeAvailableMap:
value = self._availableMap.getPosition(x, y)
htmlString += self._createCell(value)
htmlString += """<div style="clear:both"></div>"""
return htmlString
def write(self, filename, includeAvailableMap=True, forceOverwrite=False):
"""Writes an HTML representation of a Board to the specified file.
filename - full path location of the file to be created.
includeAvailableMap - If False, will only generate Board values.
forceOverwrite - If the specified file already exists, will attempt to
overwrite it.
Returns True if the file was successfully written.
"""
if os.path.exists(filename) and not forceOverwrite:
return False
with open(filename, 'w') as file:
file.write(self.getHTML(includeAvailableMap))
return True
