Initializing help system before first use

xpressinsight.Column.check_value

Purpose
Verifies that the given value can be used as the value of an entity of this type.
Synopsis
xpressinsight.Column.check_value(self, value: Any, columns: Optional[Iterable] = None, *, allow_duplicate_indices: Optional[bool] = None)
Arguments
value 
The potential value for this entity.
columns 
If this is a DataFrame-type entity, an iterable specifying a subset of the columns to check; checks all columns if unset. Ignored for entity types that don't have columns.
allow_duplicate_indices 
Whether to allow duplicate indices in the entity. If False, a KeyError is raised when a duplicate index tuple is found in a Series, DataFrame or PolarsDataFrame entity, or a duplicate value in an Index or PolarsIndex entity. If None, a warning will be output if a duplicate is detected. If True, this function will not check for duplicates.
Return value

This function may raise the following errors:

  TypeError

If the value has the wrong type for this entity.

  KeyError

If there is an issue with the indexing of the value.

  ValueError

If the value is in some other way not acceptable for this entity.

Further information
The method check_value is part of the class xpressinsight.Column.

Parent Topic Entity Definition Container Classes

© 2001-2025 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.