Skip to content

Obj vars

The following functions serve to instantiate variables for the object. The utilization of global variables is discouraged, primarily due to the potential for errors. For instance, consider the scenario where you create a sinusoidal object. To generate a continuous sinusoidal, it is crucial to store some pertinent values, such as phrase for example. If the variables are saved globally and multiple objects are created, errors may arise. In the sinusoidal case, all objects would store the phrase in the same variable, rendering the sinusoidal wrong. In examples like this, it is appropriate to employ the objects pd.set_obj_var, pd.get_obj_var and pd.accum_obj_var.


pd.set_obj_var

  • Example

    This function sets a value for an object internal variable.

    import pd
    
    def accum_thing(thing):
        pd.set_obj_var("my_obj_internal_var", thing)
    
  • Arguments

    Parameters Type Description
    arg1 string Variable Name.
    arg2 Python Object Python object to save

pd.accum_obj_var

  • Example

    This function will create a list with all the things that you save in it. py.collect uses this function and I believe that will be useful just in loop contexts.

    import pd
    
    def accum_thing(thing):
        pd.accum_obj_var("my_obj_internal_var", thing)
    
  • Arguments

    Parameters Type Description
    arg1 string Variable Name.
    arg2 Python Object Python object to save

pd.get_obj_var

  • Example

    It gets the value saved by pd.set_obj_var or pd.accum_obj_var.

    import pd
    
    def get_thing(thing):
        pd.get_obj_var("my_obj_internal_var")
    
  • Arguments

    Parameters Type Description
    arg1 string Variable Name.

pd.clear_obj_var

  • Example

    Set the variable to None and clear the memory.

    import pd
    
    def get_thing(thing):
        pd.clear_obj_var("my_obj_internal_var")
    
  • Arguments

    Parameters Type Description
    arg1 string Variable Name.