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

Added better generic example generation. 

To add more realistic defaults.
This commit is contained in:
SET 2020-08-15 23:59:39 -03:00
parent 361c9caff9
commit 71d1ee3bc7
8 changed files with 83 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
experiments/yaml/test.py
View File

@ -68,6 +68,9 @@ people:
- Luca
- Laura
""") # 10
document.append("""
people: [['a','b'],['c','d']]
""") # 11
print(yaml.load(document[-1]))

13
kiplot/config_reader.py
View File

@ -270,8 +270,17 @@ def print_example_options(f, cls, name, indent, po):
elif isinstance(val, bool):
val = str(val).lower()
if isinstance(val, type):
f.write(ind_str+'{}:\n'.format(k))
print_example_options(f, val, '', indent+2, None)
if val.__name__ == 'Optionable' and help and '=' in help_lines[0]:
# Get the text after =
txt = help_lines[0].split('=')[1]
# Get the text before the space, without the ]
txt = txt.split()[0][:-1]
f.write(ind_str+'{}: {}\n'.format(k, txt))
elif hasattr(val, '_default'):
f.write(ind_str+'{}: {}\n'.format(k, val._default))
else:
f.write(ind_str+'{}:\n'.format(k))
print_example_options(f, val, '', indent+2, None)
else:
f.write(ind_str+'{}: {}\n'.format(k, val))
return obj

3
kiplot/optionable.py
View File

@ -101,6 +101,9 @@ class Optionable(object):
if cur_doc[0] == '[':
# Separate the valid types for this key
valid = cur_doc[1:].split(']')[0].split('|')
# Remove the XXXX=Value
if '=' in valid[-1]:
valid[-1] = valid[-1].split('=')[0]
# Get the type used by the user as a string
v_type = Optionable._typeof(v)
if v_type not in valid:

52
kiplot/out_bom.py
View File

@ -10,6 +10,13 @@ from . import log
logger = log.get_logger(__name__)
VALID_STYLES = {'modern-blue': 1, 'modern-green': 1, 'modern-red': 1, 'classic': 1}
DEFAULT_ALIASES = [['r', 'r_small', 'res', 'resistor'],
['l', 'l_small', 'inductor'],
['c', 'c_small', 'cap', 'capacitor'],
['sw', 'switch'],
['zener', 'zenersmall'],
['d', 'diode', 'd_small'],
]
# String matches for marking a component as "do not fit"
@ -43,7 +50,7 @@ class BoMColumns(Optionable):
self.name = ''
""" Name to display in the header. The field is used when empty """
self.join = Optionable
""" [list(string)|string] List of fields to join to this column """ # pragma: no cover
""" [list(string)|string=''] List of fields to join to this column """ # pragma: no cover
def config(self):
super().config()
@ -55,7 +62,10 @@ class BoMColumns(Optionable):
if isinstance(self.join, type):
self.join = None
elif isinstance(self.join, str):
self.join = [field, self.join.lower()]
if self.join:
self.join = [field, self.join.lower()]
else:
self.join = None
else:
self.join = [field]+[c.lower() for c in self.join]
@ -70,7 +80,7 @@ class BoMLinkable(Optionable):
self.datasheet_as_link = ''
""" Column with links to the datasheet """
self.digikey_link = Optionable
""" [string|list(string)] Column/s containing Digi-Key part numbers, will be linked to web page """
""" [string|list(string)=''] Column/s containing Digi-Key part numbers, will be linked to web page """
self.generate_dnf = True
""" Generate a separated section for DNF (Do Not Fit) components """
self.hide_pcb_info = False
@ -80,7 +90,7 @@ class BoMLinkable(Optionable):
self.highlight_empty = True
""" Use a color for empty cells. Applies only when `col_colors` is `true` """
self.logo = Optionable
""" [string|boolean] PNG file to use as logo, use false to remove """
""" [string|boolean=''] PNG file to use as logo, use false to remove """
self.title = 'KiBot Bill of Materials'
""" BoM title """ # pragma: no cover
@ -158,14 +168,21 @@ class BoMXLSX(BoMLinkable):
raise KiPlotConfigurationError('Unknown style `{}`'.format(self.style))
class ComponentAliases(Optionable):
_default = DEFAULT_ALIASES
def __init__(self):
super().__init__()
class GroupFields(Optionable):
_default = ColumnList.DEFAULT_GROUPING
def __init__(self):
super().__init__()
class BoMOptions(BaseOptions):
DEFAULT_ALIASES = [['r', 'r_small', 'res', 'resistor'],
['l', 'l_small', 'inductor'],
['c', 'c_small', 'cap', 'capacitor'],
['sw', 'switch'],
['zener', 'zenersmall'],
['d', 'diode', 'd_small'],
]
DEFAULT_EXCLUDE = [[ColumnList.COL_REFERENCE, '^TP[0-9]*'],
[ColumnList.COL_REFERENCE, '^FID'],
[ColumnList.COL_PART, 'mount.*hole'],
@ -182,7 +199,7 @@ class BoMOptions(BaseOptions):
self.number = 1
""" Number of boards to build (components multiplier) """
self.variant = Optionable
""" [string|list(string)] Board variant(s), used to determine which components
""" [string|list(string)=''] Board variant(s), used to determine which components
are output to the BoM. """
self.output = GS.def_global_output
""" filename for the output (%i=bom)"""
@ -203,12 +220,12 @@ class BoMOptions(BaseOptions):
""" Component groups with blank fields will be merged into the most compatible group, where possible """
self.fit_field = 'Config'
""" Field name used to determine if a particular part is to be fitted (also DNC and variants) """
self.group_fields = Optionable
self.group_fields = GroupFields
""" [list(string)] List of fields used for sorting individual components into groups.
Components which match (comparing *all* fields) will be grouped together.
Field names are case-insensitive.
If empty: ['Part', 'Part Lib', 'Value', 'Footprint', 'Footprint Lib'] is used """
self.component_aliases = Optionable
self.component_aliases = ComponentAliases
""" [list(list(string))] A series of values which are considered to be equivalent for the part name.
Each entry is a list of equivalen names. Example: ['c', 'c_small', 'cap' ]
will ensure the equivalent capacitor symbols can be grouped together.
@ -316,7 +333,7 @@ class BoMOptions(BaseOptions):
self.group_fields = [f.lower() for f in self.group_fields]
# component_aliases
if isinstance(self.component_aliases, type):
self.component_aliases = BoMOptions.DEFAULT_ALIASES
self.component_aliases = DEFAULT_ALIASES
# include_only
if isinstance(self.include_only, type):
self.include_only = None
@ -339,7 +356,10 @@ class BoMOptions(BaseOptions):
if isinstance(self.variant, type):
self.variant = []
elif isinstance(self.variant, str):
self.variant = [self.variant]
if self.variant:
self.variant = [self.variant]
else:
self.variant = []
# Columns
self.column_rename = {}
self.join = []

28
kiplot/out_kibom.py
View File

@ -45,7 +45,7 @@ class KiBoMColumns(Optionable):
self.name = ''
""" Name to display in the header. The field is used when empty """
self.join = Optionable
""" [list(string)|string] List of fields to join to this column """ # pragma: no cover
""" [list(string)|string=''] List of fields to join to this column """ # pragma: no cover
def config(self):
super().config()
@ -57,6 +57,26 @@ class KiBoMColumns(Optionable):
self.join = '\t'.join(self.join)
class ComponentAliases(Optionable):
_default = [['r', 'r_small', 'res', 'resistor'],
['l', 'l_small', 'inductor'],
['c', 'c_small', 'cap', 'capacitor'],
['sw', 'switch'],
['zener', 'zenersmall'],
['d', 'diode', 'd_small'],
]
def __init__(self):
super().__init__()
class GroupFields(Optionable):
_default = ['Part', 'Part Lib', 'Value', 'Footprint', 'Footprint Lib']
def __init__(self):
super().__init__()
class KiBoMConfig(Optionable):
""" Implements the .ini options """
def __init__(self):
@ -85,13 +105,13 @@ class KiBoMConfig(Optionable):
self.hide_pcb_info = False
""" Hide project information """
self.digikey_link = Optionable
""" [string|list(string)] Column/s containing Digi-Key part numbers, will be linked to web page (HTML only) """
self.group_fields = Optionable
""" [string|list(string)=''] Column/s containing Digi-Key part numbers, will be linked to web page (HTML only) """
self.group_fields = GroupFields
""" [list(string)] List of fields used for sorting individual components into groups.
Components which match (comparing *all* fields) will be grouped together.
Field names are case-insensitive.
If empty: ['Part', 'Part Lib', 'Value', 'Footprint', 'Footprint Lib'] is used """
self.component_aliases = Optionable
self.component_aliases = ComponentAliases
""" [list(list(string))] A series of values which are considered to be equivalent for the part name.
Each entry is a list of equivalen names. Example: ['c', 'c_small', 'cap' ]
will ensure the equivalent capacitor symbols can be grouped together.

6
kiplot/out_pcbdraw.py
View File

@ -77,7 +77,7 @@ class PcbDrawOptions(BaseOptions):
self.style = PcbDrawStyle
""" [string|dict] PCB style (colors). An internal name, the name of a JSON file or the style options """
self.libs = Optionable
""" [list(string)] list of libraries """
""" [list(string)=[]] list of libraries """
self.placeholder = False
""" show placeholder for missing components """
self.remap = PcbDrawRemap
@ -89,9 +89,9 @@ class PcbDrawOptions(BaseOptions):
self.mirror = False
""" mirror the board """
self.highlight = Optionable
""" [list(string)] list of components to highlight """
""" [list(string)=[]] list of components to highlight """
self.show_components = Optionable
""" [string|list(string)] [none,all] list of components to draw, can be also a string for none or all.
""" [string|list(string)=none] [none,all] list of components to draw, can be also a string for none or all.
The default is none """
self.vcuts = False
""" render V-CUTS on the Cmts.User layer """

2
tests/utils/context.py
View File

@ -186,7 +186,7 @@ class TestContext(object):
self.err = self.err.decode()
self.out = self.err
exp_ret = 0 if ret_val is None else ret_val
assert ret_code == exp_ret
assert ret_code == exp_ret, 'ret_code: {} expected {}'.format(ret_code, exp_ret)
if use_a_tty:
os.close(master)
os.close(slave)

3
tests/yaml_samples/int_bom_join_1.kiplot.yaml
View File

@ -16,6 +16,7 @@ outputs:
join: ['Tolerance', 'Voltage']
- field: manf
join: manf#
- digikey#
- field: digikey#
join: ''
- Quantity Per PCB