morpheus.cli.utils.MorpheusRelativePath

class MorpheusRelativePath(*args, **kwargs)

Bases: Path

A specialization of the click.Path class that falls back to using package relative paths if the file cannot be found. Takes the exact same parameters as click.Path

Methods

__call__(value[, param, ctx])	Call self as a function.
convert(value, param, ctx)	Wrapper around get_package_relative_file for click.Path.
fail(message[, param, ctx])	Helper method to fail with an invalid value message.
get_metavar(param)	Returns the metavar default for this param if it provides one.
get_missing_message(param)	Optionally might return extra information about a missing parameter.
shell_complete(ctx, param, incomplete)	Return a special completion marker that tells the completion system to use the shell to provide path completions for only directories or any paths.
split_envvar_value(rv)	Given a value from an environment variable this splits it up into small chunks depending on the defined envvar list splitter.
to_info_dict()	Gather information that could be useful for a tool generating user-facing documentation.

coerce_path_result

convert(value, param, ctx)

Wrapper around get_package_relative_file for click.Path.

envvar_list_splitter: t.ClassVar[str] = ':'

if a list of this type is expected and the value is pulled from a string environment variable, this is what splits it up. None means any whitespace. For all parameters the general rule is that whitespace splits them up. The exception are paths and files which are split by os.path.pathsep by default (“:” on Unix and “;” on Windows).

fail(message, param=None, ctx=None)

Helper method to fail with an invalid value message.

get_metavar(param)

Returns the metavar default for this param if it provides one.

get_missing_message(param)

Optionally might return extra information about a missing parameter.

Added in version 2.0.

name: str

the descriptive name of this type

shell_complete(ctx, param, incomplete)

Return a special completion marker that tells the completion system to use the shell to provide path completions for only directories or any paths.

Parameters:

• ctx (Context) – Invocation context for this command.

• param (Parameter) – The parameter that is requesting completion.

• incomplete (str) – Value being completed. May be empty.

Added in version 8.0.

split_envvar_value(rv)

Given a value from an environment variable this splits it up into small chunks depending on the defined envvar list splitter.

If the splitter is set to None, which means that whitespace splits, then leading and trailing whitespace is ignored. Otherwise, leading and trailing splitters usually lead to empty items being included.

to_info_dict()

Gather information that could be useful for a tool generating user-facing documentation.

Use click.Context.to_info_dict() to traverse the entire CLI structure.

Added in version 8.0.