runway.cfngin.lookups.handlers.file module

File lookup.

class runway.cfngin.lookups.handlers.file.ArgsDataModel[source]

Bases: runway.utils.BaseModel

Arguments data model.

codec: str: Codec that will be used to parse and/or manipulate the data.

__contains__(name: object) → bool

Implement evaluation of ‘in’ conditional.

Parameters: name – The name to check for existence in the model.

__getitem__(name: str) → Any

Implement evaluation of self[name].

Parameters: name – Attribute name to return the value for.
Returns: The value associated with the provided name/attribute name.
Raises: AttributeError – If attribute does not exist on this object.

__init__(**data: Any) → None

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

__iter__() → TupleGenerator: so dict(model) works

__new__(**kwargs)

__pretty__(fmt: Callable[[Any], Any], **kwargs: Any) → Generator[Any, None, None]: Used by devtools (https://python-devtools.helpmanual.io/) to provide a human readable representations of objects

__repr_name__() → str: Name of the instance’s class, used in __repr__.

__rich_repr__() → RichReprResult: Get fields for Rich library

__setitem__(name: str, value: Any) → None

Implement item assignment (e.g. self[name] = value).

Parameters

name – Attribute name to set.
value – Value to assign to the attribute.

classmethod __try_update_forward_refs__(**localns: Any) → None: Same as update_forward_refs but will not raise exception when forward references are not defined.

classmethod construct(_fields_set: Optional[SetStr] = None, **values: Any) → Model: Creates a new model setting __dict__ and __fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed. Behaves as if Config.extra = ‘allow’ was set since it adds all passed values

copy(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, update: Optional[DictStrAny] = None, deep: bool = False) → Model

Duplicate a model, optionally choose which fields to include, exclude and change.

Parameters

include – fields to include in new model
exclude – fields to exclude from new model, as with values this takes precedence over include
update – values to change/add in the new model. Note: the data is not validated before creating the new model: you should trust this data
deep – set to True to make a deep copy of the model

Returns

new model instance

dict(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False, skip_defaults: Optional[bool] = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False) → DictStrAny: Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

get(name: str, default: Any = None) → Any

Safely get the value of an attribute.

Parameters

name – Attribute name to return the value for.
default – Value to return if attribute is not found.

json(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False, skip_defaults: Optional[bool] = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False, encoder: Optional[Callable[[Any], Any]] = None, models_as_dict: bool = True, **dumps_kwargs: Any) → str

Generate a JSON representation of the model, include and exclude arguments as per dict().

encoder is an optional function to supply as default to json.dumps(), other arguments as per json.dumps().

classmethod update_forward_refs(**localns: Any) → None: Try to update ForwardRefs on fields based on this Model, globalns and localns.

class runway.cfngin.lookups.handlers.file.FileLookup[source]

Bases: runway.lookups.handlers.base.LookupHandler

File lookup.

TYPE_NAME: Final[Literal['file']] = 'file': Name that the Lookup is registered as.

classmethod parse(value: str) → Tuple[str, Dict[str, str]][source]

Parse the value passed to the lookup.

This overrides the default parsing to account for special requirements.

Parameters: value – The raw value passed to a lookup.
Returns: The lookup query and a dict of arguments
Raises: ValueError – The value provided does not match the expected regex.

classmethod handle(value: str, **_: Any) → Any[source]: Translate a filename into the file contents.

__init__()

__new__(**kwargs)

classmethod dependencies(_LookupHandler__lookup_query: VariableValue) → Set[str]

Calculate any dependencies required to perform this lookup.

Note that lookup_query may not be (completely) resolved at this time.

classmethod format_results(value: Any, get: Optional[str] = None, load: Optional[str] = None, transform: Optional[Literal['bool', 'str']] = None, **kwargs: Any) → Any

Format results to be returned by a lookup.

Parameters

value – Data collected by the Lookup.
get – Nested value to get from a dictionary like object.
load – Parser to use to parse a formatted string before the get and transform method.
transform – Convert the final value to a different data type before returning it.

Raises

TypeError – If get is provided but the value value is not a dictionary like object.

Runs the following actions in order:

load() if load is provided.
runway.util.MutableMap.find() or dict.get() depending on the data type if get is provided.
Convert null value string to NoneType object. This includes string values of “None” and “null”. This conversion is case insensitive.
transform() if transform is provided.

classmethod load(value: Any, parser: Optional[str] = None, **kwargs: Any) → Any

Load a formatted string or object into a python data type.

First action taken in format_results(). If a lookup needs to handling loading data to process it before it enters format_results(), is should use args.pop('load') to prevent the data from being loaded twice.

Parameters

value – What is being loaded.
parser – Name of the parser to use.

Returns

The loaded value.

classmethod transform(value: Any, *, to_type: Optional[Literal['bool', 'str']] = 'str', **kwargs: Any) → Any

Transform the result of a lookup into another datatype.

Last action taken in format_results(). If a lookup needs to handling transforming the data in a way that the base class can’t support it should overwrite this method of the base class to register different transform methods.

Parameters

value – What is to be transformed.
to_type – The type the value will be transformed into.

Returns

The transformed value.

runway.cfngin.lookups.handlers.file.parameterized_codec(raw: str, b64: Literal[False] = False) → troposphere.GenericHelperFn[source]

runway.cfngin.lookups.handlers.file.parameterized_codec(raw: str, b64: Literal[True] = False) → troposphere.Base64

Parameterize a string, possibly encoding it as Base64 afterwards.

Parameters

raw – String to be processed. Byte strings will be interpreted as UTF-8.
b64 – Whether to wrap the output in a Base64 CloudFormation call.

Returns

Output to be included in a CloudFormation template.

Return type

troposphere.AWSHelperFn

runway.cfngin.lookups.handlers.file.yaml_codec(raw: str, parameterized: bool = False) → Any[source]: YAML codec.

runway.cfngin.lookups.handlers.file.json_codec(raw: str, parameterized: bool = False) → Any[source]: JSON codec.