# Bio.Align.mauve module

Bio.Align support for “xmfa” output from Mauve/ProgressiveMauve.

You are expected to use this module via the Bio.Align functions.

class Bio.Align.mauve.AlignmentWriter(target, metadata=None, identifiers=None)

  Bases: `AlignmentWriter`

  Mauve xmfa alignment writer.

  fmt: str | None = 'Mauve'
  __init__(target, metadata=None, identifiers=None)

    Create an AlignmentWriter object.

    Arguments:

      - target - output stream or file name

      - metadata - metadata to be included in the output. If metadata

          is None, then the alignments object to be written must have an attribute metadata.

      - identifiers - list of the IDs of the sequences included in the

          alignment. Sequences will be numbered according to their index in this list. If identifiers is None, then the alignments object to be written must have an attribute identifiers.

  write_header(stream, alignments)

    Write the file header to the output file.

  write_file(stream, alignments)

    Write a file with the alignments, and return the number of alignments.

    alignments - A Bio.Align.mauve.AlignmentIterator object.

  format_alignment(alignment)

    Return a string with a single alignment in the Mauve format.

  __abstractmethods__ = frozenset({})
  __annotate_func__ = None
  __annotations_cache__ = {'fmt': 'str | None'}
  __firstlineno__ = 18
  __static_attributes__ = ('_identifiers', '_metadata')

class Bio.Align.mauve.AlignmentIterator(source)

  Bases: `AlignmentIterator`

  Mauve xmfa alignment iterator.

  fmt: str | None = 'Mauve'
  __abstractmethods__ = frozenset({})
  __annotate_func__ = None
  __annotations_cache__ = {'fmt': 'str | None'}
  __firstlineno__ = 138
  __static_attributes__ = ('_line', 'identifiers', 'metadata')

Biopython v: 1.86

Versions
  Previous
  Latest
  Develop

Biopython Project
  Homepage
  On GitHub