Internals

uhdl.structures

Data structures(unrelated to hardware description) used internally by uhdl.

class uhdl.structures.CaselessDict(data=None, **kwargs)

A case-insensitive dictionary.

All keys are expected to be strings. The structure converts the key to lower case before storing or retreiving objects.

uhdl.utils

Utility functions(unrelated to hardware desription) used within uhdl.

uhdl.utils.cd(path)

Context manager which changes the current working directory

Parameters:path (str) – path to change directory to.

Usage:

with cd('path/to/somewhere'):
    #do something..

class uhdl.utils.classproperty(fget)

Decorator which allows read only class properties

uhdl.utils.flatten(*args)

Flattens arbitrarily nested iterators(Except strings)

Parameters:*args – objects and iterables. Returns:list of all objects.