Improve docstrings

Author: eanorambuena

eggdriver/app.py

@@ -1,4 +1,3 @@
-# Imports
 from eggdriver.resources.console import get, clearConsole, pg
 from eggdriver.resources.constants import *
 from eggdriver.resources.modules import installFromRequests, upgrade, Repo

eggdriver/nqs/developer/write.py

@@ -1,6 +1,6 @@
-import eggdriver.nqs.core as core
+from eggdriver.nqs.core.core import compile
 from eggdriver.resources.extensions import py
 
 def write(name: str):
-	T=core.compile(name)
-	py.write(T,name)
+	T = compile(name)
+	py.write(T, name)

eggdriver/resources/__init__.py

@@ -11,5 +11,5 @@
 from eggdriver.resources.utils import *
 from eggdriver.resources.web import *
 
-_author="eanorambuena"
-_author_email="eanorambuena@uc.cl"
+author="eanorambuena"
+author_email="eanorambuena@uc.cl"

eggdriver/resources/extensions.py

@@ -1,44 +1,45 @@
 import os
 
 class Lang:
-    def __init__(self,name: str):
-        self.name=name
-        self.extension="."+self.name
-        self.root="/usr/bin/python "+name+self.extension
-    def write(self,T: str,name: str):
-        f=open(name+self.extension,"w")
+    """File Format class with some useful methods"""
+    def __init__(self, name: str):
+        self.name = name
+        self.extension = "." + self.name
+        self.root="/usr/bin/python " + name + self.extension
+    def write(self, T: str, name: str):
+        f = open(name + self.extension, "w")
         f.write(T)
         f.close()
-    def append(self,T: str,name: str):
-        f=open(name+self.extension,"a")
+    def append(self, T: str, name: str):
+        f = open(name + self.extension, "a")
         f.write(T)
         f.close()
     def read(self, name: str):
-        f=open(name+self.extension,"r")
-        text=f.read()
+        f = open(name + self.extension, "r")
+        text = f.read()
         f.close()
         return text
-    def execute(self,name: str):
+    def execute(self, name: str):
         try:
             os.system(self.root)
         except:
-            print("Execute error in: "+self.root)
-    def delete(self,name: str):
-        os.remove(name+self.extension)
-    def getLines(self,name: str):
-        h=open(name+self.extension,"r")
-        lines=h.readlines()
+            print("Execute error in: " + self.root)
+    def delete(self, name: str):
+        os.remove(name + self.extension)
+    def getLines(self, name: str):
+        h = open(name + self.extension, "r")
+        lines = h.readlines()
         h.close()
         return lines
-    def writeLines(self,lines,name: str):
-        self.write("",name)
+    def writeLines(self, lines, name: str):
+        self.write("", name)
         for i in lines:
-            self.append(i,name)
+            self.append(i, name)
 
 # Extensions
-py=Lang("py")
-txt=Lang("txt")
-nqa=Lang("nqa")
-pfcf=Lang("pfcf")
-html=Lang("html")
-withoutFormat=Lang("")
+py = Lang("py")
+txt = Lang("txt")
+nqa = Lang("nqa")
+pfcf = Lang("pfcf")
+html = Lang("html")
+withoutFormat = Lang("")

eggdriver/resources/help.py

@@ -2,7 +2,8 @@
 from eggdriver.resources.extensions import py
 
 def help():
-    T = "Welcome to Pyfoch Egg:\nThe Pyfoch Egg-cosystem console\n\n"
+    """Get help from Egg"""
+    T = "Welcome to Egg:\nThe Egg-cosystem console\n\n"
     T += py.read("egg/library/commands")
     print(white + T)
     return "done"

eggdriver/resources/modules.py

@@ -1,11 +1,11 @@
 import pip, sys, subprocess
-import importlib as il
 import importlib.util
 from eggdriver.resources.constants import white
 from eggdriver.resources.extensions import withoutFormat
 from eggdriver.resources.console import ProgressBar
 
 def isntInstalled(package):
+    """Returns True if a PyPI is not installed"""
     spec = importlib.util.find_spec(package)
     loweredSpec = importlib.util.find_spec(package.lower())
     if (spec is None) and (loweredSpec is None): 
@@ -26,6 +26,7 @@ def install_option_2(name: str):
     return "done"
 
 def installFromRequests(requestOrPackages = "requests", fromRequests = True):
+    """Install PyPI packages from a requests file or a list"""
     if fromRequests:
         requestOrPackages = withoutFormat.getLines(requestOrPackages)
     bar = ProgressBar()
@@ -40,13 +41,15 @@ def installFromRequests(requestOrPackages = "requests", fromRequests = True):
         bar.display(int(c / l * 100), 32, 24, True)
 
 def installFromGithub(userOrOrganization: str, packages: list):
+    """Install a package from github.com"""
     for package in packages:
         url = f"git+https://github.com/{userOrOrganization}/{package}.git#egg={package}"
         installFromRequests([url], False)
         print(white + package +" succesfully installed")
         print(white + f"Try \'import {package}\'")
 
 def install(name: str):
+    """Install a PyPI package"""
     try:
         installFromRequests(name,0)
         #raise Exception("error")
@@ -62,13 +65,15 @@ def install(name: str):
     return "done"
 
 def upgrade(name: str):
+    """Update a PyPI package"""
     try:
         subprocess.check_call([sys.executable, '-m', 'pip', 'install', '--upgrade', name])
     except:
         print(white + name + " succesfully ugraded")
     return "done"
 
 class Repo():
+    """Github Repo class"""
     def __init__(self, userOrOrganization: str, package: str):
         self.root = userOrOrganization
         self.name = package

eggdriver/resources/parser.py

@@ -1,23 +1,24 @@
 class Parser():
-  def __init__(self,name: str ="Parser"):
-    self.sep=[',']
-    self.sec=['|']
-    self.ski=["\""]
-    self.vip=["\\"]
-    self.den=["~"]
-    self.name=name
-  def compare(self,x: str,arr):
-    k = False
-    for i in arr:
-      k =( k or x==i)
-    return k
-  def separator(self,x: str ):
-    return self.compare(x,self.sep)
-  def section(self,x: str):
-    return self.compare(x,self.sec)
-  def skip(self,x: str):
-    return self.compare(x,self.ski)
-  def isVip(self,x: str):
-    return self.compare(x,self.vip)
-  def isDeny(self,x: str):
-    return self.compare(x,self.den)
+	"""Pfcf files parser"""
+	def __init__(self, name: str = "Parser"):
+		self.sep = [',']
+		self.sec = ['|']
+		self.ski = ["\""]
+		self.vip = ["\\"]
+		self.den = ["~"]
+		self.name = name
+	def compare(self, x: str, arr):
+		k = False
+		for i in arr:
+				k =( k or x == i)
+		return k
+	def separator(self, x: str ):
+		return self.compare(x, self.sep)
+	def section(self, x: str):
+		return self.compare(x, self.sec)
+	def skip(self, x: str):
+		return self.compare(x, self.ski)
+	def isVip(self, x: str):
+		return self.compare(x, self.vip)
+	def isDeny(self, x: str):
+		return self.compare(x, self.den)

eggdriver/resources/strings.py

@@ -9,13 +9,14 @@
 >>> El camion es mio
 """
 def normalize(self): # Method retrieved from https://micro.recursospython.com/recursos/como-quitar-tildes-de-una-cadena.html
-        replacements = (
-            ("á", "a"),
-            ("é", "e"),
-            ("í", "i"),
-            ("ó", "o"),
-            ("ú", "u"),
-        )
-        for a, b in replacements:
-            s = self.str.replace(a, b).replace(a.upper(), b.upper())
-        return s
+    """Remove accents from words"""
+    replacements = (
+        ("á", "a"),
+        ("é", "e"),
+        ("í", "i"),
+        ("ó", "o"),
+        ("ú", "u"),
+    )
+    for a, b in replacements:
+        s = self.str.replace(a, b).replace(a.upper(), b.upper())
+    return s

eggdriver/resources/utils.py

@@ -10,5 +10,5 @@ def floor(f: float):
 
 def colour(id: int, bgcolor: int = 0):
 	if bgcolor != 0:
-		return "\033[1;" +str(id) + ";" + str(bgcolor + 10) + "m "
+		return "\033[1;" + str(id) + ";" + str(bgcolor + 10) + "m "
 	return "\033[1;" + str(id) + "m"

eggdriver/resources/web.py

@@ -2,28 +2,30 @@
 from eggdriver.resources.extensions import html
 
 class Document():
+    """HTML documents class whit some useful methods like Document.write"""
     def __init__(self, name: str, output: str ="index"):
         install("bs4")
         from bs4 import BeautifulSoup
-        self.name=name
-        doc=open(self.name+".html").read()
-        self.soup=BeautifulSoup(doc,features="html.parser")
-        self.output=output
-        lines=html.getLines(self.name)
+        self.name = name
+        doc = open(self.name + ".html").read()
+        self.soup = BeautifulSoup(doc, features = "html.parser")
+        self.output = output
+        lines = html.getLines(self.name)
         html.writeLines(lines, self.output)
     def write(self, text: str, id: str):
-        lines=html.getLines(self.output)
-        for i in range(0,len(lines)):
-            l=lines[i]
-            words=l.split()
-            if words[0]=="$egg" and id==words[1]:
-                lines[i]=text+"\n"
-                html.writeLines(lines,self.output)
+        lines = html.getLines(self.output)
+        for i in range(0, len(lines)):
+            line = lines[i]
+            words = line.split()
+            if words[0] == "$egg" and id == words[1]:
+                lines[i] = text + "\n"
+                html.writeLines(lines, self.output)
                 return lines
-    def addTag(self,tag: str, content: str, id: str):
-        return self.write(makeTag(self,tag, content),id)
+    def addTag(self, tag: str, content: str, id: str):
+        return self.write(makeTag(self, tag, content), id)
 
-def makeTag(document,tag: str, content: str):
-    new=document.soup.new_tag(tag)
-    new.string=content
+def makeTag(document, tag: str, content: str):
+    """Make an HTML tag"""
+    new = document.soup.new_tag(tag)
+    new.string = content
     return str(new)