o
    EhRl                     @  sF  d Z ddlmZ ddlmZ ddlmZmZ ddlZddlm	Z	 ddl
ZddlmZ ddlmZmZmZmZmZ dd	lmZmZ dd
lmZ ddlmZ ddlZddlmZmZmZ ddl m!Z! ddl"m#  m$  m%Z& ddl'm(Z( e	r~ddl)m*Z*m+Z+m,Z, edZ-edZ.d!ddZ/d"ddZ0G dd dZ1G dd  d e(ej2Z3dS )#a  
Read SAS7BDAT files

Based on code written by Jared Hobbs:
  https://bitbucket.org/jaredhobbs/sas7bdat

See also:
  https://github.com/BioStatMatt/sas7bdat

Partial documentation of the file format:
  https://cran.r-project.org/package=sas7bdat/vignettes/sas7bdat.pdf

Reference for binary data compression:
  http://collaboration.cmc.ec.gc.ca/science/rpn/biblio/ddj/Website/articles/CUJ/1992/9210/ross/ross.htm
    )annotations)abc)datetime	timedeltaN)TYPE_CHECKING)
get_option)read_double_with_byteswapread_float_with_byteswapread_uint16_with_byteswapread_uint32_with_byteswapread_uint64_with_byteswap)Parserget_subheader_index)cast_from_unit_vectorized)EmptyDataError)	DataFrame	Timestampisna)
get_handle)
ReaderBase)CompressionOptionsFilePath
ReadBufferz
1970-01-01z
1960-01-01sas_datetimefloatunitstrc                 C  sR   t | rtjS |dkrtdddt| d S |dkr%tdddt| d S td)Ns     )Zsecondsd)Zdayszunit must be 'd' or 's')r   pdZNaTr   r   
ValueError)r   r    r#   6lib/python3.10/site-packages/pandas/io/sas/sas7bdat.py_parse_datetimeC   s   r%   sas_datetimes	pd.Seriesreturnc                 C  sl   t t d}|dkr#t| jddd}|d| }tj|| jddS t	j
| dd| }tj|d	| jdd
S )a  
    Convert to Timestamp if possible, otherwise to datetime.datetime.
    SAS float64 lacks precision for more than ms resolution so the fit
    to datetime.datetime is ok.

    Parameters
    ----------
    sas_datetimes : {Series, Sequence[float]}
       Dates or datetimes in SAS
    unit : {'d', 's'}
       "d" if the floats represent dates, "s" for datetimes

    Returns
    -------
    Series
       Series of datetime64 dtype or datetime.datetime.
    r   ms)r   Zout_unitzM8[ms]FindexcopyzM8[D]dtypezM8[s]r.   r+   r,   )_sas_origin_unix_originZas_unitr   Z_valuesviewr!   Seriesr+   npZarray)r&   r   ZtdZmillisZdt64msZvalsr#   r#   r$   _convert_datetimesQ   s   r5   c                   @  sH   e Zd ZU ded< ded< ded< ded< ded< ded	< dddZdS )_Columnintcol_idstr | bytesnamelabelformatbytesctypelengthr(   Nonec                 C  s(   || _ || _|| _|| _|| _|| _d S N)r8   r:   r;   r<   r>   r?   )selfr8   r:   r;   r<   r>   r?   r#   r#   r$   __init__w   s   

z_Column.__init__N)r8   r7   r:   r9   r;   r9   r<   r9   r>   r=   r?   r7   r(   r@   )__name__
__module____qualname____annotations__rC   r#   r#   r#   r$   r6   o   s   
 r6   c                   @  sJ  e Zd ZU dZded< ded< 								dYdZddZd[ddZd[ddZd[dd Zd\d!d"Z	d\d#d$Z
d]d&d'Zd^d*d+Zd_d,d-Zd`d/d0Zdad2d3Zd\d4d5Zdbd6d7Zd\d8d9Zd\d:d;Zdcd<d=Zdcd>d?Zdcd@dAZdcdBdCZdcdDdEZdcdFdGZdcdHdIZdcdJdKZdddedMdNZdOdP Zd]dQdRZdSdT ZdfdWdXZ dS )gSAS7BDATReadera  
    Read SAS files in SAS7BDAT format.

    Parameters
    ----------
    path_or_buf : path name or buffer
        Name of SAS file or file-like object pointing to SAS file
        contents.
    index : column identifier, defaults to None
        Column to use as index.
    convert_dates : bool, defaults to True
        Attempt to convert dates to Pandas datetime values.  Note that
        some rarely used SAS date formats may be unsupported.
    blank_missing : bool, defaults to True
        Convert empty strings to missing values (SAS uses blanks to
        indicate missing character variables).
    chunksize : int, defaults to None
        Return SAS7BDATReader object for iterations, returns chunks
        with given number of lines.
    encoding : str, 'infer', defaults to None
        String encoding acc. to Python standard encodings,
        encoding='infer' tries to detect the encoding from the file header,
        encoding=None will leave the data in binary format.
    convert_text : bool, defaults to True
        If False, text variables are left as raw bytes.
    convert_header_text : bool, defaults to True
        If False, header text, including column names, are left as raw
        bytes.
    r7   _int_lengthzbytes | None_cached_pageNTinferpath_or_bufFilePath | ReadBuffer[bytes]convert_datesboolblank_missing	chunksize
int | Noneencoding
str | Noneconvert_textconvert_header_textcompressionr   r(   r@   c
           
   	   C  s   || _ || _|| _|| _|| _|| _|| _d| _d| _g | _	g | _
g | _g | _g | _d | _g | _g | _g | _d| _d| _d| _t|dd|	d| _| jj| _| j| j| j| j| j| j| j| jd g	| _ z| !  | "  W d S  t#yx   | $   w )Nzlatin-1    r   rbF)Zis_textrW   )%r+   rN   rP   rQ   rS   rU   rV   default_encodingrW   column_names_rawcolumn_namescolumn_formatscolumns%_current_page_data_subheader_pointersrJ   _column_data_lengths_column_data_offsets_column_types_current_row_in_file_indexZ_current_row_on_page_indexr   handlesZhandle_path_or_buf_process_rowsize_subheader_process_columnsize_subheader_process_subheader_counts_process_columntext_subheader_process_columnname_subheader#_process_columnattributes_subheader_process_format_subheader_process_columnlist_subheader_subheader_processors_get_properties_parse_metadata	Exceptionclose)
rB   rL   r+   rN   rP   rQ   rS   rU   rV   rW   r#   r#   r$   rC      sT   
zSAS7BDATReader.__init__
np.ndarrayc                 C     t j| jt jdS )z5Return a numpy int64 array of the column data lengthsr-   )r4   asarrayr`   int64rB   r#   r#   r$   column_data_lengths      z"SAS7BDATReader.column_data_lengthsc                 C  rt   )z0Return a numpy int64 array of the column offsetsr-   )r4   ru   ra   rv   rw   r#   r#   r$   column_data_offsets   ry   z"SAS7BDATReader.column_data_offsetsc                 C  s   t j| jt ddS )zj
        Returns a numpy character array of the column types:
           s (string) or d (double)
        ZS1r-   )r4   ru   rb   r.   rw   r#   r#   r$   column_types   s   zSAS7BDATReader.column_typesc                 C  s   | j   d S rA   )rd   rr   rw   r#   r#   r$   rr      s   zSAS7BDATReader.closec                 C  s  | j d | j d| _| jdttj tjkrtd| tj	tj
}|tjkr:d| _d| _tj| _tj| _nd| _tj| _tj| _d| _| tjtj}|tjkrYtj}nd}| tjtj}|dkrqd	| _tjd
k| _n	d| _tjdk| _| tjtjd }|tj v rtj | | _!| j"dkr| j!| _"nd| d| _!t#ddd}| $tj%| tj&}|t'j(|dd | _)| $tj*| tj+}|t'j(|dd | _,| -tj.| tj/| _0| j | j0d }|  j|7  _t| j| j0krtd| -tj1| tj2| _3d S )Nr   i   z'magic number mismatch (not a SAS file?)T   F      <Zbig>littlerK   zunknown (code=)r   r   r   )r   z*The SAS7BDAT file appears to be truncated.)4re   seekreadrJ   lenconstmagicr"   _read_bytesZalign_1_offsetZalign_1_lengthZu64_byte_checker_valueU64rI   Zpage_bit_offset_x64_page_bit_offsetZsubheader_pointer_length_x64_subheader_pointer_lengthZpage_bit_offset_x86Zsubheader_pointer_length_x86Zalign_2_offsetZalign_2_lengthZalign_1_checker_valueZalign_2_valueZendianness_offsetZendianness_length
byte_ordersys	byteorderneed_byteswapZencoding_offsetZencoding_lengthZencoding_namesZinferred_encodingrS   r   _read_floatZdate_created_offsetZdate_created_lengthr!   Zto_timedeltaZdate_createdZdate_modified_offsetZdate_modified_lengthZdate_modified
_read_uintZheader_size_offsetZheader_size_lengthZheader_lengthZpage_size_offsetZpage_size_length_page_length)rB   bufZalign1Zepochxr#   r#   r$   ro      sd   





zSAS7BDATReader._get_propertiesr   c                 C  s(   | j | jpdd}|jr|   t|S )Nr   )nrows)r   rQ   emptyrr   StopIteration)rB   dar#   r#   r$   __next__C  s
   zSAS7BDATReader.__next__offsetwidthc                 C  sN   | j d usJ |dkrt| j || jS |dkrt| j || jS |   td)Nr}   r|   zinvalid float width)rJ   r	   r   r   rr   r"   rB   r   r   r#   r#   r$   r   K  s   

zSAS7BDATReader._read_floatc                 C  s~   | j d usJ |dkr| |dd S |dkrt| j || jS |dkr+t| j || jS |dkr7t| j || jS |   td)Nr   r      r}   r|   zinvalid int width)rJ   r   r
   r   r   r   rr   r"   r   r#   r#   r$   r   Z  s"   


zSAS7BDATReader._read_uintr?   c                 C  sB   | j d usJ || t| j kr|   td| j |||  S )NzThe cached page is too small.)rJ   r   rr   r"   rB   r   r?   r#   r#   r$   r   n  s
   zSAS7BDATReader._read_bytesr9   c                 C  s   |  | ||dS )N     )_convert_header_textr   rstripr   r#   r#   r$   _read_and_convert_header_textu  s   z,SAS7BDATReader._read_and_convert_header_textc                 C  sV   d}|s)| j | j| _t| jdkrd S t| j| jkr!td|  }|rd S d S )NFr   z2Failed to read a meta data page from the SAS file.)re   r   r   rJ   r   r"   _process_page_meta)rB   Zdoner#   r#   r$   rp   z  s   zSAS7BDATReader._parse_metadatac                 C  sZ   |    tjtjtjg }| j|v r|   | jtjk}| jtjk}t|p+|p+| j	g kS rA   )
_read_page_headerr   page_meta_typesZpage_amd_typepage_mix_type_current_page_type_process_page_metadatapage_data_typerO   r_   )rB   ptZis_data_pageZis_mix_pager#   r#   r$   r     s   
z!SAS7BDATReader._process_page_metac                 C  s^   | j }tj| }| |tjtj@ | _tj| }| |tj| _	tj
| }| |tj| _d S rA   )r   r   Zpage_type_offsetr   Zpage_type_lengthZpage_type_mask2r   Zblock_count_offsetZblock_count_lengthZ_current_page_block_countZsubheader_count_offsetZsubheader_count_length_current_page_subheaders_count)rB   
bit_offsetZtxr#   r#   r$   r     s   



z SAS7BDATReader._read_page_headerc                 C  s  | j }t| jD ]}tj| }|| j|  }| || j}|| j7 }| || j}|| j7 }| |d}|d7 }| |d}|dksG|tjkrHq| 	|| j}	t
|	}
| j|
 }|d u r|tjdfv }|tjk}| jrx|rx|rx| j||f q|   td|	 ||| qd S )Nr   r   zUnknown subheader signature )r   ranger   r   Zsubheader_pointers_offsetr   r   rI   Ztruncated_subheader_idr   r   rn   Zcompressed_subheader_idZcompressed_subheader_typerW   r_   appendrr   r"   )rB   r   ir   Ztotal_offsetZsubheader_offsetZsubheader_lengthZsubheader_compressionZsubheader_typeZsubheader_signatureZsubheader_indexZsubheader_processorf1f2r#   r#   r$   r     s<   





z%SAS7BDATReader._process_page_metadatac                 C  s   | j }|}|}| jr|d7 }|d7 }n|d7 }|d7 }| |tj|  || _| |tj|  || _| |tj|  || _	| |tj
|  || _tj| }| || || _| |d| _| |d| _d S )Ni  i  ib  iz  r   )rI   r   r   r   Zrow_length_offset_multiplierZ
row_lengthZrow_count_offset_multiplier	row_countZcol_count_p1_multipliercol_count_p1Zcol_count_p2_multipliercol_count_p2Z'row_count_on_mix_page_offset_multiplierZ_mix_page_row_count_lcs_lcp)rB   r   r?   int_lenZ
lcs_offsetZ
lcp_offsetZmxr#   r#   r$   rf     s4   

z)SAS7BDATReader._process_rowsize_subheaderc                 C  sX   | j }||7 }| ||| _| j| j | jkr*td| j d| j d| j d d S d S )Nz Warning: column count mismatch (z + z != z)
)rI   r   column_countr   r   print)rB   r   r?   r   r#   r#   r$   rg     s   
z,SAS7BDATReader._process_columnsize_subheaderc                 C     d S rA   r#   r   r#   r#   r$   rh     s   z(SAS7BDATReader._process_subheader_countsc           	      C  s  || j 7 }| |tj}| ||}|d| d}| j| t| jdkrd}tj	D ]}||v r5|}q-|| _
|| j 8 }|d }| jrI|d7 }| || j}|d}|dkrwd| _|d }| jrg|d7 }| || j}|d| j | _nB|tjkr|d	 }| jr|d7 }| || j}|d| j | _n"| jdkrd| _|d }| jr|d7 }| || j}|d| j | _t| d
r| | j| _d S d S d S )Nr   r   r   rX      r}           (   creator_proc)rI   r   r   Ztext_block_size_lengthr   r   r[   r   r   Zcompression_literalsrW   r   r   r   r   Zrle_compressionhasattrr   )	rB   r   r?   Ztext_block_sizer   Z	cname_rawZcompression_literalZclZoffset1r#   r#   r$   ri     sT   






"z,SAS7BDATReader._process_columntext_subheaderc                 C  s   | j }||7 }|d|  d d }t|D ]Q}|tj|d   tj }|tj|d   tj }|tj|d   tj }| |tj}	| |tj	}
| |tj
}| j|	 }||
|
|  }| j| | qd S )Nr      r|   r   )rI   r   r   Zcolumn_name_pointer_lengthZ!column_name_text_subheader_offsetZcolumn_name_offset_offsetZcolumn_name_length_offsetr   Z!column_name_text_subheader_lengthZcolumn_name_offset_lengthZcolumn_name_length_lengthr[   r\   r   r   )rB   r   r?   r   Zcolumn_name_pointers_countr   Ztext_subheaderZcol_name_offsetZcol_name_lengthidx
col_offsetZcol_lenZname_rawZcnamer#   r#   r$   rj   "  sB   
z,SAS7BDATReader._process_columnname_subheaderc           
      C  s   | j }|d|  d |d  }t|D ]Y}|| tj ||d   }|d|  tj ||d   }|d|  tj ||d   }| ||}	| j|	 | |tj	}	| j
|	 | |tj}	| j|	dkridnd qd S )Nr   r   r|   r      d   s)rI   r   r   Zcolumn_data_offset_offsetZcolumn_data_length_offsetZcolumn_type_offsetr   ra   r   Zcolumn_data_length_lengthr`   Zcolumn_type_lengthrb   )
rB   r   r?   r   Zcolumn_attributes_vectors_countr   Zcol_data_offsetZcol_data_lenZ	col_typesr   r#   r#   r$   rk   C  s,   
z2SAS7BDATReader._process_columnattributes_subheaderc                 C  r   rA   r#   r   r#   r#   r$   rm   ]  s   z,SAS7BDATReader._process_columnlist_subheaderc                 C  sx  | j }|tj d|  }|tj d|  }|tj d|  }|tj d|  }|tj d|  }|tj d|  }	| |tj	}
t
|
t| jd }| |tj}| |tj}| |tj}t
|t| jd }| |tj}| |	tj}| j| }| ||||  }| j| }| ||||  }t| j}t|| j| ||| j| | j| }| j| | j| d S )N   r   )rI   r   Z)column_format_text_subheader_index_offsetZcolumn_format_offset_offsetZcolumn_format_length_offsetZ(column_label_text_subheader_index_offsetZcolumn_label_offset_offsetZcolumn_label_length_offsetr   Z)column_format_text_subheader_index_lengthminr   r[   Zcolumn_format_offset_lengthZcolumn_format_length_lengthZ(column_label_text_subheader_index_lengthZcolumn_label_offset_lengthZcolumn_label_length_lengthr   r^   r6   r\   rb   r`   r]   r   )rB   r   r?   r   Ztext_subheader_formatZcol_format_offsetZcol_format_lenZtext_subheader_labelZcol_label_offsetZcol_label_lenr   Z
format_idxZformat_startZ
format_lenZ	label_idxZlabel_startZ	label_lenZlabel_namesZcolumn_labelZformat_namesZcolumn_formatZcurrent_column_numbercolr#   r#   r$   rl   a  sX   


	z(SAS7BDATReader._process_format_subheaderr   c                 C  s   |d u r| j d ur| j }n|d u r| j}t| jdkr#|   td|dkr0| j| jkr0t S t|| j| j }| j	d}| j	d}t
j||ftd| _t
j|d| ft
jd| _d| _t| }|| |  }| jd urw|| j}|S )Nr   zNo columns to parse from filer   r   r-   r|   )rQ   r   r   rb   rr   r   rc   r   r   countr4   r   object_string_chunkZzerosZuint8_byte_chunk_current_row_in_chunk_indexr   r   _chunk_to_dataframer+   Z	set_index)rB   r   Zndnsprsltr#   r#   r$   r     s*   

zSAS7BDATReader.readc                 C  s   g | _ | j| j| _t| jdkrdS t| j| jkr3|   dt| jdd| jdd}t||   | j	t
jv rA|   | j	t
jt
jt
jg vrQ|  S dS )Nr   Tz-failed to read complete page from file (read r    z of z bytes)F)r_   re   r   r   rJ   r   rr   r"   r   r   r   r   r   r   r   _read_next_page)rB   msgr#   r#   r$   r     s,   
zSAS7BDATReader._read_next_pagec                 C  s  | j }| j}t|| |}i }d\}}td}t| jD ]}| j| }	| j| dkrq| j|d d f j| j	d d}
t
j|
tj|dd||	< | jrl| j| tjv r[t||	 d||	< n| j| tjv rlt||	 d||	< |d	7 }q| j| d
krt
j| j|d d f |dd||	< | jr| jd ur| ||	 j||	< |r||	 d||	< |d	7 }q|   tdt| j|  t|| j|dd}|S )N)r   r   zfuture.infer_stringr   r    r-   Fr/   r   r   r   r*   r   zunknown column type )r^   r+   r,   )r   rc   r   r   r   r\   rb   r   r2   r   r!   r3   r4   Zfloat64rN   r]   r   Zsas_date_formatsr5   Zsas_datetime_formatsr   rU   rS   _decode_stringr   Zastyperr   r"   reprr   )rB   nmZixr   ZjsZjbZinfer_stringjr:   Zcol_arrZdfr#   r#   r$   r     s8   
 
"
z"SAS7BDATReader._chunk_to_dataframec                 C  s   | | jp| jS rA   )decoderS   rZ   rB   br#   r#   r$   r     s   zSAS7BDATReader._decode_stringr   r=   c                 C  s   | j r| |S |S rA   )rV   r   r   r#   r#   r$   r     s   
z#SAS7BDATReader._convert_header_text)NTTNNTTrK   )rL   rM   rN   rO   rP   rO   rQ   rR   rS   rT   rU   rO   rV   rO   rW   r   r(   r@   )r(   rs   )r(   r@   )r(   r   )r   r7   r   r7   )r   r7   r   r7   r(   r7   )r   r7   r?   r7   )r   r7   r?   r7   r(   r9   )r(   rO   )r   r7   r?   r7   r(   r@   rA   )r   rR   r(   r   )r   r=   r(   r9   )!rD   rE   rF   __doc__rG   rC   rx   rz   r{   rr   ro   r   r   r   r   r   rp   r   r   r   rf   rg   rh   ri   rj   rk   rm   rl   r   r   r   r   r   r#   r#   r#   r$   rH      sP   
 
?




F









+



-
!

7
#rH   )r   r   r   r   )r&   r'   r   r   r(   r'   )4r   Z
__future__r   collectionsr   r   r   r   typingr   Znumpyr4   Zpandas._configr   Zpandas._libs.byteswapr   r	   r
   r   r   Zpandas._libs.sasr   r   Zpandas._libs.tslibs.conversionr   Zpandas.errorsr   Zpandasr!   r   r   r   Zpandas.io.commonr   Zpandas.io.sas.sas_constantsioZsasZsas_constantsr   Zpandas.io.sas.sasreaderr   Zpandas._typingr   r   r   r1   r0   r%   r5   r6   IteratorrH   r#   r#   r#   r$   <module>   s2    

