Source code for idmtools.core.context

"""
Manages the idmtools context, mostly around the platform object.

This context allows us to easily fetch what platforms we are executing on and also supported nested, multi-platform operations.

Copyright 2021, Bill & Melinda Gates Foundation. All rights reserved.
"""
from logging import getLogger
from typing import TYPE_CHECKING

logger = getLogger(__name__)
if TYPE_CHECKING:  # pragma: no cover
    # The current platform
    from idmtools.entities.iplatform import IPlatform

current_platform_stack = []
CURRENT_PLATFORM: 'IPlatform' = None


[docs]def set_current_platform(platform: 'IPlatform'):
    """
    Set the current platform that is being used to execute scripts.

    Args:
        platform: Platform to set

    Returns:
        None
    """
    global CURRENT_PLATFORM, current_platform_stack
    if CURRENT_PLATFORM and CURRENT_PLATFORM != platform and platform not in current_platform_stack:
        current_platform_stack.append(CURRENT_PLATFORM)
    CURRENT_PLATFORM = platform


[docs]def remove_current_platform():
    """
    Set CURRENT_PLATFORM to None and delete old platform object.

    Returns:
        None
    """
    global CURRENT_PLATFORM, current_platform_stack
    old_current_platform = CURRENT_PLATFORM
    if len(current_platform_stack):
        new_platform = current_platform_stack.pop()
    else:
        new_platform = None
    del old_current_platform
    CURRENT_PLATFORM = new_platform


[docs]def clear_context():
    """
    Clear all platforms from context.
    """
    global CURRENT_PLATFORM, current_platform_stack
    old_current_platform = CURRENT_PLATFORM
    CURRENT_PLATFORM = None
    current_platform_stack.clear()
    del old_current_platform


[docs]def get_current_platform() -> 'IPlatform':
    """
    Get current platform.
    """
    return CURRENT_PLATFORM