Registration of commands executed in the application context

[gswifort]

A decorator like @command would be useful, which would register commands executed in the application context.

Example of use:

from pyrx import Ap, command

@appctx_command(lock=False)
def doit():
    Ap.DocManager().appContextOpenDocument(r"C:\path\to\file.dwg")

Code outline:

import functools
import traceback

from pyrx import Ap, command

def appctx_command(
    func=None,
    *,
    name: str | None = None,
    lock: bool = True,
    flags: Ap.CmdFlags | None = None,
    change_cwd: bool = True,
):
    def decorator(f):
        appctx_cmd = _appctx_command(
            func=f,
            name=name,
            lock=lock,
            flags=flags,
            change_cwd=change_cwd,
        )
        appctx_cmd.register()
        return f

    if func is not None:
        return decorator(func)
    else:
        return decorator


class _appctx_command:
    def __init__(
        self,
        func,
        name: str | None = None,
        lock: bool = True,
        flags: Ap.CmdFlags | None = None,
        change_cwd: bool = True,
    ):
        self._func = func
        self._name = name
        self._lock = lock
        self._flags = flags
        self._change_cwd = change_cwd

    def _get_command_name(self):
        if self._name is not None:
            return self._name
        return self._func.__name__

    def _wrap_with_lock(self):
        if self._lock:
            # lock should probably not be used if we plan to open new
            # documents → Ap.DocManager.appContextOpenDocument()
            lock = Ap.AutoDocLock()
        try:
            return self._func()
        finally:
            if self._lock:
                del lock

    def _wrap(self):
        @functools.wraps(self._func)
        def wrapper():
            Ap.Application.removeOnIdleWinMsg(wrapper)
            try:
                self._wrap_with_lock()
            except Exception:
                traceback.print_exc()

        Ap.Application.registerOnIdleWinMsg(wrapper)

    def register(self):
        rv = command(
            func=self._wrap,
            name=self._get_command_name(),
            flags=self._flags,
            change_cwd=self._change_cwd,
        )
        return rv

[CEXT-Dan]

is this similar to using the Ap.CmdFlags.SESSION flag?

[CEXT-Dan]

Ideally for a pure application context, one might use flags SESSION | NOINTERNALLOCK

• SESSION Not bound to a single document lock
• NOINTERNALLOCK Prevents AutoCAD from automatically applying a document lock.

Admittedly, I rarely venture out of modal commands, but I think these flags are needed for items like beginExecuteInApplicationContext

[gswifort]

It seems that Ap.DocManager().appContextOpenDocument() it even works only with SESSION (NOINTERNALLOCK is not required). Strange, I was sure I had tested this before without success.

[gswifort]

Strange, I was sure I had tested this before without success.

I think I found the culprit #493

[CEXT-Dan]

Having an @appctx_command is a good idea though as shortcut, defaulted to something like SESSION | NOBEDIT
The flags are a pain to remember