Tutorial

Caterpillar is a user-friendly and powerful Python framework, easy to learn and with robust functionality. Providing an array of high-level data structures, it creates a compact approach to represent binary formats. Using Python’s annotations and operator overloading feature, this library enables you to write clean and structured code for handling binary formats.

Consider this tutorial as a starting point to explore the diverse options offered by Caterpillar. Upon completion, you will be able to navigate standard struct and bitfield class definitions. Moreover, armed with the insights gained here, you’ll be well-equipped to create structures to your specific needs using the library’s feature set.

Tip

Do not hastily skim through the library reference, as it explains the internal Data Model and introduces the supported Operators applicable to structs, fields, and more.

For those ready to dig deeper or contribute to the framework, the Library API documentation is an important resource to start from.

Roadmap

• 1. First Steps
  • 1.1. Defining structs
  • 1.2. Working with structs
    • 1.2.1. Packing data
    • 1.2.2. Unpacking data
  • 1.3. Configuring structs
    • 1.3.1. Documenting structs
  • 1.4. Next Steps
• 2. Basic Concepts
  • 2.1. Standard Types
    • 2.1.1. Numbers
      • 2.1.1.1. Custom-sized integer
      • 2.1.1.2. Variable-sized integer
    • 2.1.2. Enumerations
    • 2.1.3. Arrays/Lists
    • 2.1.4. String Types
      • 2.1.4.1. CString
      • 2.1.4.2. String
      • 2.1.4.3. Prefixed
    • 2.1.5. Byte Sequences
      • 2.1.5.1. Memory
      • 2.1.5.2. Bytes
    • 2.1.6. Padding
  • 2.2. Context
    • 2.2.1. Runtime length of objects
  • 2.3. Standard Structs
    • 2.3.1. Constants
      • 2.3.1.1. ConstBytes
      • 2.3.1.2. Const
    • 2.3.2. Compression
    • 2.3.3. Specials
      • 2.3.3.1. Computed
      • 2.3.3.2. Pass
• 3. Advanced Concepts
  • 3.1. Operators
    • 3.1.1. Switch
    • 3.1.2. Offset
    • 3.1.3. Pointers
    • 3.1.4. Chaining
  • 3.2. Conditional fields
  • 3.3. BitFields
  • 3.4. Unions
  • 3.5. Templates
  • 3.6. The End!