Package ai.timefold.jpyinterpreter.types

Interface PythonLikeFunction

All Superinterfaces:

PythonLikeObject

All Known Implementing Classes:

BinaryDunderBuiltin, BoundPythonLikeFunction, CPythonBackedPythonLikeObject, CPythonType, GeneratedFunctionMethodReference, JavaMethodReference, MultiDispatchJavaMethodReference, PythonKnownFunctionType, PythonLikeFunctionWrapper, PythonLikeGenericType, PythonLikeType, PythonObjectWrapper, TernaryDunderBuiltin, UnaryDunderBuiltin

public interface PythonLikeFunction
extends PythonLikeObject

Method Summary

Modifier and Type	Method	Description
PythonLikeObject	$call(List<PythonLikeObject> positionalArguments, Map<PythonString,PythonLikeObject> namedArguments, PythonLikeObject callerInstance)	Calls the function with positional arguments and named arguments.
default void	$deleteAttribute(String attributeName)	Delete an attribute by name.
default PythonLikeObject	$getAttributeOrNull(String attributeName)	Gets an attribute by name.
default PythonLikeType	$getType()	Returns the type describing the object
default void	$setAttribute(String attributeName, PythonLikeObject value)	Sets an attribute by name.
static PythonLikeType	getClassFunctionType()
static PythonLikeType	getFunctionType()
static PythonLikeType	getStaticFunctionType()

Methods inherited from interface ai.timefold.jpyinterpreter.PythonLikeObject

$getAttributeOrError, $getGenericType, $method$__delattr__, $method$__eq__, $method$__format__, $method$__format__, $method$__getattribute__, $method$__hash__, $method$__ne__, $method$__repr__, $method$__setattr__, $method$__str__

Method Details

getStaticFunctionType

static PythonLikeType getStaticFunctionType()

getFunctionType

static PythonLikeType getFunctionType()

getClassFunctionType

static PythonLikeType getClassFunctionType()

$call

PythonLikeObject $call(List<PythonLikeObject> positionalArguments,
 Map<PythonString,PythonLikeObject> namedArguments,
 PythonLikeObject callerInstance)

Calls the function with positional arguments and named arguments.

Parameters:

positionalArguments - Positional arguments

namedArguments - Named arguments

callerInstance - The first argument passed to the caller, if any; null otherwise (used for super)

Returns:

The function result

$getAttributeOrNull

default PythonLikeObject $getAttributeOrNull(String attributeName)

Description copied from interface: PythonLikeObject

Gets an attribute by name.

Specified by:

$getAttributeOrNull in interface PythonLikeObject

Parameters:

attributeName - Name of the attribute to get

Returns:

The attribute of the object that corresponds with attributeName

$setAttribute

default void $setAttribute(String attributeName,
 PythonLikeObject value)

Description copied from interface: PythonLikeObject

Sets an attribute by name.

Specified by:

$setAttribute in interface PythonLikeObject

Parameters:

attributeName - Name of the attribute to set

value - Value to set the attribute to

$deleteAttribute

default void $deleteAttribute(String attributeName)

Description copied from interface: PythonLikeObject

Delete an attribute by name.

Specified by:

$deleteAttribute in interface PythonLikeObject

Parameters:

attributeName - Name of the attribute to delete

$getType

default PythonLikeType $getType()

Description copied from interface: PythonLikeObject

Returns the type describing the object

Specified by:

$getType in interface PythonLikeObject

Returns:

the type describing the object