Skip to content

CHANGELOG.md

Latest commit

 

History

History
67 lines (56 loc) · 4.01 KB

CHANGELOG.md

File metadata and controls

67 lines (56 loc) · 4.01 KB

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[1.3.1] - 2026-04-27

Added

  • Comprehensive code examples in docstrings for all public API classes and functions: D3Session, D3AsyncSession, D3PluginClient, D3PythonScript, D3Function, DesignerPlugin, PluginException, PluginPayload, and all low-level functions in api.py.
  • scripts/generate_astro_docs.py: script for generating Astro-compatible API reference documentation.

Changed

  • Improved DesignerPlugin class docstring and expanded default_init(), from_json_file(), and service_info docstrings with full Args/Returns sections and examples.
  • Added explicit notes to register_module and register_all_modules on D3Session and D3AsyncSession clarifying that eager registration is only needed in rare cases — sessions already auto-register lazily on execute().
  • PluginPayload.is_module_payload() and debug_string() now have docstrings.

[1.3.0] - 2026-01-06

Added

  • Lazy module registration: D3Session.execute() and D3AsyncSession.execute() now automatically register a @d3function module on first use, eliminating the need to declare all modules in context_modules upfront.
  • registered_modules tracking on session instances prevents duplicate registration calls.
  • Jupyter notebook support: @d3function now automatically replaces a previously registered function when the same name is re-registered in the same module, with a warning log. This enables iterative workflows in Jupyter notebooks where cells are re-executed.
  • Automatic import detection: @d3function now automatically discovers file-level imports used by the decorated function and includes them in the registered module. In Jupyter notebooks, place imports inside the function body instead.

Removed

  • add_packages_in_current_file(): Removed. Imports are now detected automatically by @d3function.
  • find_packages_in_current_file(): Removed. Replaced by find_imports_for_function().

Changed

  • d3_api_plugin has been renamed to d3_api_execute.
  • d3_api_aplugin has been renamed to d3_api_aexecute.
  • context_modules parameter type updated from list[str] to set[str] on D3Session, D3AsyncSession, and D3SessionBase.
  • Updated documentation to reflect pystub proxy support.
  • Bumped actions/checkout to v6 and astral-sh/setup-uv to v7 in CI.
  • Added Test PyPI publish workflow (test-publish.yml) for dev version releases.

[1.2.0] - 2025-12-02

Added

  • Client API: Metaclass-based remote method execution with D3PluginClient
    • Support for both sync and async methods
    • Automatic Python 2.7 code conversion for Designer compatibility
    • Session management with context managers
  • Functional API: Decorator-based remote execution
    • @d3pythonscript decorator for one-off script execution
    • @d3function(module_name) decorator for reusable module-based functions
    • Function chaining support within modules
  • Session Management: D3Session and D3AsyncSession classes
    • rpc() method for simple return value retrieval
    • execute() method for full response with logs and status
    • Automatic module registration via context managers
  • Type Safety: Full Pydantic models for all API interactions
    • PluginPayload, PluginResponse, RegisterPayload
    • Generic type support for type-safe return values
  • Logging: Configurable logging with enable_debug_logging()
    • NullHandler by default (library best practice)
    • Granular module-level control
  • AST Utilities: Python 3 to Python 2.7 code transformation
    • F-string to .format() conversion
    • Type annotation removal
    • Async/await removal
    • Automatic package import detection
  • Comprehensive test suite with 99 tests covering all major functionality
  • CI/CD with GitHub Actions (ruff, mypy, pytest)
  • PEP 561 type hints marker (py.typed)