-
Notifications
You must be signed in to change notification settings - Fork 50
/
famdb.py
executable file
·881 lines (771 loc) · 29.2 KB
/
famdb.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
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
"""
Usage: famdb.py [-h] [-l LOG_LEVEL] [-i DB_DIR] command ...
Queries or modifies the contents of a famdb file. For more detailed help
and information about program options, run `famdb.py --help` or
`famdb.py <command> --help`.
This program can also be used as a module. It provides classes and methods
for working with FamDB files, which contain Transposable Element (TE)
families and associated taxonomy data.
# Classes
Family: Metadata and model of a TE family.
FamDB: HDF5-based format for storing Family objects.
SEE ALSO:
Dfam: http://www.dfam.org
AUTHOR(S):
Anthony Gray <anthony.gray@systemsbiology.org>
Jeb Rosen <jeb.rosen@systemsbiology.org>
LICENSE:
This code may be used in accordance with the Creative Commons
Zero ("CC0") public domain dedication:
https://creativecommons.org/publicdomain/zero/1.0/
DISCLAIMER:
This software is provided ``AS IS'' and any express or implied
warranties, including, but not limited to, the implied warranties of
merchantability and fitness for a particular purpose, are disclaimed.
In no event shall the authors or the Dfam consortium members be
liable for any direct, indirect, incidental, special, exemplary, or
consequential damages (including, but not limited to, procurement of
substitute goods or services; loss of use, data, or profits; or
business interruption) however caused and on any theory of liability,
whether in contract, strict liability, or tort (including negligence
or otherwise) arising in any way out of the use of this software, even
if advised of the possibility of such damage.
"""
import argparse
import json
import logging
import os
import re
import sys
from famdb_globals import (
LOGGER,
FILE_DESCRIPTION,
FAMILY_FORMATS_EPILOG,
REPBASE_FILE,
MISSING_FILE,
HELP_URL,
)
from famdb_helper_classes import Family
from famdb_classes import FamDB
# Command-line utilities
def command_info(args):
"""The 'info' command displays some of the stored metadata."""
db_info = args.db_dir.get_db_info()
counts = args.db_dir.get_counts()
f_info = args.db_dir.get_metadata()
print()
print(
f"""\
FamDB Directory : {os.path.realpath(args.db_dir.db_dir)}
FamDB Generator : {f_info["generator"]}
FamDB Format Version: {f_info["version"]}
FamDB Creation Date : {f_info["created"]}
Database: {db_info["name"]}
Version : {db_info["version"]}
Date : {db_info["date"]}
{db_info["description"]}
{counts['file']} Partitions Present
Total consensus sequences present: {counts["consensus"]}
Total HMMs present : {counts["hmm"]}
"""
)
args.db_dir.show_files()
def command_names(args):
"""The 'names' command displays all names of all taxa that match the search term."""
entries = []
entries += args.db_dir.resolve_names(args.term)
if args.format == "pretty":
prev_exact = None
for tax_id, is_exact, partition, names in entries:
if is_exact != prev_exact:
if is_exact:
print("Exact Matches\n=============")
else:
if prev_exact:
print()
print("Non-exact Matches\n=================")
prev_exact = is_exact
print(
f"Taxon: {tax_id}, Partition: {partition}, Names: {', '.join([f'{n[1]} ({n[0]})' for n in names])}"
)
elif args.format == "json":
obj = []
for tax_id, is_exact, partition, names in entries:
names_obj = [{"kind": name[0], "value": name[1]} for name in names]
obj += [{"id": tax_id, "partition": partition, "names": names_obj}]
print(json.dumps(obj))
else:
raise ValueError("Unimplemented names format: %s" % args.format)
def print_lineage_tree(
file,
tree,
partition,
gutter_self,
gutter_children,
uncurated_only=False,
curated_only=False,
):
"""Pretty-prints a lineage tree with box drawing characters."""
if not tree:
return
if type(tree) == str:
tax_id = tree
children = []
else:
tax_id = tree[0]
children = tree[1:]
if "_link:" in str(tax_id):
tax_id = str(tax_id).split(":")[1]
name, tax_partition = file.get_taxon_name(tax_id, "scientific name")
if name != "Not Found":
fams = file.get_families_for_taxon(
tax_id,
tax_partition,
curated_only=curated_only,
uncurated_only=uncurated_only,
)
missing_message = MISSING_FILE % (tax_partition, file.db_dir, HELP_URL)
missing_message = (
missing_message.replace("\t", f"{gutter_self[:-2]}│ * \t")
+ f"\n{gutter_self[:-2]}│"
)
count = f"[{len(fams)}]" if fams is not None else missing_message
print(f"{gutter_self}{tax_id} {name}({tax_partition}) {count}")
# All but the last child need a downward-pointing line that will link up
# to the next child, so this is split into two cases
if len(children) > 1:
for child in children[:-1]:
print_lineage_tree(
file,
child,
tax_partition,
gutter_children + "├─",
gutter_children + "│ ",
curated_only,
uncurated_only,
)
if children:
print_lineage_tree(
file,
children[-1],
tax_partition,
gutter_children + "└─",
gutter_children + " ",
curated_only,
uncurated_only,
)
def print_lineage_semicolons(
file,
tree,
partition,
parent_name,
starting_at,
curated_only=False,
uncurated_only=False,
):
"""
Prints a lineage tree as a flat list of semicolon-delimited names.
In order to print the correct lineage string, the available tree must
be "complete" even if ancestors were not specified to build up the
string starting from "root". 'starting_at' specifies the first taxa
(in the descending direction) to actually be output.
"""
if not tree:
return
tax_id = tree[0]
children = tree[1:]
name, tax_partition = file.get_taxon_name(tax_id, "scientific name")
if name != "Not Found":
if parent_name:
name = parent_name + ";" + name
if starting_at == tax_id:
starting_at = None
if not starting_at:
fams = file.get_families_for_taxon(
tax_id, tax_partition, curated_only, uncurated_only
)
count = (
f"[{len(fams)}]"
if fams is not None
else f"(Taxon in Partition {tax_partition}, Partition File Not Found)"
)
print(f"{tax_id}({tax_partition}): {name} {count}")
for child in children:
print_lineage_semicolons(
file,
child,
tax_partition,
name,
starting_at,
curated_only,
uncurated_only,
)
def get_lineage_totals(
file,
tree,
target_id,
partition,
curated_only=False,
uncurated_only=False,
seen=None,
present=None,
):
"""
Recursively calculates the total number of families
on ancestors and descendants of 'target_id' in the given 'tree'.
'seen' is required to track families that are present on multiple
lineages due to horizontal transfer and ensure each family
is only counted one time, either as an ancestor or a descendant.
"""
if not seen:
seen = set()
if not present:
present = set()
tax_id = tree[0]
children = tree[1:]
accessions = file.get_families_for_taxon(
tax_id, partition, curated_only, uncurated_only
)
count_here = 0
for acc in accessions:
if acc not in seen:
seen.add(acc)
count_here += 1
if target_id == tax_id:
target_id = None
counts = [0, 0]
for child in children:
partition = file.find_taxon(tax_id)
if partition is not None:
new_counts, new_present = get_lineage_totals(
file,
child,
target_id,
partition,
curated_only,
uncurated_only,
seen,
present,
)
counts[0] += new_counts[0]
counts[1] += new_counts[1]
present.add(partition)
present.update(new_present)
if target_id is None:
counts[1] += count_here
else:
counts[0] += count_here
return counts, present
def command_lineage(args):
"""The 'lineage' command outputs ancestors and/or descendants of the given taxon."""
# TODO: like 'families', filter curated or uncurated (and other filters?)
target_id, partition = args.db_dir.resolve_one_species(args.term)
if not target_id:
print(f"No species found for search term '{args.term}'", file=sys.stderr)
return
if target_id == "Ambiguous":
return
tree = args.db_dir.get_lineage_combined(
target_id,
descendants=args.descendants,
ancestors=args.ancestors or args.format == "semicolon",
)
if not tree:
return
# TODO: prune branches with 0 total
if args.format == "pretty":
print_lineage_tree(
args.db_dir, tree, partition, "", "", args.curated, args.uncurated
)
elif args.format == "semicolon":
print_lineage_semicolons(
args.db_dir, tree, partition, "", target_id, args.curated, args.uncurated
)
elif args.format == "totals":
totals, present = get_lineage_totals(
args.db_dir, tree, target_id, partition, args.curated, args.uncurated
)
present = (
", ".join([str(val) for val in present]) + ";" if present else partition
)
missing = (
" absent related partitions: "
+ ", ".join([str(val) for val in set(tree.missing.values())])
if hasattr(tree, "missing")
else ""
)
print(
f"{totals[0]} entries in ancestors; {totals[1]} lineage-specific entries; found in partitions: {present}{missing}"
)
else:
raise ValueError("Unimplemented lineage format: %s" % args.format)
def print_families(args, families, header, species=None):
"""
Prints each family in 'families', optionally with a copyright header. The
format is determined by 'args.format' and additional data (such as
taxonomy) is taken from 'args.db_dir'.
If 'species' is provided and the format is "hmm_species", it is the id of
the taxa whose species-specific thresholds should be substituted into the
GA, NC, and TC lines of the HMM.
"""
# These args are only available with the "families" command. When
# print_families is called by the "family" command, accessing e.g.
# args.stage directly raises an AttributeError
# TODO: consider reworking argument passing to avoid this workaround
add_reverse_complement = getattr(args, "add_reverse_complement", False)
include_class_in_name = getattr(args, "include_class_in_name", False)
require_general_threshold = getattr(args, "require_general_threshold", False)
stage = getattr(args, "stage", None)
if header:
db_info = args.db_dir.get_db_info()
if db_info:
copyright_text = db_info["copyright"]
# Add appropriate comment character to the copyright header lines
if "hmm" in args.format:
copyright_text = re.sub("(?m)^", "# ", copyright_text)
elif "fasta" in args.format:
copyright_text = None
elif "embl" in args.format:
copyright_text = re.sub("(?m)^", "CC ", copyright_text)
if copyright_text:
print(copyright_text)
for family in families:
if args.format == "summary":
if include_class_in_name:
name = family.name or family.accession
rm_class = family.repeat_type
if family.repeat_subtype:
rm_class += "/" + family.repeat_subtype
family.name = name + "#" + rm_class
entry = str(family) + "\n"
elif args.format == "hmm":
entry = family.to_dfam_hmm(
args.db_dir,
include_class_in_name=include_class_in_name,
require_general_threshold=require_general_threshold,
)
elif args.format == "hmm_species":
entry = family.to_dfam_hmm(
args.db_dir,
species,
include_class_in_name=include_class_in_name,
require_general_threshold=require_general_threshold,
)
elif (
args.format == "fasta"
or args.format == "fasta_name"
or args.format == "fasta_acc"
):
use_accession = args.format == "fasta_acc"
buffers = []
if stage and family.buffer_stages:
for spec in family.buffer_stages.split(","):
if "[" in spec:
matches = re.match(r"(\d+)\[(\d+)-(\d+)\]", spec.strip())
if matches:
if stage == int(matches.group(1)):
buffers += [
[int(matches.group(2)), int(matches.group(3))]
]
else:
LOGGER.warning(
"Ingored invalid buffer specification: '%s'",
spec.strip(),
)
else:
buffers += [stage == int(spec)]
if not buffers:
buffers += [None]
entry = ""
for buffer_spec in buffers:
entry += (
family.to_fasta(
args.db_dir,
use_accession=use_accession,
include_class_in_name=include_class_in_name,
buffer=buffer_spec,
)
or ""
)
if add_reverse_complement:
entry += (
family.to_fasta(
args.db_dir,
use_accession=use_accession,
include_class_in_name=include_class_in_name,
do_reverse_complement=True,
buffer=buffer_spec,
)
or ""
)
elif args.format == "embl":
entry = family.to_embl(args.db_dir)
elif args.format == "embl_meta":
entry = family.to_embl(args.db_dir, include_meta=True, include_seq=False)
elif args.format == "embl_seq":
entry = family.to_embl(args.db_dir, include_meta=False, include_seq=True)
else:
raise ValueError("Unimplemented family format: %s" % args.format)
if entry:
print(entry, end="")
def command_family(args):
"""The 'family' command outputs a single family by name or accession."""
family = args.db_dir.get_family_by_accession(args.accession)
if not family:
family = args.db_dir.get_family_by_name(args.accession)
if family:
print_families(args, [family], False)
def command_families(args):
"""The 'families' command outputs all families associated with the given taxon."""
target_id, partition = args.db_dir.resolve_one_species(args.term)
if not target_id:
print(f"No species found for search term '{args.term}'", file=sys.stderr)
return
elif target_id == "Ambiguous":
return
families = []
is_hmm = args.format.startswith("hmm")
# NB: This is speed-inefficient, because get_accessions_filtered needs to
# read the whole family data even though we read it again right after.
# However it is *much* more memory-efficient than loading all the family
# data at once and then sorting by accession.
accessions = sorted(
args.db_dir.get_accessions_filtered(
tax_id=target_id,
descendants=args.descendants,
ancestors=args.ancestors,
curated_only=args.curated,
uncurated_only=args.uncurated,
is_hmm=is_hmm,
stage=args.stage,
repeat_type=args.repeat_type,
name=args.name,
)
)
families = map(args.db_dir.get_family_by_accession, accessions)
header = True if accessions else False
print_families(args, families, header, target_id)
# RepeatMasker Commands -----------------------------------------------------------------------
def command_fasta_all(args):
"""
command prints out all curated families in FASTA format
This command is not documented in the help. It is used to export all of the curated families
to FASTA format for use by RepeatMasker
"""
args.format = "fasta_name"
args.include_class_in_name = True
print_families(args, args.db_dir.fasta_all("/DF"), True, 1)
print_families(args, args.db_dir.fasta_all("/Aux"), True, 1)
def command_append(args):
"""
The 'append' command reads an EMBL file and appends its entries to an
existing famdb file.
"""
lookup = args.db_dir.get_all_taxa_names()
repbase_lookup = {}
with open(REPBASE_FILE) as file:
repbase_lookup = json.load(file)
lookup.update(repbase_lookup)
header = None
def set_header(val):
nonlocal header
header = val
embl_iter = Family.read_embl_families(args.infile, lookup, set_header)
total_ctr = 0
added_ctr = 0
dups = set()
for entry in embl_iter:
total_ctr += 1
acc = entry.accession
# prepare set of local files to add family to
add_files = set()
for clade in entry.clades:
for file in args.db_dir.files:
if args.db_dir.files[file].has_taxon(clade):
add_files.add(file)
if not add_files:
LOGGER.debug(f" {acc} not added to local files, local file not found")
for file in add_files:
try:
args.db_dir.files[file].add_family(entry)
LOGGER.debug(f"Added {acc} to file {file}")
added_ctr += 1
except Exception as e:
LOGGER.debug(f" Ignoring duplicate entry {entry.accession}: {e}")
dups.add(entry.accession)
LOGGER.info(f"Added {added_ctr}/{total_ctr} families")
if dups:
LOGGER.debug(f" {len(dups)} Duplicate Accesisons: {dups}")
db_info = args.db_dir.get_db_info()
if args.name:
db_info["name"] = args.name
if args.description:
db_info["description"] += "\n" + args.description
db_info["copyright"] += f"\n\n{header}"
args.db_dir.set_db_info(
db_info["name"],
db_info["version"],
db_info["date"],
db_info["description"],
db_info["copyright"],
)
# Write the updated counts and metadata
args.db_dir.finalize()
def main(): # ================================================================================================================================
"""Parses command-line arguments and runs the requested command."""
logging.basicConfig()
parser = argparse.ArgumentParser(
description=FILE_DESCRIPTION,
formatter_class=argparse.RawDescriptionHelpFormatter,
)
parser.add_argument("-l", "--log_level", default="INFO")
parser.add_argument("-i", "--db_dir", help="specifies the directory to query")
subparsers = parser.add_subparsers(
description="""Specifies the kind of query to perform.
For more information on all the possible options for a command, add the --help option after it:
famdb.py families --help
""",
# metavar, if specified overrides what shows up on the help line as valid
# subcommands. All subcommands will however be printed in the error message
# if a bad subcommand is entered as a possibility, so it doesn't hide it
# completely. This is added to hide the new fasta_all command.
metavar="{info,names,lineage,families,family,append}",
)
# INFO --------------------------------------------------------------------------------------------------------------------------------
p_info = subparsers.add_parser(
"info", description="List general information about the file."
)
p_info.set_defaults(func=command_info)
# NAMES --------------------------------------------------------------------------------------------------------------------------------
p_names = subparsers.add_parser(
"names", description="List the names and taxonomy identifiers of a clade."
)
p_names.add_argument(
"-f",
"--format",
default="pretty",
choices=["pretty", "json"],
metavar="<format>",
help="choose output format. The default is 'pretty'. 'json' is more appropriate for scripts.",
)
p_names.add_argument(
"term",
nargs="+",
help="search term. Can be an NCBI taxonomy identifier or part of a scientific or common name",
)
p_names.set_defaults(func=command_names)
# LINEAGE --------------------------------------------------------------------------------------------------------------------------------
p_lineage = subparsers.add_parser(
"lineage",
description="List the taxonomy tree including counts of families at each clade.",
)
p_lineage.add_argument(
"-a",
"--ancestors",
action="store_true",
help="include all ancestors of the given clade",
)
p_lineage.add_argument(
"-d",
"--descendants",
action="store_true",
help="include all descendants of the given clade",
)
p_lineage.add_argument(
"-c",
"--curated",
action="store_true",
help="only tabulate curated families ('DF' records)",
)
p_lineage.add_argument(
"-u",
"--uncurated",
action="store_true",
help="only tabulate uncurated families ('DR' records)",
)
p_lineage.add_argument(
"-f",
"--format",
default="pretty",
choices=["pretty", "semicolon", "totals"],
metavar="<format>",
help="choose output format. The default is 'pretty'. 'semicolon' is more appropriate for scripts. 'totals' displays the number of ancestral and lineage-specific families found.",
)
p_lineage.add_argument(
"term",
nargs="+",
help="search term. Can be an NCBI taxonomy identifier or an unambiguous scientific or common name",
)
p_lineage.set_defaults(func=command_lineage)
# FAMILIES --------------------------------------------------------------------------------------------------------------------------------
family_formats = [
"summary",
"hmm",
"hmm_species",
"fasta_name",
"fasta_acc",
"embl",
"embl_meta",
"embl_seq",
]
family_formats_epilog = FAMILY_FORMATS_EPILOG
p_families = subparsers.add_parser(
"families",
description="Retrieve the families associated \
with a given clade, optionally filtered by additional criteria",
epilog=family_formats_epilog,
formatter_class=argparse.RawDescriptionHelpFormatter,
)
p_families.add_argument(
"-a",
"--ancestors",
action="store_true",
help="include all ancestors of the given clade",
)
p_families.add_argument(
"-d",
"--descendants",
action="store_true",
help="include all descendants of the given clade",
)
p_families.add_argument(
"--stage",
type=int,
help="include only families that should be searched in the given stage",
)
p_families.add_argument(
"--class",
dest="repeat_type",
type=str,
help="include only families that have the specified repeat Type/SubType",
)
p_families.add_argument(
"--name",
type=str,
help="include only families whose name begins with this search term",
)
p_families.add_argument(
"--uncurated",
action="store_true",
help="include only 'uncurated' families (i.e. named DRXXXXXXXXX)",
)
p_families.add_argument(
"--curated",
action="store_true",
help="include only 'curated' families (i.e. not named DFXXXXXXXXX)",
)
p_families.add_argument(
"-f",
"--format",
default="summary",
choices=family_formats,
metavar="<format>",
help="choose output format.",
)
p_families.add_argument(
"--add-reverse-complement",
action="store_true",
help="include a reverse-complemented copy of each matching family; only suppported for fasta formats",
)
p_families.add_argument(
"--include-class-in-name",
action="store_true",
help="include the RepeatMasker type/subtype after the name (e.g. HERV16#LTR/ERVL); only supported for hmm and fasta formats",
)
p_families.add_argument(
"--require-general-threshold",
action="store_true",
help="skip families missing general thresholds (and log their accessions at the debug log level)",
)
p_families.add_argument(
"term",
nargs="+",
help="search term. Can be an NCBI taxonomy identifier or an unambiguous scientific or common name",
)
p_families.set_defaults(func=command_families)
# FAMILY --------------------------------------------------------------------------------------------------------------------------------
p_family = subparsers.add_parser(
"family",
description="Retrieve details of a single family.",
epilog=family_formats_epilog,
formatter_class=argparse.RawDescriptionHelpFormatter,
)
p_family.add_argument(
"-f",
"--format",
default="summary",
choices=family_formats,
metavar="<format>",
help="choose output format.",
)
p_family.add_argument(
"accession", help="the accession of the family to be retrieved"
)
p_family.set_defaults(func=command_family)
# APPEND --------------------------------------------------------------------------------------------------------------------------------
p_append = subparsers.add_parser("append")
p_append.add_argument("infile", help="the name of the input file to be appended")
p_append.add_argument(
"--name", help="new name for the database (replaces the existing name)"
)
p_append.add_argument(
"--description",
help="additional database description (added to the existing description)",
)
p_append.set_defaults(func=command_append)
# FASTA ALL --------------------------------------------------------------------------------------------------------------------------------
p_fasta = subparsers.add_parser("fasta_all")
p_fasta.set_defaults(func=command_fasta_all)
args = parser.parse_args()
logging.getLogger().setLevel(getattr(logging, args.log_level.upper()))
if "func" in args and args.func is command_append:
mode = "r+"
else:
mode = "r"
if "term" in args:
args.term = " ".join(args.term)
# For RepeatMasker: Try Libraries/RepeatMaskerLib.h5, if no file was specified
# in the arguments and that file exists.
if not args.db_dir:
# sys.path[0], if non-empty, is initially set to the directory of the
# originally-invoked script.
if sys.path[0]:
default_db_dir = os.path.join(sys.path[0], "Libraries/famdb")
if os.path.exists(default_db_dir):
args.db_dir = default_db_dir
if args.db_dir and os.path.isdir(args.db_dir):
try:
args.db_dir = FamDB(args.db_dir, mode)
except:
args.db_dir = None
# exc_value = sys.exc_info()[1]
# LOGGER.error("Error reading file: %s", exc_value)
# if LOGGER.getEffectiveLevel() <= logging.DEBUG:
# raise
raise
else:
# LOGGER.info(" No file directory specified, minimal initialization used")
# args.db_dir = FamDB(args.db_dir, mode, min=True)
LOGGER.error("Please specify a file to operate on with the -i/--file option.")
if not args.db_dir:
return
if "func" in args:
try:
args.func(args)
except Exception as e:
print(f"Double-Check Command: {e}")
else:
parser.print_help()
if __name__ == "__main__":
try:
main()
except BrokenPipeError:
# This workaround is from
# https://docs.python.org/3/library/signal.html#note-on-sigpipe
# Python flushes standard streams on exit; redirect remaining output
# to devnull to avoid another BrokenPipeError at shutdown
devnull = os.open(os.devnull, os.O_WRONLY)
os.dup2(devnull, sys.stdout.fileno())
sys.exit(1) # Python exits with error code 1 on EPIPE