Merge pull request #42 from Moduland/minor_edits

Minor edits

Author: sepandhaghighi

CHANGELOG.md

@@ -14,6 +14,12 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - `dev-requirements.txt` modified
 - Test system modified
 - `DEBUG` parameter renamed to `debug`
+- All parameters moved to `orangetool_params.py`
+- Some functions moved to `orangetool_utils.py`
+- `ADDRESS` parameter renamed to `address`
+- `Zone` parameter renamed to `zone`
+- `uptime` and `idletime` functions updated
+- Docstrings updated
 ## [0.35] - 2019-06-01
 ### Added
 - `version_check.py`

orangetool/__init__.py

@@ -1,10 +1,11 @@
 # -*- coding: utf-8 -*-
 """Orangetool modules."""
 
-from .orangetool_display import *
-from .orangetool_ip import *
-from .orangetool_system import *
-from .orangetool_ram import *
-from .orangetool_storage import *
+from .orangetool_display import hdmi_on, hdmi_off, hdmi_size
+from .orangetool_ip import internet, local_ip, global_ip, set_ip, ping, mac
+from .orangetool_system import check_update, get_temp, uptime, idletime, wakeup, version, sleep, hibernate, halt, restart
+from .orangetool_ram import ram_total, ram_used, ram_free, ram_percent, freeup
+from .orangetool_storage import mount_status, storage_status, unmount, unmount_all, mount, usb_on, usb_off
+from .orangetool_params import ORANGETOOL_VERSION
 
 __version__ = ORANGETOOL_VERSION

orangetool/orangetool_display.py

@@ -1,12 +1,13 @@
 # -*- coding: utf-8 -*-
 """Orangetool display functions."""
+from .orangetool_params import GENERAL_ERROR_MESSAGE
 
 
 def hdmi_controller(command, debug=False):
     """
     Control hdmi port.
 
-    :param command: inpurt command
+    :param command: input command
     :type command: bool
     :param debug: flag for using debug mode
     :type debug: bool
@@ -23,7 +24,7 @@ def hdmi_controller(command, debug=False):
     except Exception as e:
         if debug:
             print(str(e))
-        return "Error"
+        return GENERAL_ERROR_MESSAGE
 
 
 def hdmi_on(debug=False):
@@ -53,10 +54,10 @@ def hdmi_size(v=None, h=None, debug=False):
     Change hdmi display resolution (need sudo -s) (if call without any argument return current resolution).
 
     :param v: vertical line
-    :param h: horizental line
-    :param debug: flag for using debug mode
     :type v : int
-    :type h:int
+    :param h: horizontal line
+    :type h: int
+    :param debug: flag for using debug mode
     :type debug:bool
     :return: bool
     """
@@ -73,4 +74,4 @@ def hdmi_size(v=None, h=None, debug=False):
     except Exception as e:
         if debug:
             print(str(e))
-        return "Error"
+        return GENERAL_ERROR_MESSAGE

orangetool/orangetool_ip.py

@@ -1,25 +1,24 @@
 # -*- coding: utf-8 -*-
 """Orangetool IP functions."""
 from .orangetool_system import restart as restart_func
+from .orangetool_params import IP_PATTERN, GLOBAL_IP_API_1, GENERAL_ERROR_MESSAGE
 import subprocess as sub
 import socket
 import os
 import requests
 import re
 import platform
-IP_PATTERN = r"(?:[0-9]{1,3}\.){3}[0-9]{1,3}"
-GLOBAL_IP_API_1 = "http://ipinfo.io/ip"
 
 
 def internet(host="8.8.8.8", port=53, timeout=3):
     """
     Check internet connections.
 
     :param  host: the host that check connection to
-    :param  port: port that check connection with
-    :param  timeout: times that check the connection
     :type host:str
+    :param  port: port that check connection with
     :type port:int
+    :param  timeout: times that check the connection
     :type timeout:int
     :return bool: True if Connection is Stable
     >>> internet() # if there is stable internet connection
@@ -58,13 +57,13 @@ def local_ip(debug=False):
             response = list(command.communicate())
             if len(response[0]) > 0:
                 return str(response[0])[2:-4]
-            return "Error"
-        return "Error"
+            return GENERAL_ERROR_MESSAGE
+        return GENERAL_ERROR_MESSAGE
 
     except Exception as e:
         if debug:
             print(str(e))
-        return "Error"
+        return GENERAL_ERROR_MESSAGE
 
 
 def global_ip(debug=False):
@@ -84,19 +83,19 @@ def global_ip(debug=False):
     except Exception as e:
         if debug:
             print(str(e))
-        return "Error"
+        return GENERAL_ERROR_MESSAGE
 
 
 def set_ip(ip, restart=False, device="eth0", debug=False):
     """
     Set static ip in interfaces file (need sudo).
 
+    :param ip: static ip
+    :type ip :str
     :param restart : restart flag
     :type restart : bool
     :param device: network device name
     :type device:str
-    :param ip: static ip
-    :type ip :str
     :param debug: flag for using debug mode
     :type debug:bool
     :return: True in successful
@@ -127,18 +126,18 @@ def set_ip(ip, restart=False, device="eth0", debug=False):
     except Exception as e:
         if debug:
             print(str(e))
-        return "Error"
+        return GENERAL_ERROR_MESSAGE
 
 
 def ping(ip, packet_number=3, debug=False):
     """
     Ping ip and return True if this ip is available and False otherwise.
 
     :param ip: target ip
-    :param packet_number: number of packet to size
-    :param debug: flag for using debug mode
     :type ip :str
+    :param packet_number: number of packet to size
     :type packet_number:int
+    :param debug: flag for using debug mode
     :type debug:bool
     :return: a boolean value (True if ip is available and False otherwise)
     """
@@ -157,7 +156,7 @@ def ping(ip, packet_number=3, debug=False):
     except Exception as e:
         if debug:
             print(str(e))
-        return "Error"
+        return GENERAL_ERROR_MESSAGE
 
 
 def mac(debug=False):
@@ -180,4 +179,4 @@ def mac(debug=False):
     except Exception as e:
         if debug:
             print(str(e))
-        return "Error"
+        return GENERAL_ERROR_MESSAGE

orangetool/orangetool_params.py

@@ -0,0 +1,9 @@
+# -*- coding: utf-8 -*-
+"""Orangetool params."""
+
+ORANGETOOL_VERSION = "0.35"
+UPDATE_URL = "http://www.orangetool.ir/version"
+IP_PATTERN = r"(?:[0-9]{1,3}\.){3}[0-9]{1,3}"
+GLOBAL_IP_API_1 = "http://ipinfo.io/ip"
+GENERAL_ERROR_MESSAGE = "Error"
+ROOT_ERROR_MESSAGE = "Root Error"

orangetool/orangetool_ram.py

@@ -1,27 +1,8 @@
 # -*- coding: utf-8 -*-
 """Orangetool RAM functions."""
 import psutil
-
-
-def convert_bytes(num):
-    """
-    Convert num to idiomatic byte unit.
-
-    :param num: the input number.
-    :type num:int
-    :return: str
-    >>> convert_bytes(200)
-    '200.0 bytes'
-    >>> convert_bytes(6000)
-    '5.9 KB'
-    >>> convert_bytes(80000)
-    '78.1 KB'
-    """
-    for x in ['bytes', 'KB', 'MB', 'GB', 'TB']:
-        if num < 1024.0:
-            return "%3.1f %s" % (num, x)
-        num /= 1024.0
-
+from .orangetool_params import GENERAL_ERROR_MESSAGE
+from .orangetool_utils import convert_bytes
 
 def ram_total(convert=True):
     """
@@ -69,7 +50,7 @@ def ram_percent():
     """
     Return available ram percentage.
 
-    :return: availabe ram percentage as string with %
+    :return: available ram percentage as string with %
     """
     response = list(psutil.virtual_memory())
     return str(response[2]) + " %"
@@ -81,7 +62,7 @@ def freeup(debug=False):
 
     :param debug: flag for using debug mode
     :type debug:bool
-    :return: Amount of freeuped ram as string and converted by convert_bytes()
+    :return: amount of freeuped ram as string and converted by convert_bytes()
     """
     try:
         RAM_before = int(ram_free(convert=False))
@@ -96,4 +77,4 @@ def freeup(debug=False):
     except Exception as e:
         if debug:
             print(str(e))
-        return "Error"
+        return GENERAL_ERROR_MESSAGE

orangetool/orangetool_storage.py

@@ -3,13 +3,16 @@
 import subprocess as sub
 import os
 import string
-import random
+from .orangetool_params import GENERAL_ERROR_MESSAGE, ROOT_ERROR_MESSAGE
+from .orangetool_utils import random_generator
 
 
 def mount_status(device_name, debug=False):
     """
     Return addresses of mounted memory devices in dev by device name.
 
+    :param device_name: name of device
+    :type device_name: str
     :param debug: flag for using debug mode
     :type debug:bool
     :return: list of memory devices
@@ -29,7 +32,7 @@ def mount_status(device_name, debug=False):
     except Exception as e:
         if debug:
             print(str(e))
-        return "Error"
+        return GENERAL_ERROR_MESSAGE
 
 
 def storage_status(debug=False):
@@ -53,21 +56,21 @@ def storage_status(debug=False):
     except Exception as e:
         if debug:
             print(str(e))
-        return "Error"
+        return GENERAL_ERROR_MESSAGE
 
 
-def unmount(ADDRESS, debug=False):
+def unmount(address, debug=False):
     """
     Unmount memory devices by addresses.
 
-    :param ADDRESS: address of that device mount on
-    :type ADDRESS:str
+    :param address: address of that device mount on
+    :type address:str
     :param debug: flag for using debug mode
     :type debug:bool
     :return: True if device unmount correctly and False other wise
     """
     try:
-        command = sub.Popen(["umount", ADDRESS],
+        command = sub.Popen(["umount", address],
                             stdout=sub.PIPE, stderr=sub.PIPE)
         output = list(command.communicate())
         if len(output[0]) == 0 and len(output[1]) == 0:
@@ -76,7 +79,7 @@ def unmount(ADDRESS, debug=False):
     except Exception as e:
         if debug:
             print(str(e))
-        return "Error"
+        return GENERAL_ERROR_MESSAGE
 
 
 def unmount_all(debug=False):
@@ -100,34 +103,17 @@ def unmount_all(debug=False):
     except Exception as e:
         if debug:
             print(str(e))
-        return "Error"
-
-
-def random_generator(number):
-    """
-    Generate random number.
-
-    :param number: random number digits
-    :type number: int
-    :return: random number as str
-    """
-    response = ""
-    i = 0
-    while(i < number):
-        i += 1
-        response += str(random.randint(0, 9))
-    return response
-
+        return GENERAL_ERROR_MESSAGE
 
 def mount(device_name, mount_address=None, debug=False):
     """
     Mount memory devices by addresses.
 
     :param device_name: name of device for mounted example = sda1
-    :param mount_address: address for mounting device example = /mnt/usb , default value is None in this case function generate random number for mount folder name
-    :param debug: flag for using debug mode
     :type device_name:str
+    :param mount_address: address for mounting device example = /mnt/usb , default value is None in this case function generate random number for mount folder name
     :type mount_address:str
+    :param debug: flag for using debug mode
     :type debug:bool
     :return: True if device mount correctly and False other wise
     """
@@ -150,7 +136,7 @@ def mount(device_name, mount_address=None, debug=False):
     except Exception as e:
         if debug:
             print(str(e))
-        return "Error"
+        return GENERAL_ERROR_MESSAGE
 
 
 def usb_control(code, debug=False):
@@ -165,17 +151,17 @@ def usb_control(code, debug=False):
     """
     try:
         command = sub.Popen(
-            ["chmod", "-R", code,"/media/"],
+            ["chmod", "-R", code, "/media/"],
             stderr=sub.PIPE,
             stdout=sub.PIPE,
             stdin=sub.PIPE)
         response = list(command.communicate())
         if len(response[1]) > 0:
-            raise Exception('Root Error')
+            raise Exception(ROOT_ERROR_MESSAGE)
     except Exception as e:
         if debug:
             print(str(e))
-        return "Error"
+        return GENERAL_ERROR_MESSAGE
 
 
 def usb_on(debug=False):