The `checks.py` module#

Summary#

Functions

`ensure_design_is_active`	Make sure that the design is active before executing a method.
`check_is_float_int`	Check if a parameter has a float or integer value.
`check_ndarray_is_float_int`	Check if a `numpy.ndarray` has float/integer types.
`check_ndarray_is_not_none`	Check if a `numpy.ndarray` is all `None`.
`check_ndarray_is_all_nan`	Check if a `numpy.ndarray` is all nan-valued.
`check_ndarray_is_non_zero`	Check if a `numpy.ndarray` is zero-valued.
`check_pint_unit_compatibility`	Check if input `pint.Unit` is compatible with the expected input.
`check_type_equivalence`	Check if an input object is of the same class as an expected object.
`check_type`	Check if an input object is of the same type as expected types.
`check_type_all_elements_in_iterable`	Check if all elements in an iterable are of the same type as expected.
`min_backend_version`	Compare a minimum required version to the current backend version.
`deprecated_method`	Decorate a method as deprecated.
`deprecated_argument`	Decorate a method argument as deprecated.
`run_if_graphics_required`	Check if graphics are available.
`graphics_required`	Decorate a method as requiring graphics.
`kwargs_passed_not_accepted`	Check that no unexpected kwargs are passed to the method.

Constants

ERROR_GRAPHICS_REQUIRED

Message to display when graphics are required for a method.

Description#

Provides functions for performing common checks.

Module detail#

checks.ensure_design_is_active(method)#

Make sure that the design is active before executing a method.

This function is necessary to be called whenever we do any operation on the design. If we are just accessing information of the class, it is not necessary to call this.

checks.check_is_float_int(param: object, param_name: str | None = None) → None#

Check if a parameter has a float or integer value.

Parameters:

paramobject: Object instance to check.
param_namestr, default: None: Parameter name (if any).

Raises:

TypeError: If the parameter does not have a float or integer value.

checks.check_ndarray_is_float_int(param: numpy.ndarray, param_name: str | None = None) → None#

Check if a numpy.ndarray has float/integer types.

Parameters:

paramndarray: numpy.ndarray instance to check.
param_namestr, default: None: numpy.ndarray instance name (if any).

Raises:

TypeError: If the numpy.ndarray instance does not have float or integer values.

checks.check_ndarray_is_not_none(param: numpy.ndarray, param_name: str | None = None) → None#

Check if a numpy.ndarray is all None.

Parameters:

paramndarray: numpy.ndarray instance to check.
param_namestr, default: None: numpy.ndarray instance name (if any).

Raises:

ValueError: If the numpy.ndarray instance has a value of None for all parameters.

checks.check_ndarray_is_all_nan(param: numpy.ndarray, param_name: str | None = None) → None#

Check if a numpy.ndarray is all nan-valued.

Parameters:

paramndarray: numpy.ndarray instance to check.
param_namestr or None, default: None: numpy.ndarray instance name (if any).

Raises:

ValueError: If the numpy.ndarray instance is all nan-valued.

checks.check_ndarray_is_non_zero(param: numpy.ndarray, param_name: str | None = None) → None#

Check if a numpy.ndarray is zero-valued.

Parameters:

paramndarray: numpy.ndarray instance to check.
param_namestr, default: None: numpy.ndarray instance name (if any).

Raises:

ValueError: If the numpy.ndarray instance is zero-valued.

checks.check_pint_unit_compatibility(input: pint.Unit, expected: pint.Unit) → None#

Check if input pint.Unit is compatible with the expected input.

Parameters:

inputUnit: pint.Unit input.
expectedUnit: pint.Unit expected dimensionality.

Raises:

TypeError: If the input is not compatible with the pint.Unit class.

checks.check_type_equivalence(input: object, expected: object) → None#

Check if an input object is of the same class as an expected object.

Parameters:

inputobject: Input object.
expectedobject: Expected object.

Raises:

TypeError: If the objects are not of the same class.

checks.check_type(input: object, expected_type: type | tuple[type, Ellipsis]) → None#

Check if an input object is of the same type as expected types.

Parameters:

inputobject: Input object.
expected_typetype | tuple[type, …]: One or more types to compare the input object against.

Raises:

TypeError: If the object does not match the one or more expected types.

checks.check_type_all_elements_in_iterable(input: collections.abc.Iterable, expected_type: type | tuple[type, Ellipsis]) → None#

Check if all elements in an iterable are of the same type as expected.

Parameters:

inputIterable: Input iterable.
expected_typetype | tuple[type, …]: One or more types to compare the input object against.

Raises:

TypeError: If one of the elements in the iterable does not match the one or more expected types.

checks.min_backend_version(major: int, minor: int, service_pack: int)#

Compare a minimum required version to the current backend version.

Parameters:

majorint: Minimum major version required by the method.
minorint: Minimum minor version required by the method.
service_packint: Minimum service pack version required by the method.

Raises:

GeometryRuntimeError: If the method version is higher than the backend version.
GeometryRuntimeError: If the client is not available.

checks.deprecated_method(alternative: str | None = None, info: str | None = None, version: str | None = None, remove: str | None = None)#

Decorate a method as deprecated.

Parameters:

alternativestr, default: None: Alternative method to use. If provided, the warning message will include the alternative method.
infostr, default: None: Additional information to include in the warning message.
versionstr, default: None: Version where the method was deprecated.
removestr, default: None: Version where the method will be removed.

checks.deprecated_argument(arg: str, alternative: str | None = None, info: str | None = None, version: str | None = None, remove: str | None = None)#

Decorate a method argument as deprecated.

Parameters:

argstr: Argument to mark as deprecated.
alternativestr, default: None: Alternative argument to use. If provided, the warning message will include the alternative argument.
infostr, default: None: Additional information to include in the warning message.
versionstr, default: None: Version where the method was deprecated.
removestr, default: None: Version where the method will be removed.

checks.run_if_graphics_required()#: Check if graphics are available.

checks.graphics_required(method)#

Decorate a method as requiring graphics.

Parameters:

methodcallable(): Method to decorate.

Returns:

callable(): Decorated method.

checks.kwargs_passed_not_accepted(method)#

Check that no unexpected kwargs are passed to the method.

This decorator will raise a TypeError if any keyword arguments are passed to the decorated method that don’t correspond to the method’s parameters. If the method has **kwargs in its signature, this decorator will raise an error for any kwargs passed to it (that are not explicitly accepted).

Parameters:

methodcallable(): The method to decorate.

Returns:

callable(): Decorated method that raises TypeError if unexpected kwargs are passed.

Raises:

TypeError: If unexpected keyword arguments are passed to the decorated method.

Examples

>>> @kwargs_passed_not_accepted
... def my_method(arg1, arg2):
...     return arg1 + arg2
>>> my_method(1, 2)  # Works fine
3
>>> my_method(arg1=1, arg2=2)  # Works fine
3
>>> my_method(1, 2, invalid_arg=3)  # Raises TypeError
TypeError: The following keyword arguments are not accepted
in the method 'my_method': invalid_arg.
>>> @kwargs_passed_not_accepted
... def my_method_with_kwargs(arg1, arg2, **kwargs):
...     return arg1 + arg2
>>> my_method_with_kwargs(1, 2, invalid_arg=3)  # Raises TypeError
TypeError: The following keyword arguments are not accepted
in the method 'my_method_with_kwargs': invalid_arg.

checks.ERROR_GRAPHICS_REQUIRED = 'Graphics are required for this method. Please install the ``graphics`` target to use this...#: Message to display when graphics are required for a method.

The checks.py module#

Summary#

Description#

Module detail#

The `checks.py` module#