from collections import defaultdict
from typing import Dict, List, Any, Union, Iterable
from abc import ABC, abstractmethod
[docs]class ContextException(Exception):
"""Exception raised when an error related to a Context operation occurs.
"""
[docs]class Context:
"""Defines a context for code generation.
A Context is basically a dictionary of stacks. In other words, it defines
a `stack_name -> stack` mapping. Each `stack` has is semantically defined by its
`stack_name`.
Example:
>>> context = Context()
>>> context.put_value('current_value', '100')
>>> context.put_value('current_value', '200')
>>> context.get_value('current_value') # 200
>>> context.pop_value('current_value')
>>> context.get_value('current_value') # 100
"""
def __init__(self) -> None:
self.context: Dict[str, List[Any]] = defaultdict(list)
[docs] def put_value(self, name: str, value: Union[str, Iterable[str]]) -> None:
"""Pushes the value `value` to a stack named `name`.
Parameters:
name: Stack name.
value: Value to be pushed into the stack.
"""
self.context[name].append(value)
[docs] def get_value(self, name: str) -> str:
"""Gets the front value of the stack named `name`.
Parameters:
name: Stack name.
"""
try:
return self.context[name][-1]
except IndexError:
raise ContextException(f"Name {name} does not exist in the context.")
[docs] def pop_value(self, name: str) -> None:
"""Pops the front value of the stack named `name`.
Parameters:
name: Stack name.
"""
try:
self.context[name].pop()
except IndexError:
raise ContextException(f"Name {name} does not exist in the context.")
[docs] def clear_values(self, name: str) -> None:
"""Clears the stack named `name`.
Parameters:
name: Stack name.
"""
self.context[name].clear()
[docs]class ContextDelegate(ABC):
"""Delegate class for getting the generated code template file and its kwargs for a
given expression.
Also defines the context state changes when the corresponding expression node is visited
and exited.
Attributes:
context: Context instance.
unique_id: A unique id that can be used to identify values that were created from this context delegate.
Parameters:
context: Context instance.
unique_id: A unique id.
"""
def __init__(self, context: Context, unique_id: int):
self.context: Context = context
self.unique_id: int = unique_id
self.child = ""
[docs] @abstractmethod
def get_template_file(self) -> str:
"""Returns the template file containing the generated code for the expression.
"""
raise NotImplementedError
[docs] @abstractmethod
def template_kwargs(self) -> Dict[str, Any]:
"""Returns the arguments (a dictionary) that will be passed to the template.
"""
raise NotImplementedError
[docs] @abstractmethod
def context_enter(self) -> None:
"""Modifies the context state. Called when the expression node is visited.
Use this method to prepare the context for expressions that will be visited
afterwards. It is preferable to keep most `context.put_value` calls in this method.
"""
raise NotImplementedError
[docs] @abstractmethod
def context_exit(self) -> None:
"""Modifies the context state. Called when the expression node is exited.
Use this method to clear values from the context and prepare it for the
expression nodes that were visited before. It is preferable to keep most
`context.pop_value` calls in this method.
"""
raise NotImplementedError