Module Import alias ImportFrom alias ClassDef bases NameLoad body Expr Str FunctionDef arguments args NameParam NameParam NameParam defaults NameLoad kwarg body Expr Str Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr IfExp CompareIs NameLoad NameLoad Lambda arguments args NameParam defaults NameLoad NameLoad Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str If UnaryOpNot AttributeLoad NameLoad attr body Assign AttributeStore NameLoad attr Call NameLoad AttributeLoad NameLoad attr Str Assign AttributeStore NameLoad attr Call AttributeLoad NameLoad attr AttributeLoad NameLoad attr AttributeLoad NameLoad attr Expr Call AttributeLoad Call NameLoad NameLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Expr Call AttributeLoad Call NameLoad NameLoad NameLoad attr If UnaryOpNot AttributeLoad AttributeLoad NameLoad attr attr body Expr Call AttributeLoad AttributeLoad NameLoad attr attr Expr Call AttributeLoad AttributeLoad NameLoad attr attr decorator_list decorator_list
N/A N/A csv pikos.recorders.csv_recorder CSVRecorder CSVFileRecorder N/A CSVRecorder N/A N/A  A CSVRecorder that creates the stream (i.e. file) for the records.

    Private
    -------
    _filter : callable
        Used to check if the set `record` should be `recorded`. The function
        accepts a tuple of the `record` values and return True is the input
        sould be recored.

    _writer : csv.writer
        The `writer` object is owned by the CSVRecorder and exports the record
        values according to the configured dialect.

    _ready : bool
        Singify that the Recorder is ready to accept data.

    _filename : string
        The name and path of the file to be used for output.

    _file : file
        The file object where records are stored.

     __init__ N/A N/A self filename filter_ N/A None csv_kwargs N/A N/A  Class initialization.

        Parameters
        ----------
        filename : string
            The file path to use.

        filter_ : callable
            A callable function that accepts a data tuple and returns True
            if the input sould be recorded. Default is None.

        **csv_kwargs :
            Key word arguments to be passed to the *cvs.writer*.

         N/A N/A self _filename filename N/A N/A self _filter N/A N/A filter_ None N/A N/A N/A x N/A True filter_ N/A N/A self _csv_kwargs csv_kwargs N/A N/A self _handle None N/A N/A self _writer None N/A N/A self _ready False N/A prepare N/A N/A self record N/A N/A N/A  Open the csv file and write the header in the csv file.

         N/A N/A N/A self _ready N/A N/A N/A self _handle N/A open N/A self _filename wb N/A N/A self _writer N/A N/A csv writer N/A self _handle N/A self _csv_kwargs N/A N/A N/A N/A super CSVFileRecorder self prepare record N/A finalize N/A N/A self N/A N/A N/A  Finalize the recorder.

        Raises
        ------
        RecorderError :
            Raised if the method is called without the recorder been ready to
            accept data.

         N/A N/A N/A N/A super CSVFileRecorder self finalize N/A N/A N/A N/A self _handle closed N/A N/A N/A N/A N/A self _handle flush N/A N/A N/A N/A self _handle close N/A N/A