Welcome to input_reader’s documentation!

Contents:

• 1. The input_reader module
  • 1.1. Installation
  • 1.2. Exported objects
• 2. The InputReader Class
  • 2.1. InputReader options
  • 2.2. read_input()
  • 2.3. add_boolean_key()
  • 2.4. add_line_key()
  • 2.5. add_block_key()
  • 2.6. add_regex_line()
  • 2.7. Common Options
  • 2.8. add_mutually_exclusive_group()
  • 2.9. Putting it all together
  • 2.10. post_process()
  • 2.11. input_file
  • 2.12. filename
  • 2.13. Gotchas
• 3. The Namespace class
• 4. The SUPPRESS class
• 5. The ReaderError exception
• 6. Helper Functions
  • 6.1. abs_file_path()
  • 6.2. file_safety_check()
  • 6.3. range_check()
• 7. Subclassing InputReader
• 8. Changelog
  • 8.1. 04-13-2013 v. 1.1.1
  • 8.2. 01-25-2013 v. 1.1.0
  • 8.3. 01-14-2013 v. 1.0.2
  • 8.4. 12-22-2012 v. 1.0.1
  • 8.5. 12-16-2012 v. 1.0.0
  • 8.6. 12-3-2012 v. 0.9.1

Indices and tables

• Index
• Module Index
• Search Page