# Copyright (c) 2016 Universidade Federal Fluminense (UFF)
# Copyright (c) 2016 Polytechnic Institute of New York University.
# Copyright (c) 2018, 2019, 2020 President and Fellows of Harvard College.
# This file is part of ProvBuild.

"""Execution Provider base"""

from __future__ import (absolute_import, print_function,
                        division, unicode_literals)

import sys
from collections import defaultdict

from .argument_captors import ArgumentCaptor


class ExecutionProvider(object):                                                 # pylint: disable=too-many-instance-attributes
    """Execution provider base class"""

    def __init__(self, metascript):
        # Indicates when activations should be collected
        #   (only after the first call to the script)
        self.enabled = False
        # User files
        self.script = metascript.path
        self.paths = metascript.paths
        # Which function types ('main', 'package' or 'all')
        #   should be considered for the threshold
        self.context = metascript.context
        # How deep we want to go when capturing function activations?
        self.depth_threshold = metascript.depth
        # How deep we want to go beyond our context
        self.non_user_depth_threshold = metascript.non_user_depth

        # Object serializer function
        self.serialize = metascript.serialize

        self.metascript = metascript
        self.trial_id = metascript.trial_id
        self.event_map = defaultdict(lambda: self.trace_empty, {})
        self.default_profile = sys.getprofile()
        self.default_trace = sys.gettrace()

        self.argument_captor = ArgumentCaptor(self)

    def trace_empty(self, frame, event, arg):
        """Call this function when trace event is not defined"""
        pass

    def store(self, partial=False):
        """Store provenance. Override it on subclasses"""
        pass

    def teardown(self):
        """Disable collection"""
        self.enabled = False

    def tearup(self):
        """Enable collection"""
        pass
