logicfp 3.0.0

logicfp protection runtime and HTTP service

Logic Fingerprint (logicfp)

logicfp is a Python protection library for wrapping function boundaries with lightweight circuit-breaker style control.

Developer documentation lives in README.developer.md.

Install

pip install logicfp

Quick Start

from logicfp import protect


@protect()
def call_model(request):
    return {"answer": request.payload["text"].upper()}


result = call_model(payload={"text": "hello"})

Use @protect() when you want the default user-mode entrypoint.
Use create_protector() when you need more than one protector instance.
Use logicfp.user_mode when you want explicit user-mode types like ErrorCode, NormalizationError, LogicExecutionError, and ProtectRuntimeError.

User Mode Contract

The current user-mode contract centers on:

• protect
• create_protector
• logicfp.user_mode.ErrorCode
• logicfp.user_mode.NormalizationError
• logicfp.user_mode.LogicExecutionError
• logicfp.user_mode.ProtectRuntimeError
• logicfp.config.describe_effective_config

If you do not have a clear service-hosting need, stay in user mode.

Minimal Config

Put your project config at:

your_project/config/config.yaml

logicfp:
  instance_id: decorator-node
  default_source: user_function
  backend_type: memory

Use logicfp: as the main YAML section name. Older logic_fingerprint: configs are still accepted for compatibility.
For user mode, backend_type: memory is still the recommended default.

Failure Styles

logicfp supports two user-mode failure styles:

• simple=True success returns your result directly, failure raises ProtectRuntimeError
• simple=False success returns ok/result/context, failure returns ok/error/context

Example:

from logicfp import protect


@protect(simple=False)
def review_text(request):
    return {"summary": request.payload["text"][:20]}

Learn More

• Quick user-mode guide: documents/Tutorial/用户模式快速接入.md
• User mode: documents/Tutorial/用户模式示例.md
• User-mode error codes: documents/Tutorial/用户模式错误码说明.md
• User-mode envelope contract: documents/Tutorial/用户模式返回结构说明.md
• Mode guide: documents/Tutorial/protect 的用户模式与工程模式.md
• Optional engineering mode: documents/Tutorial/工程模式示例.md