Skip to main content

Monic Framework

Project description

Monic Framework

Code coverage Package version Supported Python versions PyPI - Downloads PyPI - License

Monic Framework is a powerful expression evaluation and code execution framework that provides a safe and flexible way to parse and interpret Python-style code. It offers a robust expression parser and interpreter designed for dynamic code evaluation, scripting, and embedded programming scenarios.

Key Features

  • Python-style syntax support
  • Secure code execution environment
  • Expression parsing and interpretation
  • Function definition and call support
  • Built-in type checking and validation
  • Seamless integration with existing Python projects

Supported Language Features

Core Python Features

  • Variables and basic data types (int, float, str, bool, etc.)
  • Control flow statements (if/else, for, while, break, continue)
  • Functions with full parameter support:
    • Positional and keyword arguments
    • Default values
    • Variable arguments (*args)
    • Keyword arguments (**kwargs)
    • Keyword-only arguments
  • Lambda expressions
  • List, set, and dictionary comprehensions
  • Context managers (with statements)
  • Exception handling (try/except/finally)
  • Classes and object-oriented programming
  • Pattern matching (match/case statements)

Expression Support

  • Arithmetic operations (+, -, *, /, //, %, **)
  • Comparison operations (==, !=, <, >, <=, >=)
  • Logical operations (and, or, not)
  • Bitwise operations (&, |, ^, <<, >>)
  • Assignment operations (=, +=, -=, *=, etc.)
  • Attribute access (obj.attr)
  • Subscript operations (obj[key])
  • Function and method calls
  • String formatting (f-strings)
  • Tuple and list unpacking
  • Named expressions (walrus operator :=)

Built-in Functions and Types

  • Essential built-ins (print, len, range, etc.)
  • Type conversion functions (int, float, str, bool)
  • Collection operations (min, max, sum, sorted)
  • Iteration helpers (enumerate, zip, filter, map)
  • Type checking (isinstance, issubclass)

Security Features

  • Sandboxed execution environment
  • Restricted access to system resources
  • Prevention of malicious code execution
  • Execution timeout protection:
    • Configurable maximum execution time
    • Automatic termination of long-running code
    • Protection against infinite loops
    • Time-based resource control
  • Forbidden operations disallowed:
    • File system operations
    • System command execution
    • Module imports
    • Access to sensitive attributes
    • Dangerous built-in functions

Installation

Basic Installation

pip install -U monic-framework

Or with extra dependencies such as pyarrow, numpy, pandas, and polars:

pip install -U monic-framework[extra]

Development Installation

pip install -e .[dev]

Or with extra dependencies such as pyarrow, numpy, pandas, and polars:

pip install -e .[dev,extra]

Quick Start

Basic Usage

from monic.expressions import ExpressionsParser, ExpressionsInterpreter


# Initialize parser and interpreter
parser = ExpressionsParser()
interpreter = ExpressionsInterpreter()

# Define code to execute
code = """
# Variable assignment
x = 10
y = 20

# Conditional statement
if x < y:
    result = "y is greater"
else:
    result = "x is greater"

# Return result
result
"""

# Parse code and execute it
tree = parser.parse(code)
result = interpreter.execute(tree)
print(result)  # Output: "y is greater"

Function Definition and Calls

from monic.expressions import ExpressionsParser, ExpressionsInterpreter


# Initialize parser and interpreter
parser = ExpressionsParser()
interpreter = ExpressionsInterpreter()

# Define code to execute
code = """
def calculate_sum(a: int, b: int) -> int:
    return a + b

def calculate_average(numbers: list[int]) -> float:
    total = 0
    for num in numbers:
        total += num
    return total / len(numbers)

# Using functions
sum_result = calculate_sum(10, 20)
avg_result = calculate_average([1, 2, 3, 4, 5])

[sum_result, avg_result]
"""

# Parse code and execute it
tree = parser.parse(code)
result = interpreter.execute(tree)
print(result)  # Output: [30, 3.0]

Binding Python Objects

from monic.expressions import (
    ExpressionsParser,
    ExpressionsInterpreter,
    monic_bind,
)


# Define functions and bind them to the interpreter
@monic_bind
def calculate_sum(x: int, y: int) -> int:
    return x + y


@monic_bind
def calculate_average(numbers: list[int]) -> float:
    total = 0
    for num in numbers:
        total += num
    return total / len(numbers)


# Initialize parser and interpreter
parser = ExpressionsParser()
interpreter = ExpressionsInterpreter()

# Define code to execute
code = """
# Using bound functions
sum_result = calculate_sum(10, 20)
avg_result = calculate_average([1, 2, 3, 4, 5])

[sum_result, avg_result]
"""

# Parse code and execute it
tree = parser.parse(code)
result = interpreter.execute(tree)
print(result)  # Output: [30, 3.0]

Timeout Control

from monic.expressions import ExpressionsParser, ExpressionsContext, ExpressionsInterpreter


# Initialize parser
parser = ExpressionsParser()
# Initialize with timeout context
context = ExpressionsContext(timeout=5.0)  # Set 5 seconds timeout
# Initialize interpreter with context
interpreter = ExpressionsInterpreter(context=context)

# This will be terminated after 5 seconds
code = """
while True:
    pass  # Infinite loop
"""

try:
    tree = parser.parse(code)
    interpreter.execute(tree)
except TimeoutError:
    print("Code execution timed out")  # Output: Code execution timed out

License

This project is licensed under the terms specified in the LICENSE file.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Issues and Support

For bug reports or feature requests, please submit them through GitHub Issues.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

monic_framework-0.1.6.tar.gz (42.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

monic_framework-0.1.6-py3-none-any.whl (44.3 kB view details)

Uploaded Python 3

File details

Details for the file monic_framework-0.1.6.tar.gz.

File metadata

  • Download URL: monic_framework-0.1.6.tar.gz
  • Upload date:
  • Size: 42.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.1

File hashes

Hashes for monic_framework-0.1.6.tar.gz
Algorithm Hash digest
SHA256 2213b7b26a1179b2c8804620a441d86ee615ece4c56bb529bd567a44a1c811ca
MD5 a801b869e5a40dfb783da6b098101b3f
BLAKE2b-256 3fe17858b1f161c432893529550fc9700c8ee4bb7109dabb6c7f0d3086f320c6

See more details on using hashes here.

File details

Details for the file monic_framework-0.1.6-py3-none-any.whl.

File metadata

File hashes

Hashes for monic_framework-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 bcbfc5bccc99d27ce157b7840dd13f23a42fadbec2ec7b24b68eda9cef06e9f9
MD5 c0c5c8949d77741dede3fa2006ceb464
BLAKE2b-256 d3052e9effa8557069993f5b2b28a38b90e1335495fb5c094474a49362392a34

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page