moic.cli.validators package

Submodules

moic.cli.validators.base module

Module for base Moic validator functions

moic.cli.validators.base.validate_comment_id(ctx: click.core.Context, param: list, value: str) → str

Validate a given comment id to check if it exists

Parameters:

• ctx (click.core.Context) – click.core.Context of the given command
• args (list) – List of commands args
• value (str) – String input to validate

Returns:

Retrive the id if it’s validated

Return type:

str

moic.cli.validators.base.validate_issue_key(ctx: click.core.Context, param: list, value: str) → str

Validate a given issue key to check if it exists

Parameters:

• ctx (click.core.Context) – click.core.Context of the given command
• args (list) – List of commands args
• value (str) – String input to validate

Returns:

Retrive the key if it’s validated

Return type:

str

moic.cli.validators.base.validate_issue_type(ctx: click.core.Context, param: list, value: str) → str

Validate a given issue type name to check if it exists

Parameters:

• ctx (click.core.Context) – click.core.Context of the given command
• args (list) – List of commands args
• value (str) – String input to validate

Returns:

Retrive the name if it’s validated

Return type:

str

moic.cli.validators.base.validate_priority(ctx, param, value)

Validate a given priority name to check if it exists

Parameters:

• ctx (click.core.Context) – click.core.Context of the given command
• args (list) – List of commands args
• value (str) – String input to validate

Returns:

Retrive the priority name if it’s validated

Return type:

str

moic.cli.validators.base.validate_project_key(ctx: click.core.Context, param: list, value: str) → str

Validate a given project key to check if it exists

Parameters:

• ctx (click.core.Context) – click.core.Context of the given command
• args (list) – List of commands args
• value (str) – String input to validate

Returns:

Retrive the key if it’s validated

Return type:

str

moic.cli.validators.base.validate_user(ctx, param, value)

Validate a given user name to check if it exists

Parameters:

• ctx (click.core.Context) – click.core.Context of the given command
• args (list) – List of commands args
• value (str) – String input to validate

Returns:

Retrive the user name if it’s validated

Return type:

str

Module contents

Module for Moic cli arguments and options validators