-
Notifications
You must be signed in to change notification settings - Fork 98
/
generic_csv.py
200 lines (175 loc) · 8.47 KB
/
generic_csv.py
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
# -*- coding: utf-8 -*-
# MIT license
#
# Copyright (C) 2018 by XESS Corporation / Hildo Guillardi Júnior
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
# Author information.
__author__ = 'Hildo Guillardi Junior'
__webpage__ = 'https://github.com/hildogjr/'
__company__ = 'University of Campinas - Brazil'
# This module is intended to work with "generic hand made CSV" and the software:
# Proteus ISIS-ARES and AutoDesk EAGLE.
# Libraries.
import sys, os, time
from datetime import datetime
import csv # CSV file reader.
import re # Regular expression parser.
import logging
from ...globals import logger, DEBUG_OVERVIEW, DEBUG_DETAILED, DEBUG_OBSESSIVE # Debug configurations.
from ..eda_tools import field_name_translations, remove_dnp_parts, split_refs
from ...kicost import distributor_dict
# Add to deal with the generic CSV header purchase list.
field_name_translations.update(
{
'stock code': 'manf#',
'mfr. no': 'manf#',
'manpartno': 'manf#',
'quantity': 'qty',
'order qty': 'qty',
'references': 'refs',
'reference': 'refs',
'ref': 'refs',
'customer no': 'refs',
'parts': 'refs',
'part': 'refs',
'value': 'value',
'package': 'footprint',
'pcb package': 'footprint',
'': '' # This is here because the header row may contain an empty field.
}
)
GENERIC_PREFIX = 'GEN' # Part reference prefix to use when no references are present.
def get_part_groups(in_file, ignore_fields, variant):
'''Get groups of identical parts from an generic CSV file and return them as a dictionary.
@param in_file `str()` with the file name.
@param ignore_fields `list()` fields do be ignored on the read action.
@param variant `str()` in regular expression to match with the design version of the BOM.
For now, `variant`is not used on CSV read, just kept to compatibility with the other EDA submodules.
@return `dict()` of the parts designed. The keys are the componentes references.
'''
ign_fields = [str(f.lower()) for f in ignore_fields]
logger.log(DEBUG_OVERVIEW, 'Getting from CSV BoM...')
file_h = open(in_file)
content = file_h.read()
file_h.close()
# Collapse multiple, consecutive tabs.
content = re.sub('\t+', '\t', content)
# Determine the column delimiter used in the CSV file.
try:
dialect = csv.Sniffer().sniff(content, [',',';','\t'])
except csv.Error:
# If the CSV file only has a single column of data, there may be no
# delimiter so just set the delimiter to a comma.
dialect = csv.Sniffer().sniff(',,,', [','])
# The first line in the file must be the column header.
content = content.splitlines()
header = next(csv.reader(content,delimiter=dialect.delimiter))
# Standardize the header titles and remove the spaces before
# and after, striping the text imrpove the user experience.
header = [field_name_translations.get(hdr.strip().lower(),hdr.strip().lower()) for hdr in header]
# Examine the first line to see if it really is a header.
# If the first line contains a column header that is not in the list of
# allowable field names, then assume the first line is data and not a header.
field_names = list(field_name_translations.keys()) + list(field_name_translations.values())
if not any([code in header for code in (['manf#']+ [d+'#' for d in distributor_dict])]):
if any(col_hdr.lower() in field_names for col_hdr in header):
content.pop(0) # It was a header by the user not identify the 'manf#' column.
# If a column header is not in the list of field names, then there is
# no header in the file. Therefore, create a header based on number of columns.
# header may have a '' at the end, so remove it.
if '' in header:
header.remove('')
num_cols = len(header)
if num_cols == 1:
header = ['manf#']
elif num_cols == 2:
header = ['manf#', 'refs']
else:
header = ['qty', 'manf#', 'refs']
else:
# OK, the first line is a header, so remove it from the data.
content.pop(0) # Remove the header from the content.
def extract_fields(row):
fields = {}
try:
vals = next(csv.DictReader([row.replace("'", '"')], fieldnames=header, delimiter=dialect.delimiter))
except:
# If had a error when tryed to read a line maybe a 'EmptyLine',
# normally at the end of the file or after the header and before
# the first part.
raise Exception('EmptyLine')
if 'refs' in vals:
ref_str = vals['refs'].strip()
qty = len(vals['refs'])
elif 'qty' in vals:
qty = int(vals['qty'])
if qty>1:
ref_str = GENERIC_PREFIX + '{0}-{1}'.format(extract_fields.gen_cntr, extract_fields.gen_cntr+qty-1)
else:
ref_str = GENERIC_PREFIX + '{0}'.format(extract_fields.gen_cntr)
extract_fields.gen_cntr += qty
fields['qty'] = qty
else:
qty = 1
ref_str = GENERIC_PREFIX + '{0}'.format(extract_fields.gen_cntr)
extract_fields.gen_cntr += qty
fields['qty'] = qty
refs = split_refs(ref_str)
if sys.version_info >= (3,0):
# This is for Python 3 where the values are already unicode.
fields['libpart'] = vals.get('libpart', 'Lib:???')
fields['footprint'] = vals.get('footprint', 'Foot:???')
fields['value'] = vals.get('value', '???')
for h in header:
if not h in (ign_fields + ['refs', 'qty']):
value = vals.get(h, '')
if value:
fields[h] = value
else:
# For Python 2, create unicode versions of strings.
fields['libpart'] = vals.get('libpart', 'Lib:???').decode('utf-8')
fields['footprint'] = vals.get('footprint', 'Foot:???').decode('utf-8')
fields['value'] = vals.get('value', '???').decode('utf-8')
for h in header:
if not h in (ign_fields + ['refs', 'qty']):
value = vals.get(h, '').decode('utf-8')
if value:
fields[h] = value
return refs, fields
extract_fields.gen_cntr = 0
# Make a dictionary from the fields in the parts library so these field
# values can be instantiated into the individual components in the schematic.
logger.log(DEBUG_OVERVIEW, 'Getting parts...')
# Read the each line content.
accepted_components = {}
for row in content:
# Get the values for the fields in each library part (if any).
try:
refs, fields = extract_fields(row)
except:
# If error in one line, try get the part proprieties in last one.
continue
for ref in refs:
accepted_components[ref] = fields
# Not founded project information at the file content.
prj_info = {'title': os.path.basename( in_file ),
'company': None,
'date': datetime.strptime(time.ctime(os.path.getmtime(in_file)), '%a %b %d %H:%M:%S %Y').strftime("%Y-%m-%d %H:%M:%S") + ' (file)'}
return remove_dnp_parts(accepted_components, variant), prj_info