stingray API Reference

The overall structure of Stingray Reader is a collection of modules.

We’ll look at each module, separately, working up from the bottom of the diagram.

• stingray.estruct
  • Unpacking and Sizing
  • File Reading
  • COBOL Picture Parsing
  • Calcsize Function
    • calcsize()
  • Unpack Function
    • unpack()
  • RECFM_Reader
    • RECFM_Reader
      • RECFM_Reader.record_iter()
      • RECFM_Reader.used()
  • RECFM_F
    • RECFM_F
      • RECFM_F.rdw_iter()
      • RECFM_F.record_iter()
  • RECFM_FB
    • RECFM_FB
  • RECFM_N
    • RECFM_N
      • RECFM_N.record_iter()
  • RECFM_V
    • RECFM_V
      • RECFM_V.rdw_iter()
      • RECFM_V.record_iter()
  • RECFM_VB
    • RECFM_VB
      • RECFM_VB.bdw_iter()
      • RECFM_VB.rdw_iter()
      • RECFM_VB.record_iter()
  • Representation
    • Representation
      • Representation.digit_groups
      • Representation.normalize_picture()
      • Representation.parse()
      • Representation.pattern
      • Representation.picture_elements
      • Representation.picture_size
      • Representation.usage
      • Representation.zoned_decimal
  • DesignError
    • DesignError
• stingray.schema_instance
  • JSON Schema
  • COBOL Processing
    • Redefines
    • Occurs Depending On
    • Notes
    • Terminology
  • Physical File Formats
    • Delimited Files
    • Workbook Files
    • Non-Delimited Files (COBOL)
  • decimal_places function
    • decimal_places()
  • digit_string function
    • digit_string()
  • Schema
    • Schema
      • Schema.attributes
      • Schema.dump_iter()
      • Schema.json()
      • Schema.print()
      • Schema.type
    • ArraySchema
      • ArraySchema.dump_iter()
      • ArraySchema.items
      • ArraySchema.maxItems
      • ArraySchema.print()
    • AtomicSchema
    • DependsOnArraySchema
      • DependsOnArraySchema.maxItems
    • ObjectSchema
      • ObjectSchema.dump_iter()
      • ObjectSchema.print()
    • OneOfSchema
      • OneOfSchema.dump_iter()
      • OneOfSchema.print()
      • OneOfSchema.type
    • RefToSchema
      • RefToSchema.attributes
      • RefToSchema.dump_iter()
      • RefToSchema.items
      • RefToSchema.properties
      • RefToSchema.type
    • SchemaMaker
      • SchemaMaker.from_json()
      • SchemaMaker.resolve()
      • SchemaMaker.walk_schema()
    • Reference
  • Instance
    • WBInstance
    • DInstance
    • NDInstance
    • BytesInstance
    • TextInstance
  • Unpacker
    • Implementation Notes
    • Unpacker Size Computations
    • Conversions
      • Mode
        • Mode.BINARY
        • Mode.TEXT
      • Unpacker
        • Unpacker.instance_iter()
        • Unpacker.calcsize()
        • Unpacker.close()
        • Unpacker.nav()
        • Unpacker.open()
        • Unpacker.sheet_iter()
        • Unpacker.used()
        • Unpacker.value()
      • Delimited
        • Delimited.calcsize()
        • Delimited.nav()
        • Delimited.value()
      • EBCDIC
        • EBCDIC.calcsize()
        • EBCDIC.close()
        • EBCDIC.instance_iter()
        • EBCDIC.nav()
        • EBCDIC.open()
        • EBCDIC.sheet_iter()
        • EBCDIC.used()
        • EBCDIC.value()
      • Struct
        • Struct.calcsize()
        • Struct.close()
        • Struct.instance_iter()
        • Struct.nav()
        • Struct.open()
        • Struct.sheet_iter()
        • Struct.struct_format()
        • Struct.used()
        • Struct.value()
      • TextUnpacker
        • TextUnpacker.calcsize()
        • TextUnpacker.close()
        • TextUnpacker.instance_iter()
        • TextUnpacker.nav()
        • TextUnpacker.open()
        • TextUnpacker.sheet_iter()
        • TextUnpacker.value()
      • WBUnpacker
        • WBUnpacker.calcsize()
        • WBUnpacker.nav()
        • WBUnpacker.value()
  • Schema and Instance Navigation
    • Nav
      • Nav.dump()
      • Nav.index()
      • Nav.name()
      • Nav.value()
    • DNav
      • DNav.dump()
      • DNav.index()
      • DNav.name()
      • DNav.value()
    • NDNav
      • NDNav.dump()
      • NDNav.index()
      • NDNav.name()
      • NDNav.raw()
      • NDNav.raw_instance()
      • NDNav.schema
      • NDNav.value()
    • WBNav
      • WBNav.dump()
      • WBNav.index()
      • WBNav.name()
      • WBNav.value()
    • CSVNav
  • Locations
    • Location
      • Location.dump_iter()
      • Location.raw()
      • Location.referent
      • Location.value()
    • ArrayLocation
      • ArrayLocation.dump_iter()
      • ArrayLocation.raw()
      • ArrayLocation.value()
    • AtomicLocation
      • AtomicLocation.dump_iter()
      • AtomicLocation.raw()
      • AtomicLocation.value()
    • ObjectLocation
      • ObjectLocation.dump_iter()
      • ObjectLocation.raw()
      • ObjectLocation.value()
    • OneOfLocation
      • OneOfLocation.dump_iter()
      • OneOfLocation.raw()
      • OneOfLocation.value()
    • RefToLocation
      • RefToLocation.dump_iter()
      • RefToLocation.properties
      • RefToLocation.raw()
      • RefToLocation.referent
      • RefToLocation.value()
    • LocationMaker
      • LocationMaker.from_instance()
      • LocationMaker.from_schema()
      • LocationMaker.ndnav()
      • LocationMaker.size()
      • LocationMaker.walk()
  • Exceptions
    • DesignError
• stingray.cobol_parser
  • Approach
  • COBOL Language
  • reference_format function
    • reference_format()
  • Parsing
    • dde_sentences()
    • expand_repeat()
    • pass_non_empty()
    • normalize_picture()
    • clause_dict()
  • High Level Parsing
    • structure()
    • schema_iter()
  • DDE Class
    • DDE
      • DDE.append()
      • DDE.display()
      • DDE.filler_count
  • JSONSchemaMaker Class
    • JSONSchemaMaker
      • JSONSchemaMaker.build_json_schema()
      • JSONSchemaMaker.json_type()
      • JSONSchemaMaker.jsonschema()
    • JSONSchemaMakerExtendedVocabulary
      • JSONSchemaMakerExtendedVocabulary.VOCABULARY
      • JSONSchemaMakerExtendedVocabulary.json_type()
  • Exceptions
    • DesignError
• stingray.workbook
  • COBOL File Implementation – EBCDIC and Text
  • API Concept
  • Sheet and Row
  • open_workbook function
    • open_workbook()
  • name_cleaner function
    • name_cleaner()
  • Core Workbook, Sheet, and Row Model
    • Workbook
      • Workbook.close()
      • Workbook.sheet()
      • Workbook.sheet_iter()
    • Sheet
      • Sheet.row_iter()
      • Sheet.rows()
      • Sheet.set_schema()
      • Sheet.set_schema_loader()
    • Row
      • Row.dump()
      • Row.get()
      • Row.name()
      • Row.schema
      • Row.values()
  • Schema Loaders
    • SchemaLoader
      • SchemaLoader.body()
      • SchemaLoader.header()
    • COBOLSchemaLoader
      • COBOLSchemaLoader.load()
    • ExternalSchemaLoader
      • ExternalSchemaLoader.META_SCHEMA
      • ExternalSchemaLoader.load()
    • HeadingRowSchemaLoader
      • HeadingRowSchemaLoader.header()
  • COBOL Files
    • COBOL_EBCDIC_File
      • COBOL_EBCDIC_File.close()
      • COBOL_EBCDIC_File.sheet()
      • COBOL_EBCDIC_File.sheet_iter()
    • COBOL_EBCDIC_Sheet
      • COBOL_EBCDIC_Sheet.row_iter()
      • COBOL_EBCDIC_Sheet.rows()
      • COBOL_EBCDIC_Sheet.set_schema()
    • COBOL_Text_File
      • COBOL_Text_File.close()
  • CSV Workbooks
    • CSVUnpacker
      • CSVUnpacker.close()
      • CSVUnpacker.instance_iter()
      • CSVUnpacker.open()
      • CSVUnpacker.sheet_iter()
    • CSV_Workbook
      • CSV_Workbook.close()
  • JSON Workbooks
    • JSONUnpacker
      • JSONUnpacker.close()
      • JSONUnpacker.instance_iter()
      • JSONUnpacker.open()
      • JSONUnpacker.sheet_iter()
    • JSON_Workbook
      • JSON_Workbook.close()
  • Workbook File Registry
    • WBFileRegistry
      • WBFileRegistry.file_suffix()
      • WBFileRegistry.open_workbook()
    • file_registry.file_suffix()
  • Legacy API Concept
• stingray.implementations
  • XLS
    • XLSUnpacker
      • XLSUnpacker.close()
      • XLSUnpacker.instance_iter()
      • XLSUnpacker.open()
      • XLSUnpacker.sheet_iter()
    • XLS_Workbook
      • XLS_Workbook.close()
  • XLSX
    • XLSXUnpacker
      • XLSXUnpacker.close()
      • XLSXUnpacker.instance_iter()
      • XLSXUnpacker.open()
      • XLSXUnpacker.sheet_iter()
    • XLSX_Workbook
      • XLSX_Workbook.close()
  • ODS
    • ODSUnpacker
      • ODSUnpacker.close()
      • ODSUnpacker.instance_iter()
      • ODSUnpacker.open()
      • ODSUnpacker.sheet_iter()
    • ODS_Workbook
      • ODS_Workbook.close()
  • Numbers
    • NumbersUnpacker
      • NumbersUnpacker.close()
      • NumbersUnpacker.instance_iter()
      • NumbersUnpacker.open()
      • NumbersUnpacker.sheet_iter()
    • Numbers_Workbook
      • Numbers_Workbook.close()