Skip to content
This repository was archived by the owner on Nov 3, 2022. It is now read-only.

Functions Module

Zander edited this page Mar 15, 2021 · 14 revisions

How to Import

from zcscommonlib import functions

Month - functions.month()


Purpose

Takes an input of an integer and returns a string of the month of that number.

Args

num (int): The number of the month.

Returns

The month's name in string format.

Example

# Imports
from zcscommonlib import functions

# Main program logic
month = functions.month(5)

print(month)

# Output: May

Typed Input - functions.typed_input()


Purpose

Gets the input from a user, persisting until the input of the right type is received with an optional input message and error message.

Args

typein (str): The type of input to require of the user (int, float, str, bool).
inputmsg (str): The message to display to the user when getting input.
errormsg (str): The error to log to console when an input of the wrong type is given.

Returns

The input provided from the user in the desired format.

Random Value - functions.random_value()


Purpose

Takes an array and returns a random value from it.

Args

array (list): An array to retrieve the value from.

Returns

A random value from the array

Example

# Imports
from zcscommonlib import functions

# Main program logic
myArray = ['value1', 'value2', 'value3']
randomArrayValue = functions.random_value(myArray)

print(randomArrayValue)

# Output: value2

Clone this wiki locally