libjam 0.0.17__tar.gz → 0.0.19__tar.gz

{libjam-0.0.17 → libjam-0.0.19}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: libjam
-Version: 0.0.17
+Version: 0.0.19
 Summary: A library jam for Python.
 Project-URL: Homepage, https://github.com/philippkosarev/libjam
 Project-URL: Issues, https://github.com/philippkosarev/libjam/issues
@@ -25,22 +25,22 @@ pip install libjam
 libjam consists of of 6 modules:
 
 ### Captain
-responsible for handling command-line arguments
+Responsible for handling command-line arguments.
 
 ### Drawer
-responsible for file operations
+Responsible for file operations.
 
 ### Typewriter
-responsible for transforming and printing text
+Responsible for transforming and printing text.
 
 ### Clipboard
-responsible for working with lists
+Responsible for working with lists.
 
 ### Notebook
-responsible for configuration
+Responsible for configuration.
 
 ### Flashcard
-responsible for getting user input from the command line
+Responsible for getting user input from the command line.
 
 ## Example project
 ```python
@@ -58,14 +58,11 @@ class CLI:
     if options.get('world').get('enabled'):
       print('world!')
 
-cli = CLI()
-
-# Inputs/Commands/Options configuration
+# Setting commands and options
 app = "example"
 description = "An example app for the libjam library"
-# help = "" # If you wish to set your own help page text
 commands = {
-  'print':     {'function': cli.hello,
+  'print':     {'function': CLI.hello,
   'description': 'Prints given string'},
 }
 options = {
@@ -73,17 +70,13 @@ options = {
  'description': 'Appends \'world\' after printing given input'},
 }
 
-# Getting program arguments
-arguments = sys.argv
-# Removing script name from arguments
-arguments.remove(arguments[0])
 # Generating help
 help = captain.generate_help(app, description, commands, options)
 # Interpreting user input
-interpretation = captain.interpret(app, help, commands, arguments, options)
+interpretation = captain.interpret(app, help, commands, options)
 # Getting parsed output
 function = interpretation.get('function')
 options = interpretation.get('options')
 # Executing function
-exec(f"cli.{function}")
+exec(f"CLI().{function}")
 ```

{libjam-0.0.17 → libjam-0.0.19}/README.md

@@ -11,22 +11,22 @@ pip install libjam
 libjam consists of of 6 modules:
 
 ### Captain
-responsible for handling command-line arguments
+Responsible for handling command-line arguments.
 
 ### Drawer
-responsible for file operations
+Responsible for file operations.
 
 ### Typewriter
-responsible for transforming and printing text
+Responsible for transforming and printing text.
 
 ### Clipboard
-responsible for working with lists
+Responsible for working with lists.
 
 ### Notebook
-responsible for configuration
+Responsible for configuration.
 
 ### Flashcard
-responsible for getting user input from the command line
+Responsible for getting user input from the command line.
 
 ## Example project
 ```python
@@ -44,14 +44,11 @@ class CLI:
     if options.get('world').get('enabled'):
       print('world!')
 
-cli = CLI()
-
-# Inputs/Commands/Options configuration
+# Setting commands and options
 app = "example"
 description = "An example app for the libjam library"
-# help = "" # If you wish to set your own help page text
 commands = {
-  'print':     {'function': cli.hello,
+  'print':     {'function': CLI.hello,
   'description': 'Prints given string'},
 }
 options = {
@@ -59,17 +56,13 @@ options = {
  'description': 'Appends \'world\' after printing given input'},
 }
 
-# Getting program arguments
-arguments = sys.argv
-# Removing script name from arguments
-arguments.remove(arguments[0])
 # Generating help
 help = captain.generate_help(app, description, commands, options)
 # Interpreting user input
-interpretation = captain.interpret(app, help, commands, arguments, options)
+interpretation = captain.interpret(app, help, commands, options)
 # Getting parsed output
 function = interpretation.get('function')
 options = interpretation.get('options')
 # Executing function
-exec(f"cli.{function}")
+exec(f"CLI().{function}")
 ```

libjam-0.0.19/example.py

@@ -0,0 +1,35 @@
+#! /usr/bin/python
+
+# Imports
+import sys
+from libjam import Captain
+
+captain = Captain()
+
+class CLI:
+  def hello(self, text):
+    print(text)
+    if options.get('world').get('enabled'):
+      print('world!')
+
+# Setting commands and options
+app = "example"
+description = "An example app for the libjam library"
+commands = {
+  'print':     {'function': CLI.hello,
+  'description': 'Prints given string'},
+}
+options = {
+ 'world': {'long': ['world'], 'short': ['w'],
+ 'description': 'Appends \'world\' after printing given input'},
+}
+
+# Generating help
+help = captain.generate_help(app, description, commands, options)
+# Interpreting user input
+interpretation = captain.interpret(app, help, commands, options)
+# Getting parsed output
+function = interpretation.get('function')
+options = interpretation.get('options')
+# Executing function
+exec(f"CLI().{function}")

{libjam-0.0.17 → libjam-0.0.19}/libjam/captain.py

@@ -1,13 +1,25 @@
 # Imports
-import sys, re, inspect
+import sys
+from inspect import signature
 from .typewriter import Typewriter
-from .clipboard import Clipboard
 typewriter = Typewriter()
-clipboard = Clipboard()
 
 # Processes command line arguments
 class Captain:
 
+  def get_args(self):
+    args = sys.argv
+    args.pop(0)
+    return args
+
+  # Returns a list of args a function requires.
+  def get_function_args(self, function):
+    args = str(signature(function))
+    args = args.removeprefix('(').removesuffix(')').replace(' ', '').split(',')
+    if 'self' in args:
+     args.remove('self')
+    return args
+
   # Returns a generated a help page based on provided inputs
   def generate_help(self, app: str, description: str, commands: dict, options: dict = None):
     offset = 2; offset_string = ' ' * offset
@@ -49,8 +61,9 @@ class Captain:
 
 
   # Interprets input arguments
-  def interpret(self, app: str, help: str, commands: dict, arguments: list, options: dict = None):
+  def interpret(self, app: str, help: str, commands: dict, options: dict = None):
     # Class vars
+    arguments = self.get_args()
     chosen_command = None
     self.function = None
     self.arbitrary_args = False
@@ -70,52 +83,53 @@ class Captain:
           # Long options
           if argument.startswith("--"):
             argument = argument.removeprefix("--")
+            if argument == '':
+              print(f"Invalid option '--'. Try {app} help")
+              sys.exit(-1)
             for option in options:
               strings = options.get(option).get('long')
-              if clipboard.is_string_in_list(strings, argument):
+              if argument in strings:
                 options[option]['enabled'] = True
                 self.arg_found = True
             if self.arg_found is False:
-              print(f"Option '{argument}' unrecognized. Try {app} help")
+              print(f"Option '{argument}' unrecognised. Try {app} help")
               sys.exit(-1)
 
           # Short options
           else:
             argument = argument.removeprefix("-")
+            if argument == '':
+              print(f"Invalid option '-'. Try {app} help")
+              sys.exit(-1)
             arguments = list(argument)
             for argument in arguments:
               command_found = False
               for option in options:
                 strings = options.get(option).get('short')
-                if clipboard.is_string_in_list(strings, argument):
+                if argument in strings:
                   options[option]['enabled'] = True
                   command_found = True
             if command_found is False:
-              print(f"Option '{argument}' unrecognized. Try {app} help")
+              print(f"Option '{argument}' unrecognised. Try {app} help")
               sys.exit(-1)
 
       # Commands
       else:
         if chosen_command is None:
-          if clipboard.is_string_in_list(commands, argument):
+          if argument == 'help':
+            print(help)
+            sys.exit(0)
+          elif argument in commands:
             chosen_command = argument
             command_function = commands.get(chosen_command).get('function')
-            command_args = inspect.signature(command_function)
-            command_args = command_args.format().replace('(', '').replace(')', '').replace(' ', '')
-            command_args = command_args.split(',')
-            if clipboard.is_string_in_list(command_args, '*args'):
-              command_args.remove('*args')
+            command_function_args = self.get_function_args(command_function)
+            if '*args' in command_function_args:
+              command_function_args.remove('*args')
               self.arbitrary_args = True
-            if command_args == ['']:
-              command_args = []
-            self.required_args = len(command_args)
-            continue
-          elif argument == 'help':
-            print(help)
-            sys.exit(0)
-        if chosen_command is None:
-          print(f"Command '{argument}' unrecognized. Try {app} help")
-          sys.exit(-1)
+            self.required_args = len(command_function_args)
+          else:
+            print(f"Command '{argument}' unrecognised. Try {app} help")
+            sys.exit(-1)
 
         # Command arguments
         else:

{libjam-0.0.17 → libjam-0.0.19}/libjam/drawer.py

@@ -45,18 +45,19 @@ class Drawer:
     path = realpath(path)
     return outpath(path)
 
-  # Returns True if give a path to folder
+  # Returns True if given a path to a folder.
   def is_folder(self, path: str):
     if path == '':
       return False
     path = realpath(path)
     return os.path.isdir(path)
 
-  # Returns True if give a path to file
+  # Returns True if given a path to a file.
   def is_file(self, path: str):
     path = realpath(path)
     return os.path.isfile(path)
 
+  # Returns True if path exists.
   def exists(self, path: str):
     path = realpath(path)
     is_file = self.is_folder(path)
@@ -78,7 +79,7 @@ class Drawer:
     filetype = os.path.splitext(basename)[1].removeprefix('.')
     return filetype
 
-  # Returns a list of files and folders in a given folder
+  # Returns a list of files and folders in a given path.
   def get_all(self, path: str):
     path = realpath(path)
     relative_files = os.listdir(path)
@@ -234,6 +235,7 @@ class Drawer:
     depth = len(depth)
     return depth
 
+  # Returns the basename of file(s)/folder(s).
   def basename(self, path: str or list):
     if type(path) == str:
       path = realpath(path)
@@ -367,7 +369,8 @@ class Drawer:
     temp = str(tempfile.gettempdir())
     return outpath(temp)
 
-  def get_file_size(self, path: str):
+  # Returns the weight of given file/folder, in bytes.
+  def get_filesize(self, path: str):
     path = realpath(path)
     try:
       if self.is_file(path):
@@ -382,6 +385,34 @@ class Drawer:
       typewriter.print('Program aborted while gathering size of files.')
       sys.exit(1)
 
+  # Given a number of bytes, returns a human readable filesize as a tuple.
+  # Tuple format: (value: int, short_unit_name: str, long_unit_name: str)
+  # Example tuple: (6.986356, 'mb', 'megabytes')
+  def get_readable_filesize(self, filesize: int):
+    if filesize > 1000 ** 7:
+      value = filesize / 1000 ** 7
+      return (value, 'zb', 'zettabytes')
+    elif filesize > 1000 ** 6:
+      value = filesize / 1000 ** 6
+      return (value, 'eb', 'exabytes')
+    elif filesize > 1000 ** 5:
+      value = filesize / 1000 ** 5
+      return (value, 'pb', 'petabytes')
+    elif filesize > 1000 ** 4:
+      value = filesize / 1000 ** 4
+      return (value, 'tb', 'terabytes')
+    elif filesize > 1000 ** 3:
+      value = filesize / 1000 ** 3
+      return (value, 'gb', 'gigabytes')
+    elif filesize > 1000 ** 2:
+      value = filesize / 1000 ** 2
+      return (value, 'mb', 'megabytes')
+    elif filesize > 1000:
+      value = filesize / 1000 ** 1
+      return (value, 'kb', 'kilobytes')
+    else:
+      return (filesize, 'b', 'bytes')
+
   def open(self, path: str):
     path = realpath(path)
     if PLATFORM == 'Linux':

{libjam-0.0.17 → libjam-0.0.19}/pyproject.toml

@@ -14,7 +14,7 @@ include = [
 
 [project]
 name = "libjam"
-version = "0.0.17"
+version = "0.0.19"
 authors = [
   { name="Philipp Kosarev", email="philipp.kosarev@gmail.com" },
 ]