Environment descriptor files

environment_descriptor_files

This module contains code for working with the JSON environment descriptor files.

It can parse the files, validate them, and return objects representing their contents.

PathEnv

Path env object that is created from the descriptor file.

Attributes:

Name	Type	Description
scope	string	scope the path env is associated with
flags	List[str]	flags associated with the path env
var_name	string	ENV var to set with the object
descriptor_location	string	location of the PathEnv
published_path	string	location of the PathEnv

__init__

__init__(descriptor: dict) -> None

Init with the descriptor information.

DescriptorFile

The base class for the different types of descriptor files.

Attributes:

Name	Type	Description
file_path	str	descriptor file path
descriptor_contents	Dict	Contents of the descriptor file

__init__

__init__(file_path: str) -> None

Loads the contents of the descriptor file and validates.

Parameters:

Name	Type	Description	Default
file_path	str	path to descriptor file	required

Raises:

Type	Description
ValueError	Missing specified value from descriptor file

sanitize_string

sanitize_string(s: str) -> str

Clean up a string "value" in the descriptor file.

PathEnvDescriptor

Descriptor File for a PATH ENV.

__init__

__init__(file_path: str) -> None

Inits the descriptor as a PathEnvDescriptor from the provided path.

Loads the contents of the filepath into descriptor_contents

Parameters:

Name	Type	Description	Default
file_path	str	path to the yaml descriptor file	required

ExternDepDescriptor

Descriptor File for a External Dependency.

Attributes:

Name	Type	Description
descriptor_contents	Dict	Contents of the Descriptor yaml file
file_path	PathLike	path to the descriptor file

__init__

__init__(file_path: str) -> None

Inits the descriptor as a ExternDepDescriptor from the provided path.

Loads the contents of the filepath into descriptor_contents

Parameters:

Name	Type	Description	Default
file_path	str	path to the yaml descriptor file	required

PluginDescriptor

Descriptor File for a Plugin.

Attributes:

Name	Type	Description
descriptor_contents	Dict	Contents of the Descriptor yaml file
file_path	PathLike	path to the descriptor file

__init__

__init__(file_path: str) -> None

Inits the descriptor as a PluginDescriptor from the provided path.

Loads the contents of the filepath into descriptor_contents

Parameters:

Name	Type	Description	Default
file_path	str	path to the yaml descriptor file	required