templates
/
KiBot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Better unicode support across all output formats

This commit is contained in:
Oliver Walters 2016-05-16 13:44:42 +10:00
parent 72231d8785
commit f0985b2623
5 changed files with 85 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
KiBOM/columns.py
View File

@ -12,6 +12,14 @@ class ColumnList:
#default columns for groups
COL_GRP_QUANTITY = 'Quantity'
COL_GRP_TOTAL_COST = 'Total Cost' #Total cost based on quantity
COL_GRP_BUILD_QUANTITY = 'Build Quantity'
#generated columns
_COLUMNS_GEN = [
COL_GRP_QUANTITY,
COL_GRP_BUILD_QUANTITY,
]
#default columns
_COLUMNS_DEFAULT = [
@ -23,6 +31,7 @@ class ColumnList:
COL_FP,
COL_FP_LIB,
COL_GRP_QUANTITY,
COL_GRP_BUILD_QUANTITY,
COL_DATASHEET
]
@ -71,7 +80,7 @@ class ColumnList:
def RemoveColumnByName(self, name):
#first check if this is in an immutable colum
if name in self._COLUMNS_DEFAULT:
if name in self._COLUMNS_PROTECTED:
return
#column does not exist, return

20
KiBOM/component.py
View File

@ -255,9 +255,12 @@ class ComponentGroup():
#update 'global' fields
self.fields[ColumnList.COL_REFERENCE] = self.getRefs()
q = self.getCount()
self.fields[ColumnList.COL_GRP_QUANTITY] = "{n}{dnf}".format(
n = self.getCount(),
n=q,
dnf = " (DNF)" if not self.isFitted() else "")
self.fields[ColumnList.COL_GRP_BUILD_QUANTITY] = str(q * self.prefs.buildNumber) if self.isFitted() else "0"
self.fields[ColumnList.COL_VALUE] = self.components[0].getValue()
self.fields[ColumnList.COL_PART] = self.components[0].getPartName()
self.fields[ColumnList.COL_PART_LIB] = self.components[0].getLibName()
@ -303,7 +306,18 @@ class ComponentGroup():
#return a dict of the KiCAD data based on the supplied columns
#NOW WITH UNICODE SUPPORT!
def getRow(self, columns):
row = [self.getField(key) for key in columns]
#print(row)
row = []
for key in columns:
val = self.getField(key)
if val is None:
val = ""
else:
val = u'' + val
val = val.encode('utf-8')
row.append(val)
return row

19
KiBOM/csv_writer.py
View File

@ -1,3 +1,5 @@
# _*_ coding:latin-1 _*_
import csv
import columns
from component import *
@ -25,6 +27,11 @@ def WriteCSV(filename, groups, net, headings, prefs):
else:
return False
nGroups = len(groups)
nTotal = sum([g.getCount() for g in groups])
nFitted = sum([g.getCount() for g in groups if g.isFitted()])
nBuild = nFitted * prefs.buildNumber
with open(filename, "w") as f:
writer = csv.writer(f, delimiter=delimiter, lineterminator="\n")
@ -43,8 +50,10 @@ def WriteCSV(filename, groups, net, headings, prefs):
row = group.getRow(headings)
if prefs.numberRows:
row = [rowCount] + row
row = [str(rowCount)] + row
#deal with unicode characters
#row = [el.decode('latin-1') for el in row]
writer.writerow(row)
try:
@ -58,8 +67,12 @@ def WriteCSV(filename, groups, net, headings, prefs):
for i in range(5):
writer.writerow([])
writer.writerow(["Component Count:",sum([g.getCount() for g in groups])])
writer.writerow(["Component Groups:",len(groups)])
writer.writerow(["Component Groups:",nGroups])
writer.writerow(["Component Count:",nTotal])
writer.writerow(["Fitted Components:", nFitted])
if prefs.buildNumber > 0:
writer.writerow(["Number of PCBs:",prefs.buildNumber])
writer.writerow(["Total components:", nBuild])
writer.writerow(["Schematic Version:",net.getVersion()])
writer.writerow(["Schematic Date:",net.getSheetDate()])
writer.writerow(["BoM Date:",net.getDate()])

23
KiBOM/html_writer.py
View File

@ -10,7 +10,7 @@ BG_USER = "#E6F9FF"
#return a background color for a given column title
def bgColor(col):
#auto-generated columns
if col == ColumnList.COL_GRP_QUANTITY:
if col in ColumnList._COLUMNS_GEN:
return BG_GEN
#kicad protected columns
elif col in ColumnList._COLUMNS_PROTECTED:
@ -20,7 +20,7 @@ def bgColor(col):
return BG_USER
def link(text):
text = u''.join((text)).encode('utf-8').strip()
for t in ["http","https","ftp","www"]:
if text.startswith(t):
return '<a href="{t}">{t}</a>'.format(t=text)
@ -42,12 +42,21 @@ def WriteHTML(filename, groups, net, headings, prefs):
print("{fn} is not a valid html file".format(fn=filename))
return False
nGroups = len(groups)
nTotal = sum([g.getCount() for g in groups])
nFitted = sum([g.getCount() for g in groups if g.isFitted()])
nBuild = nFitted * prefs.buildNumber
with open(filename,"w") as html:
#header
html.write("<html>\n")
html.write("<head>\n")
html.write('\t<meta charset="ISO-8859-1">\n') #UTF-8 encoding for unicode support
html.write("</head>\n")
html.write("<body>\n")
#PCB info
html.write("<h2>KiBoM PCB Bill of Materials</h2>\n")
html.write('<table border="1">\n')
@ -56,8 +65,12 @@ def WriteHTML(filename, groups, net, headings, prefs):
html.write("<tr><td>Schematic Version</td><td>{version}</td></tr>\n".format(version=net.getVersion()))
html.write("<tr><td>Schematic Date</td><td>{date}</td></tr>\n".format(date=net.getSheetDate()))
html.write("<tr><td>KiCad Version</td><td>{version}</td></tr>\n".format(version=net.getTool()))
html.write("<tr><td>Total Components</td><td>{n}</td></tr>\n".format(n = sum([g.getCount() for g in groups])))
html.write("<tr><td>Component Groups</td><td>{n}</td></tr>\n".format(n=len(groups)))
html.write("<tr><td>Component Groups</td><td>{n}</td></tr>\n".format(n=nGroups))
html.write("<tr><td>Component Count (per PCB)</td><td>{n}</td></tr>\n".format(n=nTotal))
html.write("<tr><td>Fitted Components (per PCB)</td><td>{n}</td></tr>\n".format(n=nFitted))
if prefs.buildNumber > 0:
html.write("<tr><td>Number of PCBs</td><td>{n}</td></tr>\n".format(n=prefs.buildNumber))
html.write("<tr><td>Total Component Count<br>(for {n} PCBs)</td><td>{t}</td></tr>\n".format(n=prefs.buildNumber, t=nBuild))
html.write("</table>\n")
html.write("<br>\n")
html.write("<h2>Component Groups</h2>\n")
@ -94,7 +107,7 @@ def WriteHTML(filename, groups, net, headings, prefs):
html.write("<tr>\n")
if prefs.numberRows:
html.write('\t<td align="center">{n}</td>'.format(n=rowCount))
html.write('\t<td align="center">{n}</td>\n'.format(n=rowCount))
for n, r in enumerate(row):
bg = bgColor(headings[n])

36
KiBOM/xml_writer.py
View File

@ -18,19 +18,32 @@ def WriteXML(filename, groups, net, headings, prefs):
if not filename.endswith(".xml"):
return False
xml = ElementTree.Element('KiCAD_BOM', attrib = {
'Schematic_Source' : net.getSource(),
'Schematic_Version' : net.getVersion(),
'Schematic_Date' : net.getSheetDate(),
'BOM_Date' : net.getDate(),
'KiCad_Version' : net.getTool(),
'groups' : str(len(groups)),
'components' : str(sum([group.getCount() for group in groups]))
})
nGroups = len(groups)
nTotal = sum([g.getCount() for g in groups])
nFitted = sum([g.getCount() for g in groups if g.isFitted()])
nBuild = nFitted * prefs.buildNumber
attrib = {}
attrib['Schematic_Source'] = net.getSource()
attrib['Schematic_Version'] = net.getVersion()
attrib['Schematic_Date'] = net.getSheetDate()
attrib['BOM_Date'] = net.getDate()
attrib['KiCad_Version'] = net.getTool()
attrib['Component_Groups'] = str(nGroups)
attrib['Component_Count'] = str(nTotal)
attrib['Fitted_Components'] = str(nFitted)
if prefs.buildNumber > 0:
attrib['Number_of_PCBs'] = str(prefs.buildNumber)
attrib['Total_Components'] = str(nBuild)
xml = ElementTree.Element('KiCAD_BOM', attrib = attrib, encoding='utf-8')
for group in groups:
if prefs.ignoreDNF and not group.isFitted():
continue
row = group.getRow(headings)
attrib = {}
@ -40,13 +53,12 @@ def WriteXML(filename, groups, net, headings, prefs):
h = h.replace('"','')
h = h.replace("'",'')
attrib[h] = row[i]
attrib[h] = str(row[i]).decode('ascii',errors='ignore')
sub = ElementTree.SubElement(xml, "group", attrib=attrib)
with open(filename,"w") as output:
out = ElementTree.tostring(xml, 'utf-8')
out = ElementTree.tostring(xml, encoding="utf-8")
output.write(minidom.parseString(out).toprettyxml(indent="\t"))
return True