Merge pull request #82 from aaryanrr/master

Type Hint Fixes and Updated Guidelines

Author: aaryanrr

CONTRIBUTING.md

@@ -4,7 +4,7 @@ Thank you so much for your interest in contributing!. All types of contributions
 
 Please make sure to read the documentation before making your contribution! It will make it a lot easier for us maintainers to make the most of it and smooth out the experience for all involved. 💚
 
-### If you have a question about this project, how to use it, or just need clarification about something:
+### If you have a question about this project, how to use it, or just need clarification about something
 
 * Open an Issue [here](https://github.com/Ankit404butfound/PyWhatKit/issues)
 * Provide as much context as you can about what you're running into.
@@ -20,9 +20,20 @@ If the project doesn't do something you need or want it to do:
 
 ### Code Formatting
 
-Please make sure that your code follows the PEP8 standards and that you provide proper type hinting for the functions and parameters.
+Please make sure that your code follows the PEP8 standards and that you provide proper type hinting for the functions and parameters with proper spacing.
+For PyCharm users, you can use the shortcut `Ctrl + Alt + L` to reformat your code.
+For VSCode users, create a `.vscode` folder in the project directory and a `settings.json` file inside it.
+Inside the file add the following lines:
+
+```json
+{
+    "python.formatting.provider": "autopep8",
+    "editor.formatOnSave": true
+}
+```
+
+For others, you can directly use `autopep8 -i filename` in the terminal to format your code.
 Before committing your changes run `pre-commit` in your terminal, this would fix most of the common errors.
-You can use tools like `mypy` to look for more errors. We will be adding some configurations for that soon.
 
 ### Contributing Code
 

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 Ankit Raj Mahapatra
+Copyright (c) 2019 - present Ankit Raj Mahapatra
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

pywhatkit/ascii_art.py

@@ -1,7 +1,7 @@
 from PIL import Image
 
 
-def image_to_ascii_art(imgpath: str, output_file: str = "pywhatkit_asciiart.txt") -> str:
+def image_to_ascii_art(imgpath: str, output_file: str = "pywhatkit_asciiart") -> str:
     """Converts the given image to ascii art and save it to output_file"""
     # pass the image as command line argument
     image_path = imgpath
@@ -33,6 +33,6 @@ def image_to_ascii_art(imgpath: str, output_file: str = "pywhatkit_asciiart.txt"
     ascii_image = "\n".join(ascii_image)
 
     # write to a text file.
-    with open(output_file, "w") as f:
+    with open(f"{output_file}.txt", "w") as f:
         f.write(ascii_image)
     return ascii_image

pywhatkit/chr_to_handwriting.py

@@ -1,8 +1,7 @@
 import requests
-from typing import NoReturn
 
 
-def text_to_handwriting(string: str, save_to: str = "pywhatkit.png", rgb: tuple = (0, 0, 138)) -> NoReturn:
+def text_to_handwriting(string: str, save_to: str = "pywhatkit.png", rgb: tuple = (0, 0, 138)) -> None:
     """Convert the given str to handwriting"""
     data = requests.get(
         "https://pywhatkit.herokuapp.com/handwriting?text=%s&rgb=%s,%s,%s" % (string, rgb[0], rgb[1], rgb[2])).content

pywhatkit/exceptions.py

@@ -10,9 +10,5 @@ class InternetException(Exception):
     pass
 
 
-class InvalidBrowserName(Exception):
-    pass
-
-
 class UnsupportedEmailProvider(Exception):
     pass

pywhatkit/help.py

@@ -1,39 +1,38 @@
 import webbrowser as web
-from typing import NoReturn
 
 baseurl = "https://github.com/Ankit404butfound/PyWhatKit/wiki/"
 
 
-def sendwhatmsg() -> NoReturn:
+def sendwhatmsg() -> None:
     """Open the Help Page for Sending WhatsApp Messages"""
     web.open(f"{baseurl}Sending-WhatsApp-Messages")
 
 
-def misc_functions() -> NoReturn:
+def misc_functions() -> None:
     """Playonyt, search, info, take_screenshot, show_history, open_web help page"""
     web.open(f"{baseurl}Miscellaneous-Functions")
 
 
-def image_to_ascii_art() -> NoReturn:
+def image_to_ascii_art() -> None:
     """Open the Help Page for image_to_ascii_art function"""
     web.open(f"{baseurl}ASCII-Art")
 
 
-def text_to_handwriting() -> NoReturn:
+def text_to_handwriting() -> None:
     """Open the Help Page for text_to_handwriting function"""
     web.open(f"{baseurl}Text-to-Handwriting")
 
 
-def exceptions() -> NoReturn:
+def exceptions() -> None:
     """Open the help page for the Exceptions within this library"""
     web.open(f"{baseurl}Exception")
 
 
-def mail() -> NoReturn:
+def mail() -> None:
     """Open the help page for send_mail and send_hmail function"""
     web.open(f"{baseurl}Sending-a-Mail")
 
 
-def shutdown() -> NoReturn:
+def shutdown() -> None:
     """Open the help page for shutdown and cancel_shutdown function"""
     web.open(f"{baseurl}Shutdown-and-CancelShutdown")

pywhatkit/history.py

@@ -1,7 +1,4 @@
-from typing import NoReturn
-
-
-def show_history() -> NoReturn:
+def show_history() -> None:
     """Prints the information of all the sent messages using this program"""
     with open("pywhatkit_dbs.txt", "r") as f:
         content = f.read()

pywhatkit/mail.py

@@ -3,11 +3,11 @@
 from email.mime.text import MIMEText
 import re
 from .exceptions import UnsupportedEmailProvider
-from typing import Union, NoReturn
+from typing import Union
 
 
 def send_mail(email_sender: str, password: str, subject: str,
-              message: Union[str, MIMEText], email_receiver: str) -> NoReturn:
+              message: Union[str, MIMEText], email_receiver: str) -> None:
     """Send an Email"""
 
     domain = re.search("(?<=@)[^.]+(?=\\.)", email_sender)
@@ -39,7 +39,7 @@ def send_mail(email_sender: str, password: str, subject: str,
 
 
 def send_hmail(email_sender: str, password: str, subject: str,
-               html_code: str, email_receiver: str) -> NoReturn:
+               html_code: str, email_receiver: str) -> None:
     """Send an Email with HTML code"""
 
     message = MIMEText(html_code, "html")

pywhatkit/main.py

@@ -6,13 +6,13 @@
 import os
 from urllib.parse import quote
 from .exceptions import *
-from typing import NoReturn, Optional
+from typing import Union, Optional
 from platform import system
 
 if system().lower() in ("windows", "darwin"):
     from PIL import ImageGrab
 
-    def take_screenshot(file_name: str = 'pywhatkit_screenshot') -> NoReturn:
+    def take_screenshot(file_name: str = 'pywhatkit_screenshot') -> None:
         """Take Screenshot, you can change the filename as per your Wish"""
         screen = ImageGrab.grab()
         screen.show()
@@ -27,25 +27,21 @@ def take_screenshot(file_name: str = 'pywhatkit_screenshot') -> NoReturn:
 current_path = os.getcwd()
 
 
-def print_sleep_time() -> str:
+def print_sleep_time() -> Union[str, int]:
     return sleep_time
 
 
-def check_window() -> NoReturn:
+def check_window() -> None:
     """Check if the browser Window is maximized or not"""
     web.open("https://www.google.com")
     pg.alert("If the browser's window is not maximized,\nMaximise and then close it if you want,\nor sendwhatmsg() "
              "function will not work", "Pywhatkit")
 
 
 def sendwhatmsg_instantly(phone_no: str, message: str, wait_time: int = 20,
-                          browser: str = None, tab_close: bool = False) -> NoReturn:
+                          tab_close: bool = False) -> None:
     """Send WhatsApp Message Instantly"""
 
-    if browser and browser.lower() not in ["chrome", "firefox", "brave", "opera"]:
-        raise InvalidBrowserName(
-            "Browser name can be firefox, chrome, brave, opera")
-
     if "+" not in phone_no:
         raise CountryCodeException("Country code missing from phone_no")
 
@@ -54,10 +50,6 @@ def sendwhatmsg_instantly(phone_no: str, message: str, wait_time: int = 20,
              phone_no + '&text=' + parsed_message)
     time.sleep(2)
     width, height = pg.size()
-    if browser:
-        whats = pg.getWindowsWithTitle(browser)[0]
-        whats.maximize()
-        whats.activate()
     pg.click(width / 2, height / 2)
     time.sleep(wait_time - 2)
     pg.press('enter')
@@ -66,18 +58,11 @@ def sendwhatmsg_instantly(phone_no: str, message: str, wait_time: int = 20,
 
 
 def sendwhatmsg(phone_no: str, message: str, time_hour: int, time_min: int, wait_time: int = 20,
-                print_wait_time: bool = True, browser: str = None, tab_close: bool = False) -> NoReturn:
+                print_wait_time: bool = True, tab_close: bool = False) -> None:
     """Sends a WhatsApp Message"""
     # Phone number should be given as a string
     # If the browser Window is not maximized this function won't work
     # Use check_window to check this
-
-    if browser is None:
-        pass
-    elif browser.lower() not in ["chrome", "firefox", "brave", "opera"]:
-        raise InvalidBrowserName(
-            "Browser name can be firefox, chrome, brave, opera")
-
     global sleep_time
     if "+" not in phone_no:
         raise CountryCodeException("Country code missing from phone_no")
@@ -125,10 +110,6 @@ def sendwhatmsg(phone_no: str, message: str, time_hour: int, time_min: int, wait
              phone_no + '&text=' + parsed_message)
     time.sleep(2)
     width, height = pg.size()
-    if browser:
-        whats = pg.getWindowsWithTitle(browser)[0]
-        whats.maximize()
-        whats.activate()
     pg.click(width / 2, height / 2)
     time.sleep(wait_time - 2)
     pg.press('enter')
@@ -137,7 +118,7 @@ def sendwhatmsg(phone_no: str, message: str, time_hour: int, time_min: int, wait
 
 
 def sendwhatmsg_to_group(group_id: str, message: str, time_hour: int, time_min: int, wait_time: int = 20,
-                         print_wait_time: bool = True, tab_close: bool = False) -> NoReturn:
+                         print_wait_time: bool = True, tab_close: bool = False) -> None:
     """Send WhatsApp Message to a Group"""
     # Group ID is in the group's invite link
     # https://chat.whatsapp.com/AB123CDEFGHijklmn, here AB123CDEFGHijklmn is group ID
@@ -183,9 +164,6 @@ def sendwhatmsg_to_group(group_id: str, message: str, time_hour: int, time_min:
     web.open('https://web.whatsapp.com/accept?code=' + group_id)
     time.sleep(2)
     width, height = pg.size()
-    whats = pg.getWindowsWithTitle("WhatsApp")[0]
-    whats.maximize()
-    whats.activate()
     time.sleep(wait_time - 2)
     pg.click(width / 2, height - height / 10)
     pg.typewrite(message + "\n")
@@ -201,14 +179,14 @@ def info(topic: str, lines: int = 3, return_value: bool = False) -> Optional[str
         return spe
 
 
-def close_tab(wait_time: int = 2) -> NoReturn:
+def close_tab(wait_time: int = 2) -> None:
     """Closes the Currently Opened Browser Tab"""
     time.sleep(wait_time)
     pg.hotkey("ctrl", "w")
     pg.press("enter")
 
 
-def playonyt(topic: str, use_api: bool = False) -> str:
+def playonyt(topic: str, use_api: bool = False) -> Union[str, None]:
     """Play a YouTube Video"""
     # use_api uses the pywhatkit playonyt API to get the url for the video
     # use the api only if the function is not working properly on its own
@@ -246,7 +224,7 @@ def open_web() -> bool:
         return True
 
 
-def search(topic: str) -> NoReturn:
+def search(topic: str) -> None:
     """Searches about the topic on Google"""
     link = 'https://www.google.com/search?q={}'.format(topic)
     web.open(link)

pywhatkit/sc.py

@@ -1,28 +1,25 @@
 import platform
 import os
-from typing import NoReturn
 try:
     import winerror
 except ImportError or ModuleNotFoundError:
     pass
-osname = platform.system()
 
-def shutdown(time: int = 20) -> NoReturn:
+
+def shutdown(time: int = 20) -> None:
     """
     Gives a shutdown request to the system with the specified time
-
-    Args:
-    `time`: Governs the time for shutdown. Taken as `int` in unit `seconds`. `Specified default value is 20`
     """
     # For Windows, time should be given in seconds
     # For MacOS and Linux based distributions, time should be given in minutes
-    global osname
     osname = platform.system()
     if "window" in osname.lower():
         cont = f"shutdown -s -t {time}"
         ErrorCode = os.system(cont)
-        if ErrorCode == winerror.ERROR_SHUTDOWN_IN_PROGRESS or ErrorCode == 1115:# Here 1115 is the error code of scheduled shutdown.
-            print("A shutdown process has already been scheduled...\nIgnoring this process")
+        # Here 1115 is the error code of scheduled shutdown.
+        if ErrorCode == winerror.ERROR_SHUTDOWN_IN_PROGRESS or ErrorCode == 1115:
+            print(
+                "A shutdown process has already been scheduled...\nIgnoring this process")
         else:
             print(f"Your System will shutdown in {time} seconds")
 
@@ -39,17 +36,17 @@ def shutdown(time: int = 20) -> NoReturn:
             "This function is for Windows, Mac and Linux users only, can't execute on {}".format(osname))
 
 
-def cancel_shutdown() -> NoReturn:
+def cancel_shutdown() -> None:
     """
     Will cancel the scheduled shutdown
     """
-    global osname
     osname = platform.system()
     if "window" in osname.lower():
         cont = "shutdown /a"
         ErrorCode = os.system(cont)
         if ErrorCode == winerror.ERROR_NO_SHUTDOWN_IN_PROGRESS:
-            print("ShutDown cancellation process has been aborted! [NO shutdown scheduled]")
+            print(
+                "ShutDown cancellation process has been aborted! [NO shutdown scheduled]")
         else:
             print("ShutDown has been cancelled")