Bethesda Structs Package

The following is the automatically built documentation for the entire bethesda_structs package. All objects that are considered to be handlers for a Bethesda file format are subclasses of BaseFiletype.

Plugins and Archives adhere to the following naming conventions.

• {GAME_PREFIX}Plugin - FNVPlugin
• {TYPE_PREFIX}Archive - BSAArchive

In some cases (such as BSAArchive) this may seem repetitive (BSA[rchive]Archive). But, in this project, repetition is sacrificed for standardization.

Important

Common resources for each module (including submodules) are placed in a file named _common.py for each module. Typically you will see abstract objects or module helper methods defined in these files.

They are important for contributors, but shouldn’t ever need to be seen by users.

• Plugins
  • Common
  • Fallout: New Vegas
  • Fallout 3
• Archives
  • Common
  • BSA Archives
  • BTDX Archives
• Additional
  • DDS

---

class bethesda_structs._common.BaseFiletype

Bases: abc.ABC

The base filetype for all supported file parsers.

classmethod can_handle(filepath)

Determines if a given filepath can be handled by the archive.

Parameters:filepath (str) – The filepath to evaluate Raises:NotImplementedError – Subclasses must implement Return type:bool

classmethod parse(content, filepath=None)

Create a BaseFiletype from a byte array.

Parameters:

• content (bytes) – The byte content
• filepath (str, optional) – Defaults to None. Sets the filepath attribute for user’s reference

Raises:

NotImplementedError – Subclasses must implement

Returns:

A filetype instance

Return type:

BaseFiletype

classmethod parse_stream(stream, filepath=None)

Create a BaseFiletype from a file stream.

Parameters:

• stream (io.BufferedReader) – A file stream to read from.
• filepath (str, optional) – Defaults to None. Sets the filepath attribute for user’s reference.

Raises:

ValueError – If the given stream is not of bytes

Returns:

A filetype instance

Return type:

BaseFiletype

classmethod parse_file(filepath)

Create a BaseFiletype from a given filepath.

Parameters:filepath (str) – The filepath to read from Raises:FileNotFoundError – If the given filepath does not exist Returns:A filetype instance Return type:BaseFiletype