credmark.cmf.types.adt.Records

DTO class Records(*, records=[], fields=[], n_rows, fix_int_columns=[])[source]

Bases: GenericModel

Show JSON schema

{
   "title": "Records",
   "type": "object",
   "properties": {
      "records": {
         "title": "Records",
         "default": [],
         "type": "array",
         "items": {
            "type": "array",
            "items": {}
         }
      },
      "fields": {
         "title": "Fields",
         "description": "List of fields",
         "default": [],
         "type": "array",
         "items": {
            "type": "string"
         }
      },
      "n_rows": {
         "title": "N Rows",
         "type": "integer"
      },
      "fix_int_columns": {
         "title": "Fix Int Columns",
         "description": "List of int fields to be restored from string",
         "default": [],
         "type": "array",
         "items": {
            "type": "string"
         }
      }
   },
   "required": [
      "n_rows"
   ]
}

Fields

fields (List[str])
fix_int_columns (List[str])
n_rows (int)
records (List[Tuple])

Parameters

records (List[Tuple]) –
fields (List[str]) –
n_rows (int) –
fix_int_columns (List[str]) –

Return type

None

field fields: List[str] = []: List of fields

field fix_int_columns: List[str] = []: List of int fields to be restored from string

field n_rows: int [Required]

field records: List[Tuple] = []

append(obj)[source]

classmethod empty()[source]

extend(obj)[source]

classmethod from_dataframe(_df, fix_int_columns=None)[source]

is_empty()[source]

Return type: bool

to_dataframe()[source]