Module Import alias ImportFrom alias FunctionDef arguments args NameParam defaults NameLoad body Expr Str Import alias ImportFrom alias Return Call NameLoad AttributeLoad NameLoad attr keyword NameLoad keyword NameLoad keyword NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults NameLoad NameLoad body Expr Str If CompareIs NameLoad NameLoad body Assign NameStore Str ImportFrom alias Return Call NameLoad NameLoad keyword NameLoad keyword NameLoad keyword NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults NameLoad NameLoad body Expr Str If CompareIs NameLoad NameLoad body Assign NameStore Str ImportFrom alias Return Call NameLoad NameLoad keyword NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults NameLoad NameLoad body Expr Str If CompareIs NameLoad NameLoad body Assign NameStore Call NameLoad If CompareIs NameLoad NameLoad body TryExcept body ImportFrom alias handlers ExceptHandler type NameLoad body ImportFrom alias Expr Call AttributeLoad NameLoad attr Str Assign NameStore Call NameLoad NameLoad orelse ImportFrom alias Assign NameStore Call NameLoad NameLoad keyword NameLoad Return Call NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults NameLoad NameLoad body Expr Str If CompareIs NameLoad NameLoad body Assign NameStore Call NameLoad If CompareIs NameLoad NameLoad body TryExcept body ImportFrom alias handlers ExceptHandler type NameLoad body ImportFrom alias Expr Call AttributeLoad NameLoad attr Str Assign NameStore Call NameLoad NameLoad orelse ImportFrom alias Assign NameStore Call NameLoad NameLoad keyword NameLoad Return Call NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults NameLoad NameLoad body Expr Str If CompareIs NameLoad NameLoad body Assign NameStore Call NameLoad If CompareIs NameLoad NameLoad body TryExcept body ImportFrom alias handlers ExceptHandler type NameLoad body ImportFrom alias Expr Call AttributeLoad NameLoad attr Str Assign NameStore Call NameLoad NameLoad orelse ImportFrom alias Assign NameStore Call NameLoad NameLoad keyword NameLoad Return Call NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults NameLoad NameLoad body Expr Str If CompareIs NameLoad NameLoad body Assign NameStore Call NameLoad If CompareIs NameLoad NameLoad body ImportFrom alias Assign NameStore Call NameLoad NameLoad orelse ImportFrom alias Assign NameStore Call NameLoad NameLoad keyword NameLoad Return Call NameLoad NameLoad decorator_list
N/A N/A warnings pikos._internal.monitor_attach MonitorAttach screen N/A N/A filter_ N/A None N/A N/A  Factory function that returns a basic recorder that outputs to screen

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

     N/A sys pikos.recorders.text_stream_recorder TextStreamRecorder N/A N/A TextStreamRecorder N/A sys stdout filter_ filter_ auto_flush True formatted True N/A textfile N/A N/A filename filter_ N/A None None N/A N/A  Factory function that returns a basic recorder that outputs to file.

    Parameters
    ----------
    filename: string
        The name and path of the file where to store the records. Default
        name is "monitor_records.txt".

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

     N/A N/A filename None N/A N/A filename monitor_records.log pikos.recorders.text_file_recorder TextFileRecorder N/A N/A TextFileRecorder filename filter_ filter_ auto_flush True formatted True N/A csvfile N/A N/A filename filter_ N/A None None N/A N/A  Factory function that returns a basic recorder that outputs to file.

    Parameters
    ----------
    filename : string
        The name and path of the file where to store the records. Default
        name is "monitor_records.txt".

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

     N/A N/A filename None N/A N/A filename monitor_records.csv pikos.recorders.csv_file_recorder CSVFileRecorder N/A N/A CSVFileRecorder filename filter_ filter_ N/A monitor_functions N/A N/A recorder focus_on N/A None None N/A N/A  Factory function that returns a basic function monitor.

    Parameters
    ----------
    recorder : AbstractRecorder
        The recorder to use and store the records. Default is outout to screen.

    focus_on : list
        The list of function where to focus monitoring.

     N/A N/A recorder None N/A N/A recorder N/A screen N/A N/A focus_on None N/A N/A N/A pikos.cymonitors.api FunctionMonitor N/A N/A N/A ImportError N/A pikos.monitors.api FunctionMonitor N/A N/A N/A warnings warn Cython monitors are not available falling back to pure python N/A monitor N/A FunctionMonitor recorder N/A pikos.monitors.focused_function_monitor FocusedFunctionMonitor N/A monitor N/A FocusedFunctionMonitor recorder functions focus_on N/A N/A MonitorAttach monitor N/A monitor_lines N/A N/A recorder focus_on N/A None None N/A N/A  Factory function that returns a basic line monitor.

    Parameters
    ----------
    recorder : AbstractRecorder
        The recorder to use and store the records. Default is outout to screen.

    focus_on : list
        The list of function where to focus monitoring.

     N/A N/A recorder None N/A N/A recorder N/A screen N/A N/A focus_on None N/A N/A N/A pikos.cymonitors.api LineMonitor N/A N/A N/A ImportError N/A pikos.monitors.api LineMonitor N/A N/A N/A warnings warn Cython monitors are not available falling back to pure python N/A monitor N/A LineMonitor recorder N/A pikos.monitors.focused_line_monitor FocusedLineMonitor N/A monitor N/A FocusedLineMonitor recorder functions focus_on N/A N/A MonitorAttach monitor N/A memory_on_functions N/A N/A recorder focus_on N/A None None N/A N/A  Factory function that returns a basic function memory monitor.

    Parameters
    ----------
    recorder : AbstractRecorder
        The recorder to use and store the records. Default is outout to screen.

    focus_on : list
        The list of function where to focus monitoring.

     N/A N/A recorder None N/A N/A recorder N/A screen N/A N/A focus_on None N/A N/A N/A pikos.cymonitors.function_memory_monitor FunctionMemoryMonitor N/A N/A N/A ImportError N/A pikos.monitors.function_memory_monitor FunctionMemoryMonitor N/A N/A N/A warnings warn Cython monitors are not available falling back to pure python N/A monitor N/A FunctionMemoryMonitor recorder N/A pikos.monitors.focused_function_memory_monitor FocusedFunctionMemoryMonitor N/A monitor N/A FocusedFunctionMemoryMonitor recorder functions focus_on N/A N/A MonitorAttach monitor N/A memory_on_lines N/A N/A recorder focus_on N/A None None N/A N/A  Factory function that returns a basic line memory monitor.

    Parameters
    ----------
    recorder : AbstractRecorder
        The recorder class to use and store the records. Default is outout to
        screen.

    focus_on : list
        The list of function where to focus monitoring.

     N/A N/A recorder None N/A N/A recorder N/A screen N/A N/A focus_on None N/A pikos.monitors.line_memory_monitor LineMemoryMonitor N/A monitor N/A LineMemoryMonitor recorder N/A pikos.monitors.focused_line_memory_monitor FocusedLineMemoryMonitor N/A monitor N/A FocusedLineMemoryMonitor recorder functions focus_on N/A N/A MonitorAttach monitor N/A