Tips and Tricks

This chapter contains general suggestions and best practices for the application development in Python using the voraus-robot-arm library.

Private and Public Interfaces

In comparison to other programming languages privacy within modules and objects is not enforced. However, as a convention attributes with a leading underscore e.g. _my_method() are considered private.

voraus-robot-arm considers modules, functions, classes and methods within classes with a leading underscore as private. They may change any time without notice. Using or accessing them in an application directly may result in undesired behavior as they may bypass important validations or interfere with the robot control communication logic.

The public interface is available as a top-level import and should be used like this:

from voraus_robot_arm import (
    CartesianPose,
    Future,
    JointPose,
    MovePTPTrait,
    Percent,
    VorausIndustrialRobotArm,
    configure_logging,
    x,
    y,
    z,
)