By executing the command; $ mk_isEven doc
, you can have this documentation:
USAGE:
-'mk_isEven ((+|-)?\d ){0,2}\d?' --------> Write a program that checks if a number is even (the if...else way for maximum efficiency!)
-'mk_isEven ((+|-)?\d ){0,2}\d? (--verbose|-v)' --------> Same as previous but prints verbose.
-'mk_isEven (doc|-h|--help)' --------> Prints this help and returns EXIT_DOC
Parameters:
-1st parameter (int|str) == ~: If is an positive interger is passed, the number of tests to use; If is an negative number is passed, prints the default amount.
-2nd parameter (int) == -1: If an positive integer (including 0) is passed, the number to test just after creating the python script.
Else it will not include the code to run the function at the end of the script.
Exit codes:
-EXIT_DOC == -1: The program printed this documentation.
-EXIT_SUCCESS == 0: The program executed just fine.
-EXIT_FAILURE == 1: The program exited because of an unknown cause.
-EXIT_415 == 2: The program didn't understood an argument.
You can pass from 0 to 3 argument to the program, each has a different purpose:
number/name | type | default value | description | alternate use |
---|---|---|---|---|
1st |
int or string
|
As an integer, represents the number of if...else s created (v. first-example). If unexpected results when negative. |
As a string, the scripts allows only "doc" , "-h" and "--help" to display the doc, else it will stop with error code EXIT_415
|
|
2nd | int |
-1 |
As a positive interger, represents the number to test first (v. second example). | As a negative number, the function will not be called at the end |
--verbose /-v
|
The program will print in the console its current state |
I implemented four exit codes. The sign of exit code will indicate how the program ended: a positve sign means an error occured and a negative sign (or 0) means that the program ended successfully. Here they are:
- EXIT_SUCCESS (
0
): The program created/modified the python script. - EXIT_DOC (
-1
): The program ended by printing the documentation. - EXIT_FAILURE (
1
): The program encountered an unknown error. - EXIT_415 (
2
): Like the HTTP response code, the program didn't understand an argument.
I personnally use g++ in order to build my C++ scripts.
To download gcc for Windows, click on this direct link.
For linux users, you can download gcc with your package manager (pacman on Arch, apt on Debian, etc).
With gcc installed, just run the command:
$ g++ mk_isEven.cpp -o mk_isEven.exe # The `-o` flag lets you choose your executable name
in whatever folder your source code is. You can know run your mk_isEven.exe
is the executable of the same name.
Verify that you have Python installed since the program runs this command when testing the number:
$ python3 isEven.py <second argument passed>
$ mk_isEven 3
Result (isEven.py):
import sys
def is_even(n : int) -> bool:
"""Checks if the number is even, n must be below 3."""
n = abs(int(n))
if(n == 0):
return True
elif(n == 1):
return False
elif(n == 2):
return True
return False
mk_isEven 90 50
Result (isEven.py):
import sys
def is_even(n : int) -> bool:
"""Checks if the number is even, n must be below 3."""
n = abs(int(n))
if(n == 0):
return True
elif(n == 1):
return False
elif(n == 2):
return True
# ...
elif(n == 89):
return False
return False
#Calls the function with the first cmd line arg
if(len(sys.argv) >= 1):
print(is_even(sys.argv[1]))
Result (terminal):
$ mk_isEven 90 50
True