dumps raw data to a file

dumping raw data to file

Dumps any data raw to a file. This is helpful to easily dump data without writing extra boilerplate code just to dump data raw to a file. Nothing is returned. Creates a new or overwrites an existing file by default (See append parameter to change mode).

Basic Example of dumping to a file using default positional parameters

maci.dumpraw('', data)

In this example, we simply dump any raw data to a file using the dumpraw function and pass a string of the filepath to the file as the first argument to the function, then pass any data as the second argument to the function to be written to the file.

parameters & arguments

Describes all parameter functionality and accepted data types

filename: str | Path

First required positional argument. Accepts strings and Path objects

Use this parameter to point to your filepath

*data: Any

Second required positional argument. Accepts any data type.

This parameter accepts any number of positional arguments but must supply at least 1 at a minimum.

append: bool

Optional parameter. Accepts booleans. Default = False. File must already exist.

Use this parameter to enable appending mode to write by appending data to the file. Default is disabled which writes new or overwrites a file.

byte_data: bool

Optional parameter. Accepts booleans. Default = False

Use this parameter to set dumping your data to the file as bytes. Default is disabled as dumping the string representation is more common, but enable it if you need the data written as bytes.

newline_sep: bool

Optional parameter. Accepts booleans. Default = True

Use this parameter to enable/disable the newline separator character set between each piece of data when passing more than 1 positional argument to data parameter.

Default is enabled to receive a more expected or desirable result in the file.

encoding: str | None

Optional parameter. Accepts strings or None. Default = None

Use this parameter to dump the data with the desired codec of the data if needed. The default uses the default of python, so you don't have to use this, but you can if the data needs to be written with a specific codec.

Last updated