initial commit

Author: EdwardRees

.gitignore

@@ -0,0 +1 @@
+__pycache__

Driver.py

@@ -0,0 +1,29 @@
+from math_example import get_sum_factorial_of_digits
+from recursive_digits_example import single_digit_of_all_numbers
+from input_validation import validate
+
+def iterative_function_calling():
+    """
+    Example that calls other functions 
+    """
+    get_sum_factorial_of_digits(123456)
+
+
+def recursive_function_calling():
+    """
+    Recursive example of the logger being used when the function calls itself
+    """
+    single_digit_of_all_numbers(123456)
+
+
+def exception_function_calling():
+    """
+    Example with an exception handled
+    """
+    validate("Please input a number between 0 and 5: ", 0, 5)
+
+def main():
+    # iterative_function_calling()
+    # recursive_function_calling()
+    exception_function_calling()
+main()

Logger.py

@@ -0,0 +1,18 @@
+from typing import Callable
+def log(func: Callable) -> Callable:
+  def wrapper(*args, **kwargs) -> Callable:
+    print(f"Calling: {func.__name__}")
+    print(f"Documentation: {func.__doc__}")
+    return func(*args, **kwargs)
+  return wrapper
+
+
+def output(func: Callable) -> Callable:
+  def wrapper(*args, **kwargs) -> Callable:
+    print(f"Calling: {func.__name__}")
+    print(f"Documentation: {func.__doc__}")
+    call = func(*args, **kwargs)
+    if(type(call) != type(None)):
+      print(f"The output of {func.__name__} is {call}")
+      
+  return wrapper

README.md

@@ -0,0 +1,3 @@
+# Logger
+
+This repository has a logger included. This also provides an example of how to Logger works. This logger may or may not be useful for all the projects.

input_validation.py

@@ -0,0 +1,29 @@
+from Logger import output
+
+
+@output
+def validate(prompt: str, min: int = 0, max: int = float('inf')) -> int:
+    """
+    Validate the user input and ensure the user input a number between the minimum and maximum values. Will keep trying if the user inputs an invalid character or a number out of the range.
+    :param prompt – the prompt to ask the user in the user input
+    :param min – the minimum value – defaults to 0
+    :param max – the maximum value – defaults to infinity
+    :return int of choice
+    """
+    try:
+        val = int(input(prompt))
+        if(val > max or val < min):
+            raise TypeError
+        return val
+    except TypeError:
+        """
+        out of range failure caught
+        """
+        print(f"Value not between {min} and {max}")
+        return validate(prompt, min, max)
+    except ValueError:
+        """
+        Invalid type caught
+        """
+        print("Value inputted was not a number! Try again!")
+        return validate(prompt, min, max)

math_example.py

@@ -0,0 +1,41 @@
+from Logger import log, output
+
+@log
+def factorial(n: int) -> int:
+  """
+  Solve the factorial of some number
+  :param n – the number to get the factorial of
+  :return the factorial of n
+  """
+  f = 1
+  for i in range(1, n + 1):
+    f *= i
+  return f
+
+@log
+def getDigits(n: int) -> list:
+  """
+  Return a list of the digits of a number
+  :param n – the number to find the digits of
+  :return a list of the digits
+  """
+  digits = []
+  while(n > 0):
+    digits.append(n % 10)
+    n //= 10
+  digits = digits[::-1]
+  return digits
+
+
+@output
+def get_sum_factorial_of_digits(n: int) -> int:
+  """
+  Get the sum of the factorial of each digit in a given number
+  :param n – the number to find the value of
+  :return the sum of the factorial of all the digits
+  """
+  return sum(map(factorial, getDigits(n)))
+
+
+
+

recursive_digits_example.py

@@ -0,0 +1,17 @@
+from Logger import log, output
+
+@output
+def single_digit_of_all_numbers(n: int, s: int = 0) -> int:
+  """
+  Calculate the single digit sum of all the digits
+  :param n – current number
+  :param s – sum
+  :return Integer of total sum of all digits down to single digit
+  """
+  if(n == 0):
+    if(s > 10):
+      return single_digit_of_all_numbers(s, 0)
+    return s
+  else:
+    return single_digit_of_all_numbers(n // 10, s + n % 10)
+