The general_methods.py module

Summary

Functions

deprecate_kwargs	Issues deprecation warnings for arguments.
run_if_graphics_required	Check if graphics are available.
graphics_required	Decorate a method as requiring graphics.

Constants

GRAPHICS_ERROR

Description

General methods and helpers collection.

this includes decorator and methods

Module detail

general_methods.deprecate_kwargs(old_arguments, removed_version='0.3.0')

Issues deprecation warnings for arguments.

Parameters:

old_argumentsdict

key old argument value new argument name

removed_versionstr

Release version with which argument support will be removed By Default, next major release

general_methods.run_if_graphics_required(warning=False)

Check if graphics are available.

general_methods.graphics_required(method)

Decorate a method as requiring graphics.

Parameters:

methodcallable()

Method to decorate.

Returns:

callable()

Decorated method.

general_methods.GRAPHICS_ERROR = "Preview unsupported without 'ansys-tools-visualization_interface' installed. You can install...