Next | Previous

reflect

This module provides many functions that can be used to interact with or modify modules, classes and functions. It is well suited for many uses cases such as creating a library that is heavily dependent on decorators (e.g. the json module).

For example,

We can call a decorator using the reflect module like this.

class A {
  @custom_decorator() {
    echo 'It works!'
  }
}

import reflect

var instance_of_a = A()
var decorator = reflect.get_decorator(instance_of_a, 'custom_decorator')

# It's always good to check the result first as it will be a good 
# practice to make decorators optional to make it easy for users to 
# opt-in and opt-out of features your package or library provide.
if decorator {
  decorator()
}

Try it out!

Functions

has_prop(object, name)

Returns true if instance has the property or module has a value with the given name or false if not.

Parameters
  • instance|module object
  • string name
Returns
  • bool

get_prop(object, name)

Returns the property of the instance or value in the module matching the given name or nil if the object contains no property with a matching name.

Parameters
  • instance|module object
  • string name
Returns
  • any

set_prop(object, name, value)

Sets the named property of the object to value.

Parameters
  • instance object
  • string name
  • any value
Returns
  • bool: true if a new property was set, false if a property was updated
Notes
  • if the property already exist, it overwrites it.

del_prop(object, name)

Deletes the named property from the instance

Parameters
  • instance|module object
  • string name
Returns
  • bool

has_method(object, name)

Returns true if class of the instance has the method name or false if not.

Parameters
  • instance object
  • string name
Returns
  • bool

has_decorator(object, name)

Returns true if class of the instance implements the decorator name or false if not.

Parameters
  • instance object
  • string name
Returns
  • bool

get_method(object, name)

Returns the method in a class instance matching the given name or nil if the class of the instance contains no method with a matching name.

Parameters
  • instance object
  • string name
Returns
  • function

get_decorator(object, name)

Returns the decorator function matching the given name in the class of the given instance.

Parameters
  • instance object
  • string name
Returns
  • function
Notes
  • the name of a decorator excludes the @ character.

bind_method(object, method)

Binds the given function to the instance, allowing you to access the instance itself in the function via the self keyword in the function.

Parameters
  • instance object
  • function method
Returns
  • function

get_type(object)

Returns the type of an instance as string

Parameters
  • instance object
Returns
  • string

get_function_metadata(function)

Returns the metadata of a function as a dictionary. This dictionary contains the following keys:

  • name: The name of the function
  • arity: The number of none variable (...) arguments the function defines.
  • is_variadic: If the function accepts variable arguments
  • captured_vars: The number of variables captured (only greater than zero for captures).
  • module: The name of the module from where the function was defined.
  • file: The file in which the function was defined.
Parameters
  • function object
Returns
  • dictionary
Notes
  • This function does not work for built-in functions

get_class_metadata(klass)

Returns the metadata of a class as a dictionary. This dictionary contains the following keys:

  • name: The name of the class.
  • properties: a list of the name of non-static properties defined in the class
  • static_properties: a list of the name of static properties defined in the class
  • methods: a list of the name of methods defined in the class
  • superclass: The name of the class it inherits from.
Parameters
  • class klass
Returns
  • dictionary

get_module_metadata(module)

Returns the metadata of an imported module as a dictionary. This dictionary contains the following keys:

  • name: The name of the module.
  • file: The file from which the module was imported.
  • has_preloader: true if the module is a C extension with a preloader and false otherwise.
  • has_unloader: true if the module is a C extension with a unloader and false otherwise.
  • definitions: A list of the name of objects defined in the module.
Parameters
  • module module
Returns
  • dictionary

get_class(object)

Returns the class value of an instance as an object that can be used to create a new instance of that same class.

Parameters
  • instance object
Returns
  • class

is_ptr(value)

Returns true if value is a pointer, false otherwise.

Parameters
  • any value
Returns
  • bool

get_ptr(value)

Returns a pointer to the given value.

Parameters
  • any value
Returns
  • ptr

set_ptr(pointer, value)

Sets the value at the given pointer's address to the given value.

Parameters
  • ptr pointer
  • any value

get_address(value)

Returns a the address of the pointer to the value in memory.

Parameters
  • any value
Returns
  • ptr

ptr_from_address(address)

Returns a pointer to the given memory address.

Parameters
  • number address
Returns
  • ptr

set_global(fn, name)

Sets a function or class as globally accessible in all modules, function and scopes.

Parameters
  • function|class fn
  • string? name

run_script(path)

Runs the content of a given script in-place as if it were part of the current module.

Parameters
  • string path

call_function(function, args)

Calls a function with the given arguments.

Parameters
  • function function
  • list args
Returns
  • any

Search

Navigation