Skip to content

Commit

Permalink
more autogen doc fixes for latest changes
Browse files Browse the repository at this point in the history
  • Loading branch information
tomweber-sas committed Aug 18, 2020
1 parent 7b8ec6a commit 90490b7
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 2 deletions.
20 changes: 18 additions & 2 deletions saspy/sasbase.py
Original file line number Diff line number Diff line change
Expand Up @@ -1150,8 +1150,14 @@ def df2sd(self, df: 'pandas.DataFrame', table: str = '_df', libref: str = '',
:param table: the name of the SAS Data Set to create
:param libref: the libref for the SAS Data Set being created. Defaults to WORK, or USER if assigned
:param results: format of results, SASsession.results is default, PANDAS, HTML or TEXT are the alternatives
As of version 3.5.0, keep_outer_quotes is deprecated and embedded_newlines defaults to True
:param keep_outer_quotes: the defualt is for SAS to strip outer quotes from delimitted data. This lets you keep them
:param embedded_newlines: if any char columns have embedded CR or LF, set this to True to get them iported into the SAS data set
colrep is new as of version 3.5.0
:param LF: if embedded_newlines=True, the chacter to use for LF when transferring the data; defaults to hex(1)
:param CR: if embedded_newlines=True, the chacter to use for CR when transferring the data; defaults to hex(2)
:param colsep: the column seperator character used for streaming the delimmited data to SAS defaults to hex(3)
Expand All @@ -1176,8 +1182,14 @@ def dataframe2sasdata(self, df: 'pandas.DataFrame', table: str = '_df', libref:
:param table: the name of the SAS Data Set to create
:param libref: the libref for the SAS Data Set being created. Defaults to WORK, or USER if assigned
:param results: format of results, SASsession.results is default, PANDAS, HTML or TEXT are the alternatives
As of version 3.5.0, keep_outer_quotes is deprecated and embedded_newlines defaults to True
:param keep_outer_quotes: the defualt is for SAS to strip outer quotes from delimitted data. This lets you keep them
:param embedded_newlines: if any char columns have embedded CR or LF, set this to True to get them iported into the SAS data set
colrep is new as of version 3.5.0
:param LF: if embedded_newlines=True, the chacter to use for LF when transferring the data; defaults to hex(1)
:param CR: if embedded_newlines=True, the chacter to use for CR when transferring the data; defaults to hex(2)
:param colsep: the column seperator character used for streaming the delimmited data to SAS defaults to hex(3)
Expand Down Expand Up @@ -1243,10 +1255,12 @@ def sd2df(self, table: str, libref: str = '', dsopts: dict = None,
For the CSV and DISK methods, the following 2 parameters are also available
:param tempfile: [optional] an OS path for a file to use for the local file; default it a temporary file that's cleaned up
:param tempkeep: if you specify your own file to use with tempfile=, this controls whether it's cleaned up after using it
For the MEMORY and DISK methods, the following 4 parameters are also available, depending upon access method
:param rowsep: the row seperator character to use; defaults to hex(1)
:param colsep: the column seperator character to use; defaults to hex(2)
:param rowrep: the char to convert to for any embedded rowsep chars, defaults to ' '
Expand Down Expand Up @@ -1387,16 +1401,18 @@ def sasdata2dataframe(self, table: str, libref: str = '', dsopts: dict = None,
- MEMORY the original method. Streams the data over and builds the dataframe on the fly in memory
- CSV uses an intermediary Proc Export csv file and pandas read_csv() to import it; faster for large data
- DISK uses the original (MEMORY) method, but persists to disk and uses pandas read to import.
this has better support than CSV for embedded delimiters (commas), nulls, CR/LF that CSV
- DISK uses the original (MEMORY) method, but persists to disk and uses pandas read to import. \
this has better support than CSV for embedded delimiters (commas), nulls, CR/LF that CSV \
has problems with
For the CSV and DISK methods, the following 2 parameters are also available
:param tempfile: [optional] an OS path for a file to use for the local file; default it a temporary file that's cleaned up
:param tempkeep: if you specify your own file to use with tempfile=, this controls whether it's cleaned up after using it
For the MEMORY and DISK methods, the following 4 parameters are also available, depending upon access method
:param rowsep: the row seperator character to use; defaults to hex(1)
:param colsep: the column seperator character to use; defaults to hex(2)
:param rowrep: the char to convert to for any embedded rowsep chars, defaults to ' '
Expand Down
2 changes: 2 additions & 0 deletions saspy/sasdata.py
Original file line number Diff line number Diff line change
Expand Up @@ -1086,10 +1086,12 @@ def to_df(self, method: str = 'MEMORY', **kwargs) -> 'pandas.DataFrame':
For the CSV and DISK methods, the following 2 parameters are also available
:param tempfile: [optional] an OS path for a file to use for the local file; default it a temporary file that's cleaned up
:param tempkeep: if you specify your own file to use with tempfile=, this controls whether it's cleaned up after using it
For the MEMORY and DISK methods the following 4 parameters are also available, depending upon access method
:param rowsep: the row seperator character to use; defaults to hex(1)
:param colsep: the column seperator character to use; defaults to hex(2)
:param rowrep: the char to convert to for any embedded rowsep chars, defaults to ' '
Expand Down

0 comments on commit 90490b7

Please sign in to comment.