Declare Command: Difference between revisions

From PyMOLWiki
Jump to navigation Jump to search
No edit summary
Line 20: Line 20:
     nullable_point: Optional[Tuple[int, int, int]] = None,
     nullable_point: Optional[Tuple[int, int, int]] = None,
     my_var: int | float
     my_var: int | float
     extended_calculation: bool = True
     extended_calculation: bool = True,
    old_style: Any = "Support anything currently not supported"
) -> IgnoredType:
) -> IgnoredType:
     """
     """
Line 32: Line 33:


I'm also propose to better support docstrings.
I'm also propose to better support docstrings.
==Difficulties==

Revision as of 07:32, 11 April 2025

The problem

Curent PyMOL approach to new plugin commands are outdated.

The proposal

Introduce a new system based on modern Python with type checking and implicit conversion.

What works right now?

On PyMOL open-source, but not on Incentive, there's a cmd.declare_command but isn't very much working for all possible cases.


Example

@declare_command
def new_command(
    dirname: Path = '.',
    nullable_point: Optional[Tuple[int, int, int]] = None,
    my_var: int | float
    extended_calculation: bool = True,
    old_style: Any = "Support anything currently not supported"
) -> IgnoredType:
    """
    A cool docstring.
    """
    pass


I'm also propose to better support docstrings.

Difficulties