BPt.Dataset.get_cols#

Dataset.get_cols(scope, limit_to=None)[source]#

This method is the main internal and external facing way of getting the names of columns which match a passed scope from the Dataset. For example this method may be useful for user’s when they want to ensure that a scope returns exactly the subset of columns they expect.

Parameters
scopeScope

The BPt style Scope input that will be used to determine which column names from the Dataset to return.

limit_toScope or None, optional

Can optionally limit the columns to search over with another scope. If None, then will use ‘all’.

default = None
Returns
colslist

This method returns the columns specified by the input scope argument as a sorted python list