File: check.py

package info (click to toggle)
cat-bat 6.0.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 6,444 kB
  • sloc: python: 4,677; sh: 53; makefile: 4
file content (389 lines) | stat: -rw-r--r-- 11,488 bytes parent folder | download
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
#!/usr/bin/env python3

import hashlib
import os
import subprocess
import sys

import shared


def check_md5_gz(gz_file, md5_file, log_file, quiet):
    message = "Checking file integrity via MD5 checksum."
    shared.give_user_feedback(message, log_file, quiet)

    with open(md5_file, "r") as f1:
        md5_exp = f1.read().strip().split(" ")[0]

    if md5_exp == "":
        message = ("no MD5 found in {0}. Integrity of {1} cannot be "
                   "established.".format(md5_file, gz_file))
        shared.give_user_feedback(message, log_file, quiet, warning=True)
    else:
        md5 = gz_md5(gz_file)

        if md5 != md5_exp:
            message = "MD5 of {0} does not check out.".format(gz_file)
            shared.give_user_feedback(message, log_file, quiet, error=True)

            sys.exit(1)
        else:
            message = "MD5 of {0} checks out.".format(gz_file)
            shared.give_user_feedback(message, log_file, quiet)

    return


def gz_md5(input_gz, block_size=4096):
    message = "Calculating md5sum for file {0}".format(input_gz)
    shared.give_user_feedback(message)
    md5 = hashlib.md5()
    with open(input_gz, "rb") as f1:
        for chunk in iter(lambda: f1.read(block_size), b""):
            md5.update(chunk)

    return md5.hexdigest()


def check_memory(Gb):
    total_memory = None
    error = False
    
    if sys.platform == "linux" or sys.platform == "linux2":
        # It"s a Linux!
        meminfo_file = "/proc/meminfo"
        with open(meminfo_file, "r") as f1:
            for line in f1:
                if line.startswith("MemTotal:"):
                    mem = int(line.split(" ")[-2])

                    # Mem is given in Kb, convert to Gb.
                    total_memory = mem / 2 ** 20
    elif sys.platform == "darwin":
        # It"s a Mac!
        meminfo = subprocess.check_output(["sysctl", "hw.memsize"])
        mem = int(meminfo.decode("utf-8").rstrip().split(" ")[-1])
        
        # Mem is given in b, convert to Gb.
        total_memory = mem / 2 ** 30
        
    if total_memory < Gb:
        error = True
        
    return ("{0:.1f}".format(total_memory), error)


def check_out_prefix(out_prefix, log_file, quiet):
    error = False

    if os.path.isdir(out_prefix):
        message = ("prefix for output files ({0}) is a directory."
                   "".format(out_prefix))
        shared.give_user_feedback(message, log_file, quiet, error=True)

        error = True

    dir_ = out_prefix.rsplit("/", 1)[0]

    if not os.path.isdir(dir_):
        message = ("cannot find output directory {0} to which output files "
                   "should be written.".format(dir_))
        shared.give_user_feedback(message, log_file, quiet, error=True)

        error = True

    return error


def check_prodigal_binaries(path_to_prodigal, log_file, quiet):
    error = False

    try:
        p = subprocess.Popen([path_to_prodigal, "-v"], stderr=subprocess.PIPE)
        c = p.communicate()
        output = c[1].decode().rstrip().lstrip()

        message = "Prodigal found: {0}.".format(output)
        shared.give_user_feedback(message, log_file, quiet)
    except OSError:
        message = ("cannot find Prodigal. Please check whether it is "
                   "installed or the path to the binaries is provided.")
        shared.give_user_feedback(message, log_file, quiet, error=True)

        error = True

    return error


def check_diamond_binaries(path_to_diamond, log_file, quiet):
    error = False

    try:
        p = subprocess.Popen([path_to_diamond, "--version"],
                             stdout=subprocess.PIPE)
        c = p.communicate()
        output = c[0].decode().rstrip()

        message = "DIAMOND found: {0}.".format(output)
        shared.give_user_feedback(message, log_file, quiet)
    except OSError:
        message = ("cannot find DIAMOND. Please check whether it is "
                   "installed or the path to the binaries is provided.")
        shared.give_user_feedback(message, log_file, quiet, error=True)

        error = True

    return error


def check_bwa_binaries(path_to_bwa, log_file, quiet):
    error = False

    try:
        p = subprocess.Popen([path_to_bwa],
                             stderr=subprocess.PIPE)
        for line in p.stderr:
            line=line.decode("utf-8")
            if line.startswith('Version'):
                output = line.rstrip()
                message = 'bwa found: {0}.'.format(output)
                shared.give_user_feedback(message, log_file, quiet)
    except OSError:
        message = ('can not find bwa. Please check whether it is '
                'installed or the path to the binaries is provided.')
        shared.give_user_feedback(message, log_file, quiet, error=True)

        error = True

    return error


def check_samtools_binaries(path_to_samtools, log_file, quiet):
    error = False

    try:
        p = subprocess.Popen([path_to_samtools, '--version'],
                             stdout=subprocess.PIPE)
        c = p.communicate()
        output = c[0].decode().split('\n')[0].rstrip()

        message = 'samtools found: {0}.'.format(output)
        shared.give_user_feedback(message, log_file, quiet)
    except OSError:
        message = ('can not find samtools. Please check whether it is '
                'installed or the path to the binaries is provided.')
        shared.give_user_feedback(message, log_file, quiet, error=True)

        error = True

    return error


def check_bin_folder(bin_folder, bin_suffix, log_file, quiet):
    error = False

    if not os.path.isdir(bin_folder):
        message = "cannot find the bin folder."
        shared.give_user_feedback(message, log_file, quiet, error=True)

        error = True

        return error
    
    tmp = []
    for file_ in os.listdir(bin_folder):
        if file_.startswith("."):
            # Skip hidden files.
            continue

        if not file_.endswith(bin_suffix):
            continue

        if ".concatenated." in file_:
            # Skip concatenated contig fasta and predicted protein fasta files
            # from earlier runs.
            continue
        
        tmp.append(file_)

    if len(tmp) == 0:
        message = (
            "no bins found with suffix {0} in bin folder. You can set the "
            "suffix with the [-s / --bin_suffix] argument.".format(bin_suffix)
        )
        shared.give_user_feedback(message, log_file, quiet, error=True)

        error = True

    return error


def check_bin_fasta(bin_fasta, log_file, quiet):
    error = False

    if check_fasta(bin_fasta, log_file, quiet):
        error = True

    return error


def check_folders_for_run(
        taxonomy_folder,
        nodes_dmp,
        names_dmp,
        database_folder,
        diamond_database,
        fastaid2LCAtaxid_file,
        taxids_with_multiple_offspring_file,
        step_list,
        log_file,
        quiet
):
    error = False

    if not os.path.isdir(taxonomy_folder):
        message = "cannot find the taxonomy folder."
        shared.give_user_feedback(message, log_file, quiet, error=True)

        error = True
    else:
        if not nodes_dmp or not names_dmp:
            message = ("nodes.dmp and / or names.dmp not found in the "
                       "taxonomy folder.")
            shared.give_user_feedback(message, log_file, quiet, error=True)

            error = True

    if not os.path.isdir(database_folder):
        message = "cannot find the database folder."
        shared.give_user_feedback(message, log_file, quiet, error=True)

        error = True
    else:
        if not diamond_database and "align" in step_list:
            message = "DIAMOND database not found in database folder."
            shared.give_user_feedback(message, log_file, quiet, error=True)

            error = True

        if not fastaid2LCAtaxid_file:
            message = "file fastaid2LCAtaxid is not found in database folder."
            shared.give_user_feedback(message, log_file, quiet, error=True)

            error = True

        if not taxids_with_multiple_offspring_file:
            message = ("file taxids_with_multiple_offspring not found in "
                       "database folder.")
            shared.give_user_feedback(message, log_file, quiet, error=True)

            error = True

    return error


def check_output_file(output_file, log_file, quiet):
    error = False

    if os.path.isfile(output_file):
        message = (
            "output file {0} already exists. You can choose to overwrite "
            "existing files with the [--force] argument.".format(output_file)
        )
        shared.give_user_feedback(message, log_file, quiet, error=True)

        error = True

    return error


def check_input_file(input_file, log_file, quiet):
    error = False

    if not os.path.isfile(input_file):
        message = "input file {0} does not exist.".format(input_file)
        shared.give_user_feedback(message, log_file, quiet, error=True)

        error = True

    return error


def check_in_and_output_file(input_file, output_file, log_file, quiet):
    error = False

    if input_file == output_file:
        message = "input file and output file cannot be the same."
        shared.give_user_feedback(message, log_file, quiet, error=True)

        error = True

    return error


def check_top(top, r, log_file, quiet):
    error = False
    
    if top <= r:
        message = "[--top] should be higher than [-r / --range]."
        shared.give_user_feedback(message, log_file, quiet, error=True)
        
        error = True

    return error


def check_fasta(file_, log_file, quiet):
    error = False

    if not os.path.isfile(file_):
        error = True
    else:
        with open(file_, "r") as f1:
            for n, line in enumerate(f1):
                if n == 0:
                    if not line.startswith(">"):
                        error = True

                    break

    if error:
        message = "{0} is not a fasta file.".format(file_)
        shared.give_user_feedback(message, log_file, quiet, error=True)

    return error


def check_whether_ORFs_are_based_on_contigs(
        contig_names, contig2ORFs, log_file, quiet):
    overlap = len(contig_names & set(contig2ORFs))

    if overlap == 0:
        message = (
                "no ORFs found that can be traced back to one of the contigs "
                "in the contigs fasta file: {0}. ORFs should be named "
                "contig_name_#.".format(contig2ORFs[contig][0])
                )
        shared.give_user_feedback(message, log_file, quiet, error=True)

        sys.exit(1)

    rel_overlap = overlap / len(contig_names)
    message = "ORFs found on {0:,d} / {1:,d} contigs ({2:.2f}%).".format(
            overlap, len(contig_names), rel_overlap * 100)
    shared.give_user_feedback(message, log_file, quiet)

    if rel_overlap < 0.97:
        message = (
                "only {0:.2f}% contigs found with ORF predictions. This may "
                "indicate that some contigs were missing from the protein "
                "prediction. Please make sure that the protein prediction was "
                "based on all contigs.".format(rel_overlap * 100)
                )
        shared.give_user_feedback(message, log_file, quiet, warning=True)

    return
            
            
if __name__ == "__main__":
    sys.exit("Run \'CAT_pack\' to run CAT, BAT, or RAT.")