-
-
Notifications
You must be signed in to change notification settings - Fork 540
/
match.py
3087 lines (2557 loc) · 104 KB
/
match.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#
# Copyright (c) nexB Inc. and others. All rights reserved.
# ScanCode is a trademark of nexB Inc.
# SPDX-License-Identifier: Apache-2.0
# See http://www.apache.org/licenses/LICENSE-2.0 for the license text.
# See https://github.com/nexB/scancode-toolkit for support or download.
# See https://aboutcode.org for more information about nexB OSS projects.
#
from enum import IntEnum
from itertools import groupby
import attr
from attr import validators
from licensedcode import MAX_DIST
from licensedcode import SMALL_RULE
from licensedcode import query
from licensedcode.spans import Span
from licensedcode.stopwords import STOPWORDS
from licensedcode.tokenize import index_tokenizer
from licensedcode.tokenize import matched_query_text_tokenizer
"""
LicenseMatch data structure and processing.
A key feature is merging and filtering of matches.
Merging combines match fragments made to the same license rule and that in the
correct sequence.
Filtering discards matches based on various heuristics and rules such as:
- containment: a small match is contained in a larger match
- overlap: based on a level of overlap between matches
- various spurious matches rules based on length, required content, etc.
- false positives
The filter functions are executed in a specific sequence over the list of matches.
"""
TRACE = False
TRACE_MERGE = False
TRACE_REFINE = False
TRACE_FILTER_FALSE_POSITIVE = False
TRACE_FILTER_CONTAINED = False
TRACE_FILTER_OVERLAPPING = False
TRACE_FILTER_SPURIOUS_SINGLE_TOKEN = False
TRACE_FILTER_SPURIOUS = False
TRACE_FILTER_SHORT = False
TRACE_FILTER_RULE_MIN_COVERAGE = False
TRACE_FILTER_BELOW_MIN_SCORE = False
TRACE_FILTER_SINGLE_WORD_GIBBERISH = False
TRACE_SET_LINES = False
TRACE_KEY_PHRASES = False
TRACE_REGIONS = False
TRACE_FILTER_LICENSE_LIST = False
TRACE_FILTER_LICENSE_LIST_DETAILED = False
TRACE_FILTER_INVALID_UNKNOWN = False
TRACE_MATCHED_TEXT = False
TRACE_MATCHED_TEXT_DETAILS = False
# these control the details in a LicenseMatch representation
TRACE_REPR_MATCHED_RULE = False
TRACE_REPR_SPAN_DETAILS = False
TRACE_REPR_THRESHOLDS = False
TRACE_REPR_ALL_MATCHED_TEXTS = False
def logger_debug(*args): pass
if (TRACE
or TRACE_MERGE
or TRACE_REFINE
or TRACE_FILTER_CONTAINED
or TRACE_FILTER_OVERLAPPING
or TRACE_FILTER_RULE_MIN_COVERAGE
or TRACE_FILTER_SPURIOUS_SINGLE_TOKEN
or TRACE_FILTER_SPURIOUS
or TRACE_FILTER_SHORT
or TRACE_FILTER_RULE_MIN_COVERAGE
or TRACE_FILTER_BELOW_MIN_SCORE
or TRACE_SET_LINES
or TRACE_MATCHED_TEXT
or TRACE_MATCHED_TEXT_DETAILS
or TRACE_FILTER_SINGLE_WORD_GIBBERISH
or TRACE_KEY_PHRASES
or TRACE_REGIONS
or TRACE_FILTER_LICENSE_LIST
or TRACE_FILTER_LICENSE_LIST_DETAILED
or TRACE_FILTER_INVALID_UNKNOWN
):
use_print = True
if use_print:
prn = print
else:
import logging
import sys
logger = logging.getLogger(__name__)
# logging.basicConfig(level=logging.DEBUG, stream=sys.stdout)
logging.basicConfig(stream=sys.stdout)
logger.setLevel(logging.DEBUG)
prn = logger.debug
def logger_debug(*args):
return prn(' '.join(isinstance(a, str) and a or repr(a) for a in args))
def _debug_print_matched_query_text(match, extras=5):
"""
Print a matched query text including `extras` tokens before and after
the match. Used for debugging license matches.
"""
# Create a fake new match with extra tokens before and after
new_match = match.combine(match)
new_qstart = max([0, match.qstart - extras])
new_qend = min([match.qend + extras, len(match.query.tokens)])
new_qspan = Span(new_qstart, new_qend)
new_match.qspan = new_qspan
logger_debug(new_match)
logger_debug(' MATCHED QUERY TEXT with extras')
qt = new_match.matched_text(whole_lines=False)
logger_debug(qt)
class DiscardReason(IntEnum):
NOT_DISCARDED = 0
MISSING_KEY_PHRASES = 1
BELOW_MIN_COVERAGE = 2
SPURIOUS_SINGLE_TOKEN = 3
TOO_SHORT = 4
SCATTERED_ON_TOO_MANY_LINES = 5
INVALID_SINGLE_WORD_GIBBERISH = 6
SPURIOUS = 7
CONTAINED = 8
OVERLAPPING = 9
NON_CONTINUOUS = 10
FALSE_POSITIVE = 11
BELOW_MIN_SCORE = 12
LICENSE_LIST = 13
@attr.s(slots=True, eq=False, order=False, repr=False)
class LicenseMatch(object):
"""
License detection match to a rule with matched query positions and lines and
matched index positions. Also computes a score for a match. At a high level,
a match behaves a little like a Span and has several similar methods taking
into account both the query and index-side Spans.
Note that the relationship between the query-side qspan Span and the index-
side ispan Span is such that:
- they always have the exact same number of items but when sorted each
value at a given index may be different
- the nth position when sorted by position is such that their token
value is equal for this position.
These properties mean that the qspan and ispan can be safely zipped with
zip(). Also and as a convention throughout, we always use qspan first then
ispan: in general we put query-related variables on the left hand side and
index-related variables on the right hand side.
"""
rule = attr.ib(
metadata=dict(
help='matched Rule object'
)
)
qspan = attr.ib(
metadata=dict(
help='query text matched Span, start at zero which is the absolute '
'query start (not the query_run start)'
)
)
ispan = attr.ib(
metadata=dict(
help='rule text matched Span, start at zero which is the rule start.'
)
)
hispan = attr.ib(
default=attr.Factory(Span),
metadata=dict(
help='rule text matched Span for high tokens, start at zero which '
'is the rule start. Always a subset of ispan.'
)
)
query_run_start = attr.ib(
default=0,
metadata=dict(
help='Starting position of the QueryRun where this match '
'was found.'
)
)
matcher = attr.ib(
default='',
metadata=dict(
help='A string indicating which matching procedure this match was '
'created with. Used for diagnostics, debugging and testing.'
)
)
start_line = attr.ib(
default=0,
metadata=dict(help='match start line, 1-based')
)
end_line = attr.ib(
default=0,
metadata=dict(help='match end line, 1-based')
)
query = attr.ib(
default=None,
metadata=dict(help='Query object for this match')
)
discard_reason = attr.ib(
default=DiscardReason.NOT_DISCARDED,
validator=validators.in_(DiscardReason),
metadata=dict(
help='An internal reason code to track why a match was discarded '
'e.g., filtered out.'
)
)
def __repr__(
self,
trace_spans=TRACE_REPR_SPAN_DETAILS,
trace_thresholds=TRACE_REPR_THRESHOLDS,
trace_rule=TRACE_REPR_MATCHED_RULE,
trace_text=TRACE_REPR_ALL_MATCHED_TEXTS,
):
spans = ''
if trace_spans:
spans = (
f'\n qspan={self.qspan!r}, '
f'\n ispan={self.ispan!r}, '
f'\n hispan={self.hispan!r}'
)
thresh = ''
if trace_thresholds:
qdens = round(self.qdensity() * 100, 2)
idens = round(self.idensity() * 100, 2)
thresh = f'\n qdens={qdens!r}, idens={idens!r}'
rule_id = self.rule.identifier
if trace_rule:
rule_id = '\n ' + repr(self.rule)
qreg = (self.qstart, self.qend)
ireg = (self.istart, self.iend)
spans = spans
thresh = thresh
if trace_text:
text = f' matched_text: {self.matched_text()!r}\n'
else:
text = ''
return (
f'LicenseMatch: '
f'{self.rule.license_expression!r}, '
f'lines={self.lines()!r}, '
f'matcher={self.matcher!r}, '
f'rid={rule_id}, '
f'sc={self.score()!r}, '
f'cov={self.coverage()!r}, '
f'len={self.len()}, '
f'hilen={self.hilen()}, '
f'rlen={self.rule.length}, '
f'qreg={qreg!r}, '
f'ireg={ireg!r}'
f'{thresh}{spans}'
f'{text}'
)
def __eq__(self, other):
"""
Strict equality is based on licensing, matched positions and not based
on matched rule.
"""
return (isinstance(other, LicenseMatch)
and self.qspan == other.qspan
and self.ispan == other.ispan
and self.rule.same_licensing(other.rule)
)
def __ne__(self, other):
"""
Strict inequality is based on licensing, matched positions and not based
on matched rule.
"""
return (not isinstance(other, LicenseMatch)
or self.qspan != other.qspan
or self.ispan != other.ispan
or not self.rule.same_licensing(other.rule)
)
# NOTE: we implement all rich comparison operators with some inlining for
# performance reasons
def __lt__(self, other):
if not isinstance(other, LicenseMatch):
return NotImplemented
return self.qstart < other.qstart
def __lte__(self, other):
if not isinstance(other, LicenseMatch):
return NotImplemented
return self.qstart < other.qstart or (
self.qspan == other.qspan
and self.ispan == other.ispan
and self.rule.same_licensing(other.rule)
)
def __gt__(self, other):
if not isinstance(other, LicenseMatch):
return NotImplemented
return self.qstart > other.qstart
def __gte__(self, other):
if not isinstance(other, LicenseMatch):
return NotImplemented
return self.qstart > other.qstart or (
self.qspan == other.qspan
and self.ispan == other.ispan
and self.rule.same_licensing(other.rule)
)
def same_licensing(self, other):
"""
Return True if other has the same licensing.
"""
return self.rule.same_licensing(other.rule)
def licensing_contains(self, other):
"""
Return True if this match licensing contains the other match licensing.
"""
return self.rule.licensing_contains(other.rule)
def lines(self, line_by_pos=None):
if line_by_pos:
self.set_lines(line_by_pos)
return self.start_line, self.end_line
def set_lines(self, line_by_pos):
"""
Set this match start and end lines using a mapping of ``line_by_pos``
{pos: line}.
"""
self.start_line = line_by_pos[self.qstart]
self.end_line = line_by_pos[self.qend]
if TRACE_SET_LINES:
logger_debug('LicenseMatch.set_lines: match.start_line :', self.start_line)
logger_debug('LicenseMatch.set_lines: match.end_line :', self.end_line)
@property
def qstart(self):
return self.qspan.start
@property
def qend(self):
return self.qspan.end
def len(self):
"""
Return the length of the match as the number of matched query tokens.
"""
return len(self.qspan)
@property
def istart(self):
return self.ispan.start
@property
def iend(self):
return self.ispan.end
def hilen(self):
"""
Return the length of the match as the number of matched high tokens.
"""
return len(self.hispan)
def __contains__(self, other):
"""
Return True if qspan contains other.qspan and ispan contains other.ispan.
"""
return other.qspan in self.qspan and other.ispan in self.ispan
def qcontains(self, other):
"""
Return True if qspan contains other.qspan.
"""
return other.qspan in self.qspan
def qdistance_to(self, other):
"""
Return the absolute qspan distance to other match.
Overlapping matches have a zero distance.
Non-overlapping touching matches have a distance of one.
"""
return self.qspan.distance_to(other.qspan)
def idistance_to(self, other):
"""
Return the absolute ispan distance from self to other match.
Overlapping matches have a zero distance.
Non-overlapping touching matches have a distance of one.
"""
return self.ispan.distance_to(other.ispan)
def overlap(self, other):
"""
Return the number of overlapping positions with other.
"""
return self.qspan.overlap(other.qspan)
def _icoverage(self):
"""
Return the coverage of this match to the matched rule as a float between
0 and 1.
"""
if not self.rule.length:
return 0
return self.len() / self.rule.length
def coverage(self):
"""
Return the coverage of this match to the matched rule as a rounded float
between 0 and 100.
"""
return round(self._icoverage() * 100, 2)
def qmagnitude(self):
"""
Return the maximal query length represented by this match start and end
in the query. This number represents the full extent of the matched
query region including matched, unmatched AND unknown tokens, but
excluding STOPWORDS.
The magnitude is the same as the length if the match is a contiguous
match without any unknown token in its range. It will be greater than
the matched length for a non-contiguous match with gaps between its
matched tokens. It can also be greater than the query length when there
are unknown tokens in the matched range.
"""
# The query side of the match may not be contiguous and may contain
# unmatched known tokens or unknown tokens. Therefore we need to compute
# the real portion query length including unknown tokens that is
# included in this match, for both matches and unmatched tokens
query = self.query
qspan = self.qspan
qmagnitude = self.qregion_len()
# note: to avoid breaking many tests we check query presence
if query:
# Compute a count of unknown tokens that are inside the matched
# range, ignoring end position of the query span: unknowns here do
# not matter as they are never in the match but they influence the
# score.
unknowns_pos = qspan & query.unknowns_span
qspe = qspan.end
unknowns_pos = (pos for pos in unknowns_pos if pos != qspe)
qry_unkxpos = query.unknowns_by_pos
unknowns_in_match = sum(qry_unkxpos[pos] for pos in unknowns_pos)
# update the magnitude by adding the count of unknowns in the match.
# This number represents the full extent of the matched query region
# including matched, unmatched and unknown tokens.
qmagnitude += unknowns_in_match
return qmagnitude
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.
"""
return (
self.len() == self.qregion_len() == self.qmagnitude()
)
def qregion(self):
"""
Return the maximal positions Span representing this match from
start to end as query positions, including matched and unmatched tokens.
"""
return Span(self.qstart, self.qend)
def qregion_len(self):
"""
Return the maximal number of positions represented by this match start
and end region of query positions including matched and unmatched
tokens.
"""
return self.qspan.magnitude()
def qregion_lines(self):
"""
Return the maximal lines Span that this match query regions covers.
"""
return Span(self.start_line, self.end_line)
def qregion_lines_len(self):
"""
Return the maximal number of lines that this match query regions covers.
"""
return self.end_line - self.start_line + 1
def qdensity(self):
"""
Return the query density of this match as a ratio of its length to its
qmagnitude, a float between 0 and 1. A dense match has all its matched
query tokens contiguous and a maximum qdensity of one. A sparse low
qdensity match has some non-contiguous matched query tokens interspersed
between matched query tokens. An empty match has a zero qdensity.
"""
mlen = self.len()
if not mlen:
return 0
qmagnitude = self.qmagnitude()
if not qmagnitude:
return 0
return mlen / qmagnitude
def idensity(self):
"""
Return the ispan density of this match as a ratio of its rule-side
matched length to its rule side magnitude. This is a float between 0 and
1. A dense match has all its matched rule tokens contiguous and a
maximum idensity of one. A sparse low idensity match has some non-
contiguous matched rule tokens interspersed between matched rule tokens.
An empty match has a zero qdensity.
"""
return self.ispan.density()
def score(self):
"""
Return the score for this match as a rounded float between 0 and 100.
The score is an indication of the confidence that a match is good. It is
computed from the number of matched tokens, the number of query tokens
in the matched range (including unknowns and unmatched) and the matched
rule relevance.
"""
# relevance is a number between 0 and 100. Divide by 100
relevance = self.rule.relevance / 100
if not relevance:
return 0
qmagnitude = self.qmagnitude()
# Compute the score as the ration of the matched query length to the
# qmagnitude, e.g. the length of the matched region
if not qmagnitude:
return 0
# FIXME: this should exposed as an q/icoverage() method instead
query_coverage = self.len() / qmagnitude
rule_coverage = self._icoverage()
if query_coverage < 1 and rule_coverage < 1:
# use rule coverage in this case
return round(rule_coverage * relevance * 100, 2)
return round(query_coverage * rule_coverage * relevance * 100, 2)
def surround(self, other):
"""
Return True if this match query span surrounds other other match query
span.
This is different from containment. A matched query region can surround
another matched query region and have no positions in common with the
surrounded match.
"""
return self.qstart <= other.qstart and self.qend >= other.qend
def is_after(self, other):
"""
Return True if this match spans are strictly after other match spans.
"""
return self.qspan.is_after(other.qspan) and self.ispan.is_after(other.ispan)
def combine(self, other):
"""
Return a new match object combining self and an other match.
"""
if self.rule != other.rule:
raise TypeError(
'Cannot combine matches with different rules: '
f'from: {self!r}, to: {other!r}'
)
if other.matcher not in self.matcher:
newmatcher = ' '.join([self.matcher, other.matcher])
else:
newmatcher = self.matcher
if (
self.discard_reason == DiscardReason.NOT_DISCARDED
or other.discard_reason == DiscardReason.NOT_DISCARDED
):
discard_reason = DiscardReason.NOT_DISCARDED
elif (
self.discard_reason == DiscardReason.MISSING_KEY_PHRASES
and other.discard_reason == DiscardReason.MISSING_KEY_PHRASES
):
discard_reason = DiscardReason.MISSING_KEY_PHRASES
elif self.discard_reason == DiscardReason.MISSING_KEY_PHRASES:
discard_reason = other.discard_reason
elif other.discard_reason == DiscardReason.MISSING_KEY_PHRASES:
discard_reason = self.discard_reason
else:
discard_reason = self.discard_reason
combined = LicenseMatch(
rule=self.rule,
qspan=Span(self.qspan | other.qspan),
ispan=Span(self.ispan | other.ispan),
hispan=Span(self.hispan | other.hispan),
query_run_start=min(self.query_run_start, other.query_run_start),
matcher=newmatcher,
query=self.query,
discard_reason=discard_reason,
)
return combined
def update(self, other):
"""
Update self with other match and return the updated self in place.
"""
combined = self.combine(other)
self.qspan = combined.qspan
self.ispan = combined.ispan
self.hispan = combined.hispan
self.matcher = combined.matcher
self.query_run_start = min(self.query_run_start, other.query_run_start)
self.matcher = combined.matcher
self.discard_reason = combined.discard_reason
return self
def is_small(self):
"""
Return True if this match is "small" based on its rule lengths and
thresholds. Small matches are spurious matches that are discarded.
"""
matched_len = self.len()
min_matched_len = self.rule.min_matched_length
high_matched_len = self.hilen()
min_high_matched_len = self.rule.min_high_matched_length
if TRACE_FILTER_SHORT:
logger_debug(
f'LicenseMatch.is_small(): {self!r}: coverage: {self.coverage()}'
)
if matched_len < min_matched_len or high_matched_len < min_high_matched_len:
if TRACE_FILTER_SHORT:
logger_debug(' LicenseMatch.is_small(): CASE 1')
return True
if self.rule.is_small and self.coverage() < 80:
if TRACE_FILTER_SHORT:
logger_debug(' LicenseMatch.is_small(): CASE 2')
return True
if TRACE_FILTER_SHORT:
logger_debug(' LicenseMatch.is_small(): not small')
return False
def itokens(self, idx):
"""
Return the sequence of matched itoken ids.
"""
ispan = self.ispan
rid = self.rule.rid
if rid is not None:
for pos, token in enumerate(idx.tids_by_rid[rid]):
if pos in ispan:
yield token
def itokens_hash(self, idx):
"""
Return a hash from the matched itoken ids.
"""
from licensedcode.match_hash import index_hash
itokens = list(self.itokens(idx))
if itokens:
return index_hash(itokens)
# FIXME: this should be done for all the matches found in a given scanned
# location at once to avoid reprocessing many times the original text
def matched_text(
self,
whole_lines=False,
highlight=True,
highlight_matched='{}',
highlight_not_matched='[{}]',
_usecache=True
):
"""
Return the matched text for this match or an empty string if no query
exists for this match.
`_usecache` can be set to False in testing to avoid any unwanted caching
side effects as the caching depends on which index instance is being
used and this index can change during testing.
"""
if TRACE_MATCHED_TEXT:
logger_debug(f'LicenseMatch.matched_text: self.query: {self.query}')
query = self.query
if not query:
# TODO: should we raise an exception instead???
# this case should never exist except for tests!
return u''
if whole_lines and query.has_long_lines:
whole_lines = False
return ''.join(get_full_matched_text(
match=self,
location=query.location,
query_string=query.query_string,
idx=query.idx,
whole_lines=whole_lines,
highlight=highlight,
highlight_matched=highlight_matched,
highlight_not_matched=highlight_not_matched,
_usecache=_usecache
)).rstrip()
def set_matched_lines(matches, line_by_pos):
"""
Update a ``matches`` LicenseMatch sequence with start and end line given a
`line_by_pos` {pos: line} mapping.
"""
# if there is no line_by_pos, do not bother: the lines will stay to zero.
if line_by_pos:
for match in matches:
match.set_lines(line_by_pos)
def merge_matches(matches, max_dist=None, trace=TRACE_MERGE):
"""
Return a list of merged LicenseMatch matches given a `matches` list of
LicenseMatch. Merging is a "lossless" operation that combines two or more
matches to the same rule and that are in sequence of increasing query and
index positions in a single new match.
"""
# shortcut for single matches
if len(matches) < 2:
return matches
# only merge matches with the same rule: sort then group by rule for the
# same rule, sort on start, longer high, longer match, matcher type
sorter = lambda m: (m.rule.identifier, m.qspan.start, -m.hilen(), -m.len(), m.matcher)
matches.sort(key=sorter)
matches_by_rule = [
(rid, list(rule_matches))
for rid, rule_matches
in groupby(matches, key=lambda m: m.rule.identifier)
]
if trace:
print('merge_matches: number of matches to process:', len(matches))
if max_dist is None:
max_dist = MAX_DIST
merged = []
merged_extend = merged.extend
for rid, rule_matches in matches_by_rule:
if trace:
logger_debug('merge_matches: processing rule:', rid)
rule_length = rule_matches[0].rule.length
# FIXME this is likely too much as we are getting gaps that are often too big
max_rule_side_dist = min((rule_length // 2) or 1, max_dist)
# compare two matches in the sorted sequence: current and next
i = 0
while i < len(rule_matches) - 1:
j = i + 1
while j < len(rule_matches):
current_match = rule_matches[i]
next_match = rule_matches[j]
if trace:
logger_debug('---> merge_matches: current:', current_match)
logger_debug('---> merge_matches: next: ', next_match)
# FIXME: also considers the match length!
# stop if we exceed max dist
# or distance over 1/2 of rule length
if (current_match.qdistance_to(next_match) > max_rule_side_dist
or current_match.idistance_to(next_match) > max_rule_side_dist):
if trace:
logger_debug(
f' ---> ###merge_matches: '
f'MAX_DIST/max_rule_side_dist: {max_rule_side_dist} reached, '
'breaking')
break
# keep one of equal matches
# with same qspan: FIXME: is this ever possible?
if current_match.qspan == next_match.qspan and current_match.ispan == next_match.ispan:
if trace:
logger_debug(
' ---> ###merge_matches: next EQUALS current, '
'del next')
del rule_matches[j]
continue
# if we have two equal ispans and some overlap
# keep the shortest/densest match in qspan e.g. the smallest magnitude of the two
if current_match.ispan == next_match.ispan and current_match.overlap(next_match):
cqmag = current_match.qspan.magnitude()
nqmag = next_match.qspan.magnitude()
if cqmag <= nqmag:
if trace:
logger_debug(
' ---> ###merge_matches: '
'current ispan EQUALS next ispan, current qmagnitude smaller, '
'del next')
del rule_matches[j]
continue
else:
if trace:
logger_debug(
' ---> ###merge_matches: '
'current ispan EQUALS next ispan, next qmagnitude smaller, '
'del current')
del rule_matches[i]
i -= 1
break
# remove contained matches
if current_match.qcontains(next_match):
if trace:
logger_debug(
' ---> ###merge_matches: '
'next CONTAINED in current, '
'del next')
del rule_matches[j]
continue
# remove contained matches the other way
if next_match.qcontains(current_match):
if trace:
logger_debug(
' ---> ###merge_matches: '
'current CONTAINED in next, '
'del current')
del rule_matches[i]
i -= 1
break
# FIXME: qsurround is too weak. We want to check also isurround
# merge surrounded
if current_match.surround(next_match):
new_match = current_match.combine(next_match)
if len(new_match.qspan) == len(new_match.ispan):
# the merged matched is likely aligned
current_match.update(next_match)
if trace:
logger_debug(
' ---> ###merge_matches: '
'current SURROUNDS next, '
'merged as new:', current_match)
del rule_matches[j]
continue
# FIXME: qsurround is too weak. We want to check also isurround
# merge surrounded the other way too: merge in current
if next_match.surround(current_match):
new_match = current_match.combine(next_match)
if len(new_match.qspan) == len(new_match.ispan):
# the merged matched is likely aligned
next_match.update(current_match)
if trace:
logger_debug(
' ---> ###merge_matches: '
'next SURROUNDS current, '
'merged as new:', current_match)
del rule_matches[i]
i -= 1
break
# FIXME: what about the distance??
# next_match is strictly in increasing sequence: merge in current
if next_match.is_after(current_match):
current_match.update(next_match)
if trace:
logger_debug(
' ---> ###merge_matches: '
'next follows current, '
'merged as new:', current_match)
del rule_matches[j]
continue
# next_match overlaps
# Check increasing sequence and overlap importance to decide merge
if (current_match.qstart <= next_match.qstart
and current_match.qend <= next_match.qend
and current_match.istart <= next_match.istart
and current_match.iend <= next_match.iend):
qoverlap = current_match.qspan.overlap(next_match.qspan)
if qoverlap:
ioverlap = current_match.ispan.overlap(next_match.ispan)
# only merge if overlaps are equals (otherwise they are not aligned)
if qoverlap == ioverlap:
current_match.update(next_match)
if trace:
logger_debug(
' ---> ###merge_matches: '
'next overlaps in sequence current, '
'merged as new:', current_match)
del rule_matches[j]
continue
j += 1
i += 1
merged_extend(rule_matches)
return merged
# FIXME we should consider the length and distance between matches to break
# early from the loops: trying to check containment on wildly separated matches
# does not make sense
def filter_contained_matches(
matches,
trace=TRACE_FILTER_CONTAINED,
reason=DiscardReason.CONTAINED,
):
"""
Return a filtered list of kept LicenseMatch matches and a list of
discardable matches given a `matches` list of LicenseMatch by removing
matches that are contained in larger matches.
For instance a match entirely contained in another bigger match is removed.
When more than one matched position matches the same license(s), only one
match of this set is kept.
"""
# do not bother if there is only one match
if len(matches) < 2:
return matches, []
discarded = []
discarded_append = discarded.append
# NOTE: we do not filter matches in place: sorted creates a copy
# sort on start, longer high, longer match, matcher type
sorter = lambda m: (m.qspan.start, -m.hilen(), -m.len(), m.matcher)
matches = sorted(matches, key=sorter)
matches_pop = matches.pop
if trace:
print('filter_contained_matches: number of matches to process:', len(matches))