rustkmer 0.5.2

High-performance k-mer counting tool in Rust
Documentation
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
#!/usr/bin/env python3
"""
使用k-mer数据库填充FASTA文件中的N区域

Usage:
    python pyo3_fill_fasta.py -i input.fa -o output.fa -d database.rkdb [options]
"""

import pyfastx
import argparse
import sys
import os
from pathlib import Path
from tqdm import tqdm

# from collections import defaultdict  # Not currently used
import re

try:
    import pyrustkmer
except ImportError as e:
    print(f"❌ 无法导入 pyrustkmer 模块: {e}")
    print("💡 请确保已正确构建 PyO3 扩展")
    sys.exit(1)


def get_N_positions(seq):
    return [i for i, c in enumerate(seq) if c == "N"]


def get_consecutive_N_regions(seq):
    """
    Identify consecutive N regions in a sequence and return them as dictionaries.

    Returns:
        A list of dictionaries, where each dictionary contains 'nstart' and 'nend' keys
        representing start and end positions of a consecutive N region.
        If there are no N's, returns an empty list.

    Example:
        For sequence "ATGNNNATCNNNGAT", the function returns
        [{'nstart': 3, 'nend': 5}, {'nstart': 9, 'nend': 11}]
    """
    N_positions = get_N_positions(seq)
    if not N_positions:
        return []

    # Group consecutive N positions and create dictionaries for each region
    regions = []
    nstart = N_positions[0]
    nend = N_positions[0]

    for i in range(1, len(N_positions)):
        if N_positions[i] == N_positions[i - 1] + 1:  # Consecutive N
            nend = N_positions[i]
        else:
            regions.append({"nstart": nstart, "nend": nend})
            nstart = N_positions[i]
            nend = N_positions[i]

    regions.append({"nstart": nstart, "nend": nend})  # Add the last region
    return regions


def build_kmer_pattern(seq, nstart, nend, kmerlen, n_length, debug_mode=False):
    if n_length > kmerlen - 2:
        n_length = kmerlen - 2

    print(f"nstart: {nstart}, nend: {nend}, kmerlen: {kmerlen}, n_length: {n_length}")

    # Use the provided n_length parameter, don't recalculate
    half_flanking_length = int((kmerlen - n_length) / 2)

    need_add_n = 0

    if nstart - half_flanking_length < 0:
        left_flanking_seq = seq[0:nstart]
        need_add_n = half_flanking_length - nstart
    else:
        left_flanking_seq = seq[nstart - half_flanking_length : nstart]

    if nend + 1 + half_flanking_length > len(seq):
        right_flanking_seq = seq[nend + 1 :]
        need_add_n = half_flanking_length - (len(seq) - nend - 1)
    else:
        right_flanking_seq = seq[nend + 1 : nend + 1 + half_flanking_length]

    total_n = n_length + need_add_n

    # Check if total length is insufficient and need to adjust
    if total_n + len(left_flanking_seq) + len(right_flanking_seq) < kmerlen:
        # Need to increase N count to reach kmerlen
        deficit = kmerlen - (total_n + len(left_flanking_seq) + len(right_flanking_seq))
        total_n += deficit
        need_add_n += deficit

    # Ensure we don't exceed sequence boundaries when recalculating
    if nstart - len(left_flanking_seq) < 0:
        left_flanking_seq = seq[0:nstart]
    if nend + 1 + len(right_flanking_seq) > len(seq):
        right_flanking_seq = seq[nend + 1 :]
        available_downstream = len(seq) - nend - 1
        deficit = len(right_flanking_seq) - available_downstream
        total_n += deficit
        need_add_n += deficit
    #########################################################

    pattern = left_flanking_seq + "{N" + str(total_n) + "}" + right_flanking_seq

    if debug_mode:
        print(f"left_flanking_seq: {left_flanking_seq}, {len(left_flanking_seq)}")
        print(f"total_n: {total_n}")
        print(f"right_flanking_seq: {right_flanking_seq}, {len(right_flanking_seq)}")
        print({len(left_flanking_seq) + total_n + len(right_flanking_seq)})
        print(f"pattern: {pattern}")

    return pattern


def get_candidate_kmer(results):
    """
    从查询结果中选择最佳的kmer
    """
    if not results:
        return None

    # 按count降序排序 (count_str应该是字符串,需要转换为数字)
    try:
        results_list = sorted(results.items(), key=lambda x: int(x[1]), reverse=True)
        print("\\n排序后的结果:")
        for i, (kmer, count_str) in enumerate(results_list[:3]):
            print(f"  {i + 1}. 计数: {count_str}, kmer: {kmer[:30]}...{kmer[-20:]}")

        # 获取最高计数的kmer
        max_count = int(results_list[0][1])
        max_count_kmers = [
            result for result in results_list if int(result[1]) == max_count
        ]

        print(f"\\n最高计数 ({max_count}) 的kmer有 {len(max_count_kmers)}")

        # 如果有多个相同计数的kmer,选择 polymers 最少的
        if len(max_count_kmers) > 1:
            print("选择polymers最少的kmer...")
            # 这里需要实现polymers计算逻辑
            # 暂时选择第一个
            chosen_kmer = max_count_kmers[0][0]
            print(f"选择: {chosen_kmer}")
        else:
            chosen_kmer = max_count_kmers[0][0]
            print(f"唯一选择: {chosen_kmer}")

    except ValueError as e:
        print(f"转换计数时出错: {e}")
        # 如果无法转换为数字,直接使用第一个结果
        chosen_kmer = list(results.keys())[0]
        print(f"使用第一个结果: {chosen_kmer}")

    return chosen_kmer


def replace_N_region(seq, kmer_pattern, chosen_kmer):
    """
    Replace N region in sequence based on kmer_pattern and chosen_kmer.

    Args:
        seq: Original sequence containing N regions
        kmer_pattern: Pattern like 'TGGGTT{N45}GAGAAT' containing upstream{N_count}downstream
        chosen_kmer: Full kmer sequence that matches the pattern

    Returns:
        Sequence with N region replaced by the appropriate part of chosen_kmer
    """
    import re

    # 解析 kmer_pattern 来提取上游和下游序列
    pattern_match = re.match(r"^(.+?)\{N(\d+)\}(.+)$", kmer_pattern)
    if not pattern_match:
        print(f"❌ 无法解析 kmer_pattern: {kmer_pattern}")
        return seq

    upstream_seq = pattern_match.group(1)
    n_length = int(pattern_match.group(2))
    downstream_seq = pattern_match.group(3)

    print(f"解析模式:")
    print(f"  上游序列: {upstream_seq}")
    print(f"  N长度: {n_length}")
    print(f"  下游序列: {downstream_seq}")

    # 查找标记序列:上游序列+最后一个N,下游序列+第一个N
    upstream_marker = upstream_seq + "N"
    downstream_marker = "N" + downstream_seq

    print(f"上游标记: {upstream_marker}")
    print(f"下游标记: {downstream_marker}")

    # 在序列中查找上游标记的位置
    upstream_pos = seq.find(upstream_marker)
    if upstream_pos == -1:
        print(f"❌ 在序列中找不到上游标记: {upstream_marker}")
        return seq

    print(f"找到上游标记位置: {upstream_pos}")

    # 在序列中查找下游序列的位置(从上游标记结束后开始)
    # 但是要处理下游标记的第一个N就是上游标记最后一个N的情况(当N长度为1时)
    downstream_seq_pos = seq.find(
        downstream_seq, upstream_pos + len(upstream_marker) - 1
    )
    if downstream_seq_pos == -1:
        print(f"❌ 在序列中找不到下游序列: {downstream_seq}")
        return seq

    print(f"找到下游序列位置: {downstream_seq_pos}")

    # 检查是否是共享N的情况(即下游标记的第一个N就是上游标记的最后一个N)
    # 在序列 "ACTTGAANACATAGA" 中:
    # 上游序列 "ACTTGAA" 在位置 44-50,N 在位置 51,下游序列 "ACATAGA" 在位置 52
    # 所以共享N的条件是:downstream_seq_pos == upstream_pos + len(upstream_seq) + 1
    shared_n = downstream_seq_pos == upstream_pos + len(upstream_seq) + 1
    if shared_n:
        print("检测到共享N的情况:下游标记的第一个N就是上游标记的最后一个N")
        downstream_pos = downstream_seq_pos - 1  # 下游标记的开始位置是N的位置
    else:
        downstream_pos = seq.find(
            downstream_marker, upstream_pos + len(upstream_marker)
        )
        if downstream_pos == -1:
            print(f"❌ 在序列中找不到下游标记: {downstream_marker}")
            return seq

    print(f"找到标记位置:")
    print(f"  上游标记位置: {upstream_pos}")
    print(f"  下游标记位置: {downstream_pos}")

    # 验证 chosen_kmer 的格式
    if not chosen_kmer.startswith(upstream_seq):
        print(f"❌ chosen_kmer 不以上游序列开头")
        return seq

    if not chosen_kmer.endswith(downstream_seq):
        print(f"❌ chosen_kmer 不以下游序列结尾")
        return seq

    # 提取 chosen_kmer 中需要填充到 N 区域的部分
    # chosen_kmer 格式: upstream_seq + fill_sequence + downstream_seq
    # N 区域应该被 fill_sequence 替换
    fill_start = len(upstream_seq)
    fill_end = len(chosen_kmer) - len(downstream_seq)
    fill_sequence = chosen_kmer[fill_start:fill_end]

    print(f"提取的填充序列: {fill_sequence}")

    # 计算替换位置
    if shared_n:
        # 共享N的情况:N区域是从上游序列结束后到下游序列开始前
        replace_start = upstream_pos + len(upstream_seq)  # 上游序列结束后
        replace_end = downstream_seq_pos  # 下游序列开始前
    else:
        # 正常情况:上游标记结束位置+1 到 下游标记开始位置-1
        replace_start = upstream_pos + len(upstream_marker)  # 上游标记结束后
        replace_end = downstream_pos + len(downstream_marker) - 1  # 下游标记开始前

    print(f"替换范围: {replace_start}{replace_end}")
    print(f"原始N区域: {seq[replace_start:replace_end]}")

    # 构建新序列:序列前缀 + 填充序列 + 序列后缀
    new_seq = seq[:replace_start] + fill_sequence + seq[replace_end:]

    print(f"替换完成")
    return new_seq


def process_single_sequence(
    seq_name, seq, db, kmerlen, max_n_length, max_retry, each_add_n, verbose=False
):
    """
    处理单个序列的N区域填充
    """
    print(f"序列名称: {seq_name}")
    print(f"原始序列: {seq[:100]}{'...' if len(seq) > 100 else ''}")

    pre_n_regions = get_consecutive_N_regions(seq)
    pre_n_regions_count = len(pre_n_regions)

    if verbose:
        print(f"初始N区域: {pre_n_regions}")

    # 使用循环处理所有N区域,每次填充后重新计算
    max_iterations = pre_n_regions_count + 3  # 防止无限循环
    iteration = 0

    while iteration < max_iterations:
        iteration += 1
        print(f"\\n=== 第 {iteration} 轮处理 ===")

        # 重新计算当前序列中的N区域
        n_regions = get_consecutive_N_regions(seq)
        n_regions_count = len(n_regions)
        print(f"N区域数量: {n_regions_count}")

        if verbose:
            print(f"N区域: {n_regions}")

        if n_regions_count == 0:
            print("✅ 所有N区域已填充完成")
            break

        # 处理第一个N区域(从左到右)
        chosen_kmer = ""
        kmer_pattern = ""

        n_region = n_regions[0]  # 总是处理第一个(最左边的)N区域
        n_start = n_region["nstart"]
        n_end = n_region["nend"]
        print(f"处理N区域: 起始位置: {n_start}, 结束位置: {n_end}")

        # 确定初始N长度
        if n_end - n_start + 1 > max_n_length:
            n_length = max_n_length
        else:
            n_length = n_end - n_start + 1

        print(f"初始N长度: {n_length}")

        # 尝试查询和填充
        filled = False

        for retry_i in range(max_retry):
            if retry_i == 0:
                current_n_length = n_length
            else:
                current_n_length = n_length + each_add_n * retry_i
                print(f"{retry_i + 1} 次尝试: N长度调整为 {current_n_length}")

            pattern = build_kmer_pattern(
                seq, n_start, n_end, kmerlen, current_n_length, debug_mode=verbose
            )

            if verbose:
                print(f"查询模式: {pattern}")

            try:
                results = db.query_hybrid(pattern)
                print(f"查询结果数量: {len(results)}")

                if len(results) > 0:
                    print("查询结果:")
                    chosen_kmer = get_candidate_kmer(results)
                    print(f"选择的kmer: {chosen_kmer}")
                    kmer_pattern = pattern
                    filled = True
                    break

            except Exception as e:
                print(f"查询失败: {e}")
                if verbose:
                    print(f"详细错误信息: {e}")
                continue

        if not filled:
            print(f"❌ 无法填充N区域 [位置 {n_start}-{n_end}]")
            # 如果无法填充,跳过这个N区域(将其缩减为较短的N区域)
            print("跳过这个N区域,继续下一个...")
            # 创建一个临时序列,将这个N区域替换为较短的N序列
            seq = seq[:n_start] + "N" * 10 + seq[n_end + 1 :]
            continue

        # 执行替换
        if chosen_kmer and kmer_pattern:
            print(f"执行替换...")
            seq = replace_N_region(seq, kmer_pattern, chosen_kmer)
            # print(f"替换后的序列: {seq[:100]}{'...' if len(seq) > 100 else ''}")
            print(f"替换后的序列: {seq}")
            print(f"序列长度: {len(seq)}")

    if iteration >= max_iterations:
        print(f"⚠️ 达到最大迭代次数 ({max_iterations}),停止处理")

    print(f"最终序列: {seq[:100]}{'...' if len(seq) > 100 else ''}")
    return seq


def main():
    parser = argparse.ArgumentParser(
        description="使用k-mer数据库填充FASTA文件中的N区域"
    )
    parser.add_argument("-i", "--input", required=True, help="输入FASTA文件路径")
    parser.add_argument("-o", "--output", required=True, help="输出FASTA文件路径")
    parser.add_argument(
        "-k", "--kmerlen", type=int, default=57, help="k-mer长度 (默认: 57)"
    )
    parser.add_argument("-d", "--database", required=True, help="k-mer数据库文件路径")
    parser.add_argument(
        "--max_n_length", type=int, default=43, help="N区域最大长度 (默认: 43)"
    )
    parser.add_argument(
        "--max_retry", type=int, default=9, help="最大重试次数 (默认: 9)"
    )
    parser.add_argument(
        "--each_add_n", type=int, default=6, help="每次重试增加的N长度 (默认: 6)"
    )
    parser.add_argument("-v", "--verbose", action="store_true", help="显示详细输出")

    args = parser.parse_args()

    kmerlen = args.kmerlen
    db_path = args.database
    max_n_length = args.max_n_length
    max_retry = args.max_retry
    each_add_n = args.each_add_n
    verbose = args.verbose

    try:
        db = pyrustkmer.PyDatabase(db_path, pyrustkmer.LoadMode.Preload)
        print(f"✅ 成功加载数据库: {db_path}")
    except Exception as e:
        print(f"❌ 无法加载数据库: {e}")
        sys.exit(1)

    # 检查输入文件是否存在
    if not os.path.exists(args.input):
        print(f"❌ 输入文件不存在: {args.input}")
        sys.exit(1)

    print(f"📁 输入文件: {args.input}")
    print(f"📁 输出文件: {args.output}")
    print(f"🧬 k-mer长度: {kmerlen}")
    print(f"🗃️ 数据库: {db_path}")
    print(f"📏 最大N长度: {max_n_length}")
    print(f"🔄 最大重试次数: {max_retry}")
    print(f"➕ 每次增加N长度: {each_add_n}")

    # 读取FASTA文件
    print(f"\\n📖 读取FASTA文件...")
    try:
        fastx_obj = pyfastx.Fasta(args.input)
        sequences = []

        # 处理每个序列
        # for i, (name, seq) in enumerate(fasta):
        #     print(f"\\n=== 处理序列 {i+1}/{len(fasta)}: {name} ===")
        #     print(f"原始序列长度: {len(seq)}")
        i = 0
        for seqobj in fastx_obj:
            name = seqobj.name
            seq = seqobj.seq

            print(f"处理序列: {name}, {len(fastx_obj)}")

            # 处理单个序列的N区域填充
            processed_seq = process_single_sequence(
                name, seq, db, kmerlen, max_n_length, max_retry, each_add_n, verbose
            )

            sequences.append((name, processed_seq))
            print(f"处理后序列长度: {len(processed_seq)}")

    except Exception as e:
        print(f"❌ 读取FASTA文件失败: {e}")
        sys.exit(1)

    # 写入输出文件
    print(f"\\n💾 写入输出文件...")
    try:
        with open(args.output, "w") as f:
            for name, seq in sequences:
                f.write(f">{name}\\n")
                # 每行写入80个字符
                for i in range(0, len(seq), 80):
                    f.write(f"{seq[i : i + 80]}\\n")
                f.write("\\n")
        print(f"✅ 成功写入输出文件: {args.output}")
    except Exception as e:
        print(f"❌ 写入输出文件失败: {e}")
        sys.exit(1)


if __name__ == "__main__":
    main()