Class Header

src/commoncode/resource.py:190–220

Represent a Codebase header. Each tool that transforms the codebase should create a Header and append it to the Codebase.headers list.

@attr.s(slots=True)
class Header(object):
    """
    Represent a Codebase header. Each tool that transforms the codebase
    should create a Header and append it to the Codebase.headers list.
    """

    tool_name = String(help="Name of the tool used such as scancode-toolkit.")
    tool_version = String(default="", help="Tool version used such as v1.2.3.")
    options = Mapping(help="Mapping of key/values describing the options used with this tool.")
    notice = String(default="", help="Notice text for this tool.")
    start_timestamp = String(help="Start timestamp for this header.")
    end_timestamp = String(help="End timestamp for this header.")
    output_format_version = String(help="Version for the output data format, such as v1.1 .")
    duration = String(help="Scan duration in seconds.")
    message = String(help="Message text.")
    errors = List(help="List of error messages.")
    warnings = List(help="List of warning messages.")
    extra_data = Mapping(help="Mapping of extra key/values for this tool.")

    def to_dict(self):
        return attr.asdict(self, dict_factory=dict)

    @classmethod
    def from_dict(cls, **kwargs):
        """
        Return a Header object deserialized from a `kwargs` mapping of
        key/values. Unknown attributes are ignored.
        """
        known_attributes = set(attr.fields_dict(Header))
        kwargs = {k: v for k, v in kwargs.items() if k in known_attributes}
        return cls(**kwargs)


def ignore_nothing(resource, codebase):