Moves page classes to individual files and into a folder

Author: codeZeilen

pagesources/AbstractPage.py

@@ -0,0 +1,17 @@
+from abc import abstractmethod
+
+class AbstractPage(object):
+
+    @classmethod
+    @abstractmethod
+    def has_page(cls, name: str) -> bool:
+        pass
+
+    @classmethod
+    @abstractmethod
+    def get_page(cls, name: str):
+        pass
+
+    @abstractmethod
+    def description(self) -> str:
+        pass

pagesources/BashHelpPage.py

@@ -0,0 +1,27 @@
+from typing import List, Optional, Tuple, Union, Type
+from .AbstractPage import AbstractPage
+import subprocess
+
+class BashHelpPage(AbstractPage):
+    """`help` documents the built-in commands of bash"""
+
+    def __init__(self, name, content: str):
+        self.page_name = name
+        self.content = content
+
+    def description(self, detailed = False) -> str:
+        return self.content
+
+    @classmethod
+    def run_help(cls, name: str):
+        return subprocess.run(["/bin/bash", "-c", '"help -d {name}"'.format(name=name)], capture_output=True)
+        
+    @classmethod
+    def has_page(cls, name: str) -> bool:
+        process = cls.run_help(name)
+        return process.returncode == 0
+
+    @classmethod
+    def get_page(cls, name: str) -> 'BashHelpPage':
+        process = cls.run_help(name)
+        return cls(name, str(process.stdout))

pagesources/FSPathPage.py

@@ -0,0 +1,23 @@
+from typing import List, Optional, Tuple, Union, Type
+from .AbstractPage import AbstractPage
+import json, os
+
+class FSPathPage(AbstractPage):
+
+    pages = None
+    with open("./fspages.json") as pages_file:
+        pages = json.load(pages_file)
+
+    def __init__(self, path):
+        self.path = path
+
+    @classmethod
+    def is_path(cls, path):
+        return os.path.exists(path)
+
+    @classmethod
+    def get_page(cls, path) -> Type['FSPathPage']:
+        return cls(path)
+
+    def description(self, detailed = False) -> str:
+        return FSPathPage.pages.get(self.path, "no page found")

pagesources/TLDRPage.py

@@ -0,0 +1,28 @@
+from typing import List, Optional, Tuple, Union, Type
+from .AbstractPage import AbstractPage
+
+import tldr
+
+class TLDRPage(AbstractPage):
+
+    def __init__(self, name, content: List[str]):
+        self.page_name = name
+        self.content = content
+
+    @classmethod
+    def get_page(cls, name: str) -> 'TLDRPage':
+        return cls(name, tldr.get_page(name))
+
+    @classmethod
+    def has_page(cls, name: str) -> bool:
+        return tldr.get_page(name) is not False
+
+    def description(self, detailed = False) -> str:
+        description = ""
+        lines = self.content[2:4] if detailed else self.content[2:3]
+        for line in lines:
+            line = line.rstrip().decode('utf-8')
+            if line[0] == ">":
+                line = line[1:].lstrip()
+            description = description + line + "\n" 
+        return description.rstrip()

pagesources/WhatIsPage.py

@@ -0,0 +1,30 @@
+from typing import List, Optional, Tuple, Union, Type
+from .AbstractPage import AbstractPage
+import subprocess
+
+class WhatIsPage(AbstractPage):
+    """`whatis` makes use of the man page infrastructure of the OS.
+    This also covers the output of `apropos`, `info`, and `man`."""
+
+    def __init__(self, name, content: str):
+        self.page_name = name
+        self.content = content
+
+    def description(self, detailed = False) -> str:
+        return self.content
+
+    @classmethod
+    def run_whatis(cls, name: str):
+        return subprocess.run(["whatis", name], capture_output=True)
+
+    @classmethod
+    def has_page(cls, name: str) -> bool:
+        process = cls.run_whatis(name)
+        return process.returncode == 0
+
+    @classmethod
+    def get_page(cls, name: str) -> 'WhatIsPage':
+        process = cls.run_whatis(name)
+        description = process.stdout.decode('utf-8')
+        description = description.split(" - ")[1].strip()
+        return cls(name, description)

pagesources/__init__.py

@@ -0,0 +1,4 @@
+from .BashHelpPage import BashHelpPage
+from .TLDRPage import TLDRPage
+from .FSPathPage import FSPathPage
+from .WhatIsPage import WhatIsPage

wat.py

@@ -2,106 +2,9 @@
 
 from typing import List, Optional, Tuple, Union, Type
 
-import tldr
 from argparse import ArgumentParser
-import os
-import json
-import subprocess
 
-class WhatIsHelpPage(object):
-    """`whatis` makes use of the man page infrastructure of the OS.
-    This also covers the output of `apropos`, `info`, and `man`."""
-
-    def __init__(self, name, content: str):
-        self.page_name = name
-        self.content = content
-
-    def description(self, detailed = False) -> str:
-        return self.content
-
-    @staticmethod
-    def run_whatis(name: str):
-        return subprocess.run(["whatis", name], capture_output=True)
-
-    @staticmethod
-    def has_page(name: str) -> bool:
-        process = WhatIsHelpPage.run_whatis(name)
-        return process.returncode == 0
-
-    @staticmethod
-    def get_page(name: str) -> 'WhatIsHelpPage':
-        process = WhatIsHelpPage.run_whatis(name)
-        description = process.stdout.decode('utf-8')
-        description = description.split(" - ")[1].strip()
-        return WhatIsHelpPage(name, description)
-
-class OSHelpPage(object):
-    """`help` documents the built-in commands of bash"""
-
-    def __init__(self, name, content: str):
-        self.page_name = name
-        self.content = content
-
-    def description(self, detailed = False) -> str:
-        return self.content
-
-    @staticmethod
-    def run_help(name: str):
-        return subprocess.run(["/bin/bash", "-c", '"help -d {name}"'.format(name=name)], capture_output=True)
-        
-    @staticmethod
-    def has_page(name: str) -> bool:
-        process = OSHelpPage.run_help(name)
-        return process.returncode == 0
-
-    @staticmethod
-    def get_page(name: str) -> 'OSHelpPage':
-        process = OSHelpPage.run_help(name)
-        return OSHelpPage(name, str(process.stdout))
-
-class TLDRPage(object):
-
-    def __init__(self, name, content: List[str]):
-        self.page_name = name
-        self.content = content
-
-    @staticmethod
-    def get_page(name: str) -> 'TLDRPage':
-        return TLDRPage(name, tldr.get_page(name))
-
-    @staticmethod
-    def has_page(name: str) -> bool:
-        return tldr.get_page(name) is not False
-
-    def description(self, detailed = False) -> str:
-        description = ""
-        lines = self.content[2:4] if detailed else self.content[2:3]
-        for line in lines:
-            line = line.rstrip().decode('utf-8')
-            if line[0] == ">":
-                line = line[1:].lstrip()
-            description = description + line + "\n" 
-        return description.rstrip()
-
-class FileOrFolderPage(object):
-
-    pages = None
-    with open("./fspages.json") as pages_file:
-        pages = json.load(pages_file)
-
-    def __init__(self, path):
-        self.path = path
-
-    @staticmethod
-    def is_path(path):
-        return os.path.exists(path)
-
-    @staticmethod
-    def get_page(path) -> Type['FileOrFolderPage']:
-        return FileOrFolderPage(path)
-
-    def description(self, detailed = False) -> str:
-        return FileOrFolderPage.pages.get(self.path, "no page found")
+from pagesources import BashHelpPage, FSPathPage, TLDRPage, WhatIsPage
 
 def create_parser() -> ArgumentParser:
     parser = ArgumentParser(prog="wat")
@@ -118,12 +21,12 @@ def parse_arguments() -> List[str]:
     return arguments.name_of_this
 
 def lookup_page(name: str) -> str:
-    if FileOrFolderPage.is_path(name):
-        return FileOrFolderPage.get_page(name)
-    elif WhatIsHelpPage.has_page(name):
-        return WhatIsHelpPage.get_page(name)
-    elif OSHelpPage.has_page(name):
-        return OSHelpPage.get_page(name)
+    if FSPathPage.is_path(name):
+        return FSPathPage.get_page(name)
+    elif WhatIsPage.has_page(name):
+        return WhatIsPage.get_page(name)
+    elif BashHelpPage.has_page(name):
+        return BashHelpPage.get_page(name)
     elif TLDRPage.has_page(name):
         return TLDRPage.get_page(name)
     else: