mtgdeck package

Subpackages

• mtgdeck.base package
  • Submodules
  • mtgdeck.base.decoder module
  • mtgdeck.base.encoder module
  • Module contents

Submodules

mtgdeck.decoder module

Decoder implementations for mtgdeck.

class mtgdeck.decoder.AutoDecoder

Bases: mtgdeck.base.decoder.Decoder

Auto-decoding class.

Determines the input decoding format by try-catching until it succeeds. If it fails, raises a DecodeError exception.

loads(string)

Try to decode string with different decoders.

Raise DecodeError if all decoders are exhausted.

class mtgdeck.decoder.CockatriceDecoder

Bases: mtgdeck.base.decoder.XMLDecoder

Decoding class for the Cockatrice format.

count = 'number'

root = 'cockatrice_deck'

section = 'zone'

exception mtgdeck.decoder.DecodeError

Bases: Exception

Format decoding exception.

class mtgdeck.decoder.MagicOnlineDecoder

Bases: mtgdeck.base.decoder.TextDecoder

Decoding class for the simple text format.

card = {empty rest of line}

comment = C++ style comment

count = W:(0123...)

deck = {{{C++ style comment | Group:("Sideboard")} | Group:({W:(0123...) {empty rest of line}})}}...

decode_entry(entry)

Return (card name (str), attributes (dict)) from entry.

entry = Group:({W:(0123...) {empty rest of line}})

section = Group:("Sideboard")

setid = nested [] expression

class mtgdeck.decoder.MagicWorkstationDecoder

Bases: mtgdeck.base.decoder.TextDecoder

Decoding class for the Magic Workstation format.

card = {empty rest of line}

comment = C++ style comment

count = W:(0123...)

deck = {{C++ style comment | Group:({{{[Group:("SB:")] W:(0123...)} [nested [] expression]} {empty rest of line}})}}...

decode_entry(entry)

Return (card name (str), attributes (dict)) from entry.

entry = Group:({{{[Group:("SB:")] W:(0123...)} [nested [] expression]} {empty rest of line}})

section = Group:("SB:")

setid = nested [] expression

class mtgdeck.decoder.OCTGNDecoder

Bases: mtgdeck.base.decoder.XMLDecoder

Decoding class for the OCTGN Deck Creator format.

count = 'qty'

root = 'deck'

section = 'section'

mtgdeck.encoder module

Encoder implementations for mtgdeck.

class mtgdeck.encoder.CockatriceEncoder

Bases: mtgdeck.base.encoder.XMLEncoder

Encoding class for the Cockatrice format.

count = 'number'

root = 'cockatrice_deck'

section = 'zone'

section_name = 'main'

set_content(card, name)

exception mtgdeck.encoder.EncodeError

Bases: Exception

Format encoding exception.

class mtgdeck.encoder.MagicOnlineEncoder

Bases: mtgdeck.base.encoder.TextEncoder

Encoding class for the simple text format.

This is the format that MTGO outputs. Each line has the form ‘quantity name’. An optional line containing the word ‘Sideboard’ indicates that subsequent entries are sideboard material.

encode_entry(name, attrs)

class mtgdeck.encoder.MagicWorkstationEncoder

Bases: mtgdeck.base.encoder.TextEncoder

Encoding class for the Magic Workstation format.

Each line has the form ‘[SB: ]quantity [SETID ]name’, ‘[]’ meaning optional fields.

encode_entry(name, attrs)

class mtgdeck.encoder.OCTGNEncoder

Bases: mtgdeck.base.encoder.XMLEncoder

Encoding class for the OCTGN Deck Creator format.

count = 'qty'

root = 'deck'

section = 'section'

section_name = 'Main'

set_content(card, name)

Module contents

Public API entry-point for mtgdeck.

mtgdeck.load(fin, cls=<class 'mtgdeck.decoder.AutoDecoder'>)

Deserialize fin (a .read()-supporting file-like object containing an MTG decklist) to a Python object.

To use a custom MTGDeckDecoder subclass, specify it with the cls kwarg; otherwise AutoDecoder is used.

mtgdeck.loads(string, cls=<class 'mtgdeck.decoder.AutoDecoder'>)

Deserialize string (a str, bytes or bytearray instance containing an MTG decklist) to a Python object.

To use a custom MTGDeckDecoder subclass, specify it with the cls kwarg; otherwise AutoDecoder is used.

mtgdeck.dump(obj, fout, cls=<class 'mtgdeck.encoder.MagicOnlineEncoder'>)

Serialize obj as a MTG decklist formatted stream to fout (a .write()-supporting file-like object).

To use a custom Encoder subclass, specify it with the cls kwarg; otherwise Encoder is used.

mtgdeck.dumps(obj, cls=<class 'mtgdeck.encoder.MagicOnlineEncoder'>)

Serialize obj to a MTG decklist formatted str.

To use a custom Encoder subclass, specify it with the cls kwarg; otherwise Encoder is used.

exception mtgdeck.DecodeError

Bases: Exception

Format decoding exception.

class mtgdeck.AutoDecoder

Bases: mtgdeck.base.decoder.Decoder

Auto-decoding class.

Determines the input decoding format by try-catching until it succeeds. If it fails, raises a DecodeError exception.

loads(string)

Try to decode string with different decoders.

Raise DecodeError if all decoders are exhausted.

class mtgdeck.MagicOnlineDecoder

Bases: mtgdeck.base.decoder.TextDecoder

Decoding class for the simple text format.

card = {empty rest of line}

comment = C++ style comment

count = W:(0123...)

deck = {{{C++ style comment | Group:("Sideboard")} | Group:({W:(0123...) {empty rest of line}})}}...

decode_entry(entry)

Return (card name (str), attributes (dict)) from entry.

entry = Group:({W:(0123...) {empty rest of line}})

section = Group:("Sideboard")

setid = nested [] expression

class mtgdeck.MagicWorkstationDecoder

Bases: mtgdeck.base.decoder.TextDecoder

Decoding class for the Magic Workstation format.

card = {empty rest of line}

comment = C++ style comment

count = W:(0123...)

deck = {{C++ style comment | Group:({{{[Group:("SB:")] W:(0123...)} [nested [] expression]} {empty rest of line}})}}...

decode_entry(entry)

Return (card name (str), attributes (dict)) from entry.

entry = Group:({{{[Group:("SB:")] W:(0123...)} [nested [] expression]} {empty rest of line}})

section = Group:("SB:")

setid = nested [] expression

class mtgdeck.OCTGNDecoder

Bases: mtgdeck.base.decoder.XMLDecoder

Decoding class for the OCTGN Deck Creator format.

count = 'qty'

root = 'deck'

section = 'section'

class mtgdeck.CockatriceDecoder

Bases: mtgdeck.base.decoder.XMLDecoder

Decoding class for the Cockatrice format.

count = 'number'

root = 'cockatrice_deck'

section = 'zone'

exception mtgdeck.EncodeError

Bases: Exception

Format encoding exception.

class mtgdeck.MagicOnlineEncoder

Bases: mtgdeck.base.encoder.TextEncoder

Encoding class for the simple text format.

This is the format that MTGO outputs. Each line has the form ‘quantity name’. An optional line containing the word ‘Sideboard’ indicates that subsequent entries are sideboard material.

encode_entry(name, attrs)

class mtgdeck.MagicWorkstationEncoder

Bases: mtgdeck.base.encoder.TextEncoder

Encoding class for the Magic Workstation format.

Each line has the form ‘[SB: ]quantity [SETID ]name’, ‘[]’ meaning optional fields.

encode_entry(name, attrs)

class mtgdeck.OCTGNEncoder

Bases: mtgdeck.base.encoder.XMLEncoder

Encoding class for the OCTGN Deck Creator format.

count = 'qty'

root = 'deck'

section = 'section'

section_name = 'Main'

set_content(card, name)

class mtgdeck.CockatriceEncoder

Bases: mtgdeck.base.encoder.XMLEncoder

Encoding class for the Cockatrice format.

count = 'number'

root = 'cockatrice_deck'

section = 'zone'

section_name = 'main'

set_content(card, name)