What is is_continuous?

[armijnhemel]

Description

In the rules I see is_continuous which cannot be found clearly in the documentation, except in the Changelog. I cannot see it used anywhere (although the thing it was renamed from only_known_words pops up in one script, weird) so I am wondering if this was removed, if the documentation is simply incomplete or if something else is going on.

Select Category

• Inconsistency
• New Section Request
• General Improvement
• Typo/Mistakes
• Other

[AyanSinhaMahapatra]

Hey @armijnhemel thanks for the issue. I was working on improved documentation for adding rules, I'm this PR: #4789 Please take a look/review if you want.
We should probably have a reference section too, explaining all data fields, this was planned but not finished.

[armijnhemel]

Description

In the rules I see is_continuous which cannot be found clearly in the documentation, except in the Changelog. I cannot see it used anywhere (although the thing it was renamed from only_known_words pops up in one script, weird) so I am wondering if this was removed, if the documentation is simply incomplete or if something else is going on.

So it actually is used in the code, I just didn't grep in the right directory it seems.

[pombredanne]

@armijnhemel

src/licensedcode/data/rules$ grep -r . -e "is_continuous: yes" | wc -l 5240 ... is whether a rule should matched only if there are no extra words in the matched sequence

It is used to filter certain matches to some rules. See:

• scancode-toolkit/src/licensedcode/match.py

  Line 529 in 7dbb3c7

  def is_continuous(self):

Return True if the all the matched tokens of this match are continuous
without any extra unmatched known or unkwown words, or stopwords.

And also:

• scancode-toolkit/src/licensedcode/match.py

  Line 2166 in 7dbb3c7

  A rule with "is_continuous" set to True is the same as if its whole text

A rule with "is_continuous" set to True is the same as if its whole text
was defined as a required phrase and is processed here too.
Same for a rule with "is_required_phrase" set to True.

[armijnhemel]

so is_continuous and is_required could be considered equivalent?

[pombredanne]

so is_continuous and is_required could be considered equivalent?

AFAICR is_required_phrase has the same effect as is_continuous, but they are different, as with is_required_phrase True, this can also be used to propagate that phrase to other rules using scripts, but is_continuous alone is not enough ?