skidl.alias module

Alias module for SKiDL.

This module provides the Alias class which allows multiple names to be assigned to SKiDL objects like Circuit, Part, Pin, Net, and Bus. Aliases enable objects to be referenced by alternative names, making circuit design more flexible and expressive.

class skidl.alias.Alias(*aliases)

Bases: set

A collection of alternative names for SKiDL objects.

The Alias class extends the Python set to store multiple name strings that can be used interchangeably to identify Circuit, Part, Pin, Net, and Bus objects. When comparing two Alias objects, they are considered equal if they share at least one alias.

Parameters:

*aliases – A string or multiple strings, or lists/tuples of strings to use as aliases.

Examples

>>> part_aliases = Alias('resistor', 'res', 'R')
>>> 'R' in part_aliases
True
>>> part_aliases += 'resistor_std'  # Add another alias
>>> part_aliases -= 'res'  # Remove an alias

clean()

Remove any empty aliases from the set.

This removes None values and empty strings from the alias set.