pyspssio.Reader

class pyspssio.Reader(*args, row_offset=0, row_limit=None, usecols=None, chunksize=None, convert_datetimes=True, include_user_missing=True, string_nan='', **kwargs)[source]

Bases: Header

Class for reading metadata and data

__init__(*args, row_offset=0, row_limit=None, usecols=None, chunksize=None, convert_datetimes=True, include_user_missing=True, string_nan='', **kwargs)[source]

Methods

__init__(*args[, row_offset, row_limit, ...])

close()

Close file

commit_header()

Finalize metadata

open()

Open file

read_data([row_limit, convert_datetimes, ...])

Read data

set_locale(locale)

Set I/O module to a specific locale

Attributes

case_count

Number of cases

case_size

Record case size (in bytes)

case_weight_var

Case weight variable

compression

Compression level

file_attributes

Arbitrary user-defined file attributes

file_encoding

File encoding reported by I/O module

interface_encoding

I/O interface mode (Unicode or code page)

is_compatible_encoding

Check encoding compatibility

metadata

Metadata object

mrsets

Multi response set definitions

mrsets_count

Number of multi response set definitions

release_info

Basic file information

var_alignments

Variable alignments

var_attributes

Variable attributes

var_column_widths

Column display widths

var_compat_names

Short (8-byte) variable names

var_count

Number of variables

var_formats

Variable formats as strings

var_formats_tuple

Variable formats as tuples in the form (type, width, decimals)

var_handles

Variable handles references

var_labels

Variable labels

var_measure_levels

Variable measure levels

var_missing_values

Missing values

var_names

Variable names

var_roles

Variable roles

var_sets

Variable sets

var_types

Variable types

var_value_labels

Variable value labels

property metadata: dict

Metadata object

This object contains properties/attributes from the Header class mostly pertaining to variable information and data structure.

read_data(row_limit=None, convert_datetimes=None, include_user_missing=None)[source]

Read data

Parameters:
  • row_limit (int (default: None)) – Maximum number of rows to return

  • convert_datetimes (bool (default: None)) – Convert SPSS datetimes to Python/Pandas datetime columns; False returns seconds from October 15, 1582 (SPSS start date)

  • include_user_missing (bool (default: None)) – Whether to keep user missing values or replace them with NaN (numeric) and “” (strings)

Return type:

DataFrame