Method dump

src/licensedcode/models.py:2398–2423

Dump a representation of this rule as a .RULE file stored in ``rules_data_dir`` as a UTF-8 file having: - the rule data as YAML frontmatter - the rule text And this is a ``rule_file``. Also writes any kwargs as extra data in the rule metadata.

(self, rules_data_dir, **kwargs)

        self.is_tiny = self.length < tiny_rule

    def dump(self, rules_data_dir, **kwargs):
        """
        Dump a representation of this rule as a .RULE file stored in ``rules_data_dir`` as a UTF-8
        file having:
         - the rule data as YAML frontmatter
         - the rule text
        And this is a ``rule_file``.

        Also writes any kwargs as extra data in the rule metadata.

        Does nothing if this rule was created from a License (e.g., `is_from_license` is True)
        """
        if self.is_from_license or self.is_synthetic:
            return

        rule_file = self.rule_file(rules_data_dir=rules_data_dir)

        metadata = self.to_dict()
        # This can be used to pass objects to dump on the rule file with
        # other rule metadata, like debugging collection of required phrases
        if kwargs:
            metadata.update(kwargs)
        content = self.text
        output = dumps_frontmatter(content=content, metadata=metadata)
        with open(rule_file, 'w') as of:
            of.write(output)

    def load(self, rule_file, with_checks=True):
        """