allpy
view allpy/base.py @ 823:0192c5c09ce8
allpy.base: added parameter use_existing to *.add_markup() to allow same markup to be added multiple times explicitly [see #95]
| author | Daniil Alexeyevsky <dendik@kodomo.fbb.msu.ru> |
|---|---|
| date | Fri, 15 Jul 2011 17:02:09 +0400 |
| parents | d87129162eb4 |
| children | 137981a4686f |
line source
8 # import this very module as means of having all related classes in one place
12 """Set of characters to recoginze as gaps when parsing alignment."""
15 """Monomer object."""
18 """Either of 'dna', 'rna', 'protein'."""
21 """Mapping of related types. SHOULD be redefined in subclasses."""
24 """A mapping from 1-letter code to Monomer subclass."""
27 """A mapping from 3-letter code to Monomer subclass."""
30 """A mapping from full monomer name to Monomer subclass."""
32 @classmethod
34 """Create new subclass of Monomer for given monomer type."""
36 pass
47 # Save the class in data.monomers so that it can be pickled
48 # Some names are not unique, we append underscores to them
49 # in order to fix it.
58 # We duplicate distinguished long names into Monomer itself, so that we
59 # can use Monomer.from_code3 to create the relevant type of monomer.
64 @classmethod
66 """Create all relevant subclasses of Monomer."""
70 @classmethod
72 """Create new monomer from 1-letter code."""
77 @classmethod
79 """Create new monomer from 3-letter code."""
82 @classmethod
84 """Create new monomer from full name."""
91 """Returns one-letter code"""
95 """Monomers within same monomer type are compared by code1."""
105 """Common functions for alignment and sequence for dealing with markups.
106 """
109 """Hook to be called from __init__ of actual class."""
113 """Create a markup object, add to self. Return the created markup.
115 - `name` is name for markup in `self.markups` dictionary
116 - optional `markup_class` is class for created markup
117 - if optional `use_existing` is true, it is no error, if same named
118 markup already exists (in this case, nothing is changed)
119 - optional keyword arguments are passed on to the markup constructor
121 For user markups you have to specify `name` and `markup_class`,
122 for the standard automatical markups just `name` is enough.
123 """
124 # We have to import markups here, and not in the module header
125 # so as not to create bad import loops.
126 # `base` module is used extensively in `markups` for inherinance,
127 # so breaking the loop here seems a lot easier.
134 return
141 """Remove markup."""
146 """Sequence of Monomers.
148 This behaves like list of monomer objects. In addition to standard list
149 behaviour, Sequence has the following attributes:
151 * name -- str with the name of the sequence
152 * description -- str with description of the sequence
153 * source -- str denoting source of the sequence
155 Any of them may be empty (i.e. hold empty string)
156 """
159 """Mapping of related types. SHOULD be redefined in subclasses."""
162 """Description of object kind."""
172 @classmethod
174 """Create sequence from a list of monomer objecst."""
184 @classmethod
186 """Create sequences from string of one-letter codes."""
198 """Returns sequence of one-letter codes."""
202 """Hash sequence by identity."""
206 """Alignment. It is a list of Columns."""
209 """Mapping of related types. SHOULD be redefined in subclasses."""
212 """Ordered list of sequences in alignment. Read, but DO NOT FIDDLE!"""
215 """Description of object kind."""
218 """Initialize empty alignment."""
223 # Alignment grow & IO methods
224 # ==============================
227 """Add sequence to alignment. Return self.
229 If sequence is too short, pad it with gaps on the right.
230 """
239 """Add row from a string of one-letter codes and gaps. Return self."""
247 ]
254 """Add row from row_as_list representation and sequence. Return self."""
263 """Pad alignment with empty columns on the right to width n."""
268 """Append sequences from file to alignment. Return self.
270 If sequences in file have gaps (detected as characters belonging to
271 `gaps` set), treat them accordingly.
272 """
277 """Write alignment in FASTA file as sequences with gaps."""
281 # Data access methods for alignment
282 # =================================
285 """Return list of rows (temporary objects) in alignment.
287 Each row is a dictionary of { column : monomer }.
289 For gap positions there is no key for the column in row.
291 Each row has attribute `sequence` pointing to the sequence the row is
292 describing.
294 Modifications of row have no effect on the alignment.
295 """
296 # For now, the function returns a list rather than iterator.
297 # It is yet to see, whether memory performance here becomes critical,
298 # or is random access useful.
310 """Return list of rows (temporary objects) in alignment.
312 Each row here is a list of either monomer or None (for gaps).
314 Each row has attribute `sequence` pointing to the sequence of row.
316 Modifications of row have no effect on the alignment.
317 """
328 """Return list of string representation of rows in alignment.
330 Each row has attribute `sequence` pointing to the sequence of row.
332 `gap` is the symbol to use for gap.
333 """
348 """Return representaion of row as list with `Monomers` and `None`s."""
352 """Return string representaion of row in alignment.
354 String will have gaps represented by `gap` symbol (defaults to '-').
355 """
364 """Return list of columns (temorary objects) in alignment.
366 Each column here is a list of either monomer or None (for gaps).
368 Items of column are sorted in the same way as alignment.sequences.
370 Modifications of column have no effect on the alignment.
371 """
381 # Alignment / Block editing methods
382 # =================================
385 """Remove all gaps from alignment and flush results to one side.
387 `whence` must be one of 'left', 'right' or 'center'
388 """
400 """Remove all empty columns."""
406 """Turn all row positions into gaps (but keep sequences intact)."""
412 """Replace contents of `dst` with those of `new`.
414 Replace contents of elements using function `merge(dst_el, new_le)`.
415 """
422 """Replace contents of sequences with those of `new` alignment."""
423 # XXX: we manually copy sequence contents here
424 # XXX: we only copy, overlapping parts and link to the rest
434 """Replace column contents with those of `new` alignment.
436 In other words: copy gap patterns from `new` to `self`.
438 `self.sequences` and `new.sequences` should have the same contents.
439 """
448 ]
453 """Replace alignment contents with those of other alignment."""
459 """Apply function to the alignment (or block); inject results back.
461 - `function(block)` must return block with same line order.
462 - if `copy_descriptions` is False, ignore new sequence names.
463 - if `copy_contents` is False, don't copy sequence contents too.
465 `function` (object) may have attributes `copy_descriptions` and
466 `copy_contents`, which override the same named arguments.
467 """
476 """Realign self.
478 I.e.: apply function to self to produce a new alignment, then update
479 self to have the same gap patterns as the new alignment.
481 This is the same as process(function, False, False)
482 """
487 """Column of alignment.
489 Column is a dict of { sequence : monomer }.
491 For sequences that have gaps in current row, given key is not present in
492 the column.
493 """
496 """Mapping of related types. SHOULD be redefined in subclasses."""
499 """Return hash by identity."""
503 """Block of alignment.
505 Block is an intersection of several rows & columns. (The collections of
506 rows and columns are represented as ordered lists, to retain display order
507 of Alignment or add ability to tweak it). Most of blocks look like
508 rectangular part of alignment if you shuffle alignment rows the right way.
509 """
512 """Alignment the block belongs to."""
515 """List of sequences in block."""
518 """List of columns in block."""
520 @classmethod
522 """Build new block from alignment.
524 If sequences are not given, the block uses all sequences in alignment.
526 If columns are not given, the block uses all columns in alignment.
528 In both cases we use exactly the list used in alignment, thus, if new
529 sequences or columns are added to alignment, the block tracks this too.
530 """
542 """Base class for sequence and alignment markups.
544 We shall call either sequence or alignment a container. And we shall call
545 either monomers or columns elements respectively.
547 Markup behaves like a dictionary of [element] -> value.
549 Every container has a dictionary of [name] -> markup. It is Markup's
550 responsibility to add itself to this dictionary and to avoid collisions
551 while doing it.
552 """
555 """Name of markup elements"""
558 """Markup takes mandatory container and name and optional kwargs.
560 Markups should never be created by the user. They are created by
561 Sequence or Alignment.
562 """
568 """Recalculate markup values (if they are generated automatically)."""
569 pass
572 """Remove the traces of markup object. Do not call this yourself!"""
573 pass
575 @classmethod
577 """Restore markup from `record`. (Used for loading from file).
579 `record` is a dict of all metadata and data related to one markup. All
580 keys and values in `record` are strings, markup must parse them itself.
582 Markup values should be stored in `record['markup']`, which is a list
583 of items separated with either `record['separator']` or a comma.
584 """
588 """Save markup to `record`, for saving to file.
590 For description of `record` see docstring for `from_record` method.
591 """
595 """Return list of elements in the container in proper order."""
599 """Return list of markup values in container."""
603 """Markup for sequence.
605 Behaves like a dictionary of [monomer] -> value. Value may be anything
606 or something specific, depending on subclass.
608 Actual values are stored in monomers themselves as attributes.
609 """
618 """Remove the traces of markup object. Do not call this yourself!"""
623 """Return list of monomers."""
627 """Return list of markup values, if every monomer is marked up."""
631 """Part of Mapping collection interface."""
637 """Part of Mapping collection interface."""
641 """Part of Mapping collection interface."""
645 """Part of Mapping collection interface."""
649 """Part of Mapping collection interface."""
653 """Markupf for alignment.
655 Is a dictionary of [column] -> value. Value may be anything or something
656 specific, depending on subclass.
657 """
666 """Return a list of columns."""
670 """Return a list of makrup values, if every column is marked up."""
673 # vim: set ts=4 sts=4 sw=4 et: