ipumspy.ddi.FileDescription#

class ipumspy.ddi.FileDescription(filename, description, structure, rectypes, rectype_idvar, rectype_keyvar, encoding, format, place)[source]#

In the IPUMS DDI, the file has its own particular description. Extract that from the XML.

Attributes

filename

IPUMS extract ddi file name

description

IPUMS ddi file description

structure

IPUMS extract data file structure.

rectypes

Record types included in the IPUMS extract.

rectype_idvar

The variable that identifies record types.

rectype_keyvar

The variable that uniquely identifies records across record types.

encoding

IPUMS file encoding scheme

format

IPUMS extract data file format

place

IPUMS physical address

Methods

__init__

read

Read a FileDescription from the parsed XML