annotate commons/core/writer/EmblWriter.py @ 6:769e306b7933

Change the repository level.
author yufei-luo
date Fri, 18 Jan 2013 04:54:14 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
1 #
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
2 # Copyright INRA-URGI 2009-2010
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
3 #
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
4 # This software is governed by the CeCILL license under French law and
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
5 # abiding by the rules of distribution of free software. You can use,
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
6 # modify and/ or redistribute the software under the terms of the CeCILL
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
7 # license as circulated by CEA, CNRS and INRIA at the following URL
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
8 # "http://www.cecill.info".
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
9 #
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
10 # As a counterpart to the access to the source code and rights to copy,
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
11 # modify and redistribute granted by the license, users are provided only
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
12 # with a limited warranty and the software's author, the holder of the
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
13 # economic rights, and the successive licensors have only limited
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
14 # liability.
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
15 #
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
16 # In this respect, the user's attention is drawn to the risks associated
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
17 # with loading, using, modifying and/or developing or reproducing the
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
18 # software by the user in light of its specific status of free software,
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
19 # that may mean that it is complicated to manipulate, and that also
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
20 # therefore means that it is reserved for developers and experienced
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
21 # professionals having in-depth computer knowledge. Users are therefore
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
22 # encouraged to load and test the software's suitability as regards their
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
23 # requirements in conditions enabling the security of their systems and/or
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
24 # data to be ensured and, more generally, to use and operate it in the
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
25 # same conditions as regards security.
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
26 #
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
27 # The fact that you are presently reading this means that you have had
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
28 # knowledge of the CeCILL license and that you accept its terms.
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
29 #
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
30 from commons.core.writer.TranscriptListWriter import TranscriptListWriter
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
31
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
32
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
33 class EmblWriter(TranscriptListWriter):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
34 """
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
35 A class that writes a transcript list into several files with EMBL format
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
36 @ivar fileName: name of the file
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
37 @type fileName: string
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
38 @ivar handle: handle to the file
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
39 @type handle: file handle
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
40 """
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
41
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
42
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
43 def __init__(self, fileName, verbosity = 0):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
44 """
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
45 Constructor
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
46 @param fileName: name of the file
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
47 @type fileName: string
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
48 @param verbosity: verbosity
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
49 @type verbosity: int
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
50 """
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
51 self.fileName = fileName
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
52 self.verbosity = verbosity
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
53 self.handles = {}
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
54 self.handle = None
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
55
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
56
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
57 def __del__(self):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
58 """
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
59 Destructor
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
60 Trick to append the sequences at the end of the EMBL files
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
61 """
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
62 handle = open(self.sequenceFileName)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
63 currentHandle = None
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
64 for line in handle:
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
65 if line[0] == ">":
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
66 chromosome = line[1:].strip()
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
67 if chromosome in self.handles:
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
68 currentHandle = self.handles[chromosome]
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
69 else:
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
70 currentHandle = None
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
71 else:
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
72 if currentHandle != None:
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
73 currentHandle.write(line)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
74 handle.close()
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
75 for handle in self.handles.values():
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
76 handle.close()
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
77
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
78
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
79 @staticmethod
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
80 def getFileFormats():
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
81 """
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
82 Get the format of the file
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
83 """
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
84 return ["embl"]
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
85
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
86
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
87 @staticmethod
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
88 def getExtension():
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
89 """
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
90 Get the usual extension for the file
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
91 """
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
92 return "embl"
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
93
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
94
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
95 def addTranscript(self, transcript):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
96 """
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
97 Add a transcript to the list of transcripts to be written
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
98 @param transcript: transcript to be written
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
99 @type transcript: class L{Transcript<Transcript>}
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
100 """
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
101 chromosome = transcript.getChromosome()
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
102 if chromosome not in self.handles:
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
103 self.handles[chromosome] = open("%s%s.embl" % (self.fileName[:-len(".embl")], chromosome.title()), "w")
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
104 self.handles[chromosome].write(self.printTranscript(transcript))
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
105
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
106
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
107 def printTranscript(self, transcript):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
108 """
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
109 Export the given transcript with GFF2 format
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
110 @param transcript: transcript to be printed
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
111 @type transcript: class L{Transcript<Transcript>}
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
112 @return: a string
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
113 """
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
114 return transcript.printEmbl()
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
115
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
116