ZoneCorrespondencePath#

class caf.toolkit.translation.ZoneCorrespondencePath(path, from_col_name=<factory>, to_col_name=<factory>, factors_col_name=None)[source]#

Defines the path and columns to use for a translation.

Attributes

`factors_col_name`	Get _factors_col_name.
`from_col_name`	Get _from_col_name.
`generic_factor_col`	Replace the factors_col_name when reading with generic column names.
`generic_from_col`	Column name to replace the from_col_name if reading with generic column names.
`generic_to_col`	Column name to replace the to_col_name when reading with generic column names.
`to_col_name`	Get _to_col_name.
`path`	Path to the translation file.

Methods

`__init__`(args, *kwargs)
`read`(*[, factors_mandatory, ...])	Read the translation file.

Attributes Documentation

Parameters:

path (Annotated[Path, PathType(path_type=file)])
from_col_name (str | int)
to_col_name (str | int)
factors_col_name (str | int | None)

factors_col_name#: Get _factors_col_name.

from_col_name#: Get _from_col_name.

generic_factor_col#: Replace the factors_col_name when reading with generic column names.

generic_from_col#: Column name to replace the from_col_name if reading with generic column names.

generic_to_col#: Column name to replace the to_col_name when reading with generic column names.

to_col_name#: Get _to_col_name.

path: Annotated[Path, PathType(path_type=file)][source]#: Path to the translation file.