minishell 0.0.1__tar.gz

minishell-0.0.1/PKG-INFO

@@ -0,0 +1,21 @@
+Metadata-Version: 2.1
+Name: minishell
+Version: 0.0.1
+Summary: 
+License: LGPL-3.0-or-later
+Author: RomanLabs
+Author-email: rromanotero@romanlabs.com
+Requires-Python: >=3.11,<4.0
+Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: mypy (>=1.10.0,<2.0.0)
+Requires-Dist: rich (>=13.7.1,<14.0.0)
+Description-Content-Type: text/markdown
+
+## MiniShell
+
+[Project in Gitlab](https://gitlab.com/romanlabs/public/minishell)
+
+

minishell-0.0.1/README.md

@@ -0,0 +1,4 @@
+## MiniShell
+
+[Project in Gitlab](https://gitlab.com/romanlabs/public/minishell)
+

minishell-0.0.1/pyproject.toml

@@ -0,0 +1,25 @@
+[tool.poetry]
+name = "minishell"
+version = "0.0.1"
+description = ""
+authors = ["RomanLabs <rromanotero@romanlabs.com>"]
+readme = "README.md"
+license = "LGPL-3.0-or-later"
+packages = [{include = "minishell", from = "src"}]
+
+[tool.poetry.scripts]
+manual-test-run = "minishell.manual_test_run:main"
+
+[tool.poetry.dependencies]
+python = "^3.11"
+mypy = "^1.10.0"
+rich = "^13.7.1"
+
+[tool.poetry.group.dev.dependencies]
+mypy = "^1.10.0"
+pytest = "^8.2.1"
+toml = "^0.10.2"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

minishell-0.0.1/src/minishell/__init__.py

@@ -0,0 +1,21 @@
+# Copyright (C) 2024 RomanLabs, Rafael Roman Otero
+# This file is part of API Pipe.
+#
+# API Pipe is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# API Pipe is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with API Pipe. If not, see <http://www.gnu.org/licenses/>.
+
+'''
+    Module Name
+'''
+__version__ = '0.0.1'
+__author__ = 'RomanLabs'

minishell-0.0.1/src/minishell/cmd.py

@@ -0,0 +1,170 @@
+# Copyright (C) 2024 RomanLabs, Rafael Roman Otero
+# This file is part of API Pipe.
+#
+# API Pipe is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# API Pipe is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with API Pipe. If not, see <http://www.gnu.org/licenses/>.
+
+'''
+    Cmd
+'''
+import logging
+import subprocess
+from typing import ClassVar
+
+from minishell.error import ArgumentError, NonZeroExit
+from minishell import logger
+
+class CmdMeta(type):
+    def __getattr__(cls, method_name: str):
+        '''
+            __getattr__
+
+            Captures get attribute calls
+            to the Cmd class
+
+            This enables the chaining of commands
+            STARTING FROM Cmd, as opposed to Cmd()
+
+            e.g.
+
+                Cmd.i.am.a.command.withh.arguments("arg1")
+
+        '''
+        return Cmd(method_name)
+
+class Cmd(metaclass=CmdMeta):
+    _log: ClassVar[logging.Logger] = logger.stdout(__name__, logging.DEBUG)
+    __is_first_call: ClassVar[bool] = False
+
+    @classmethod
+    def log_setup(cls, log_level: int):
+        '''
+            log_setup
+
+            Sets up logging for all commands
+        '''
+        Cmd._log = logger.stdout(__name__, log_level)
+
+    def __init__(self, cmd_str_to_add=''):
+        '''
+            __init__
+        '''
+        if not Cmd.__is_first_call:
+            # enable pretty tracebacks
+            logger.enable_pretty_tracebacks()
+            Cmd.__is_first_call = True
+
+        self.cmd_str = cmd_str_to_add
+
+    def __getattr__(self, method_name: str):
+        '''
+            __getattr__
+
+            Captures get attribute calls
+
+            Returns a new Cmd object with
+            the attribute name appended to cmd_str
+        '''
+        if self.cmd_str:
+            return Cmd(f"{self.cmd_str} {method_name}")
+        else:
+            #
+            # this runs only once
+            # when the first method is called
+            #
+            # e.g.
+            #   Cmd().i.am.a.command.withh.arguments("arg1")
+            #
+            #   calling i will return a new Cmd object
+            #   with cmd_str set to i
+            #
+            #   Therefore, the next call to am will append to cmd_str
+            #   and so forth
+            #
+            return Cmd(method_name)
+
+    def __call__(self, *args, **kwargs):
+        '''
+            __call__
+
+            Captures call to object
+
+            This is the last call in the chain
+            and will execute the command with
+            the arguments passed in
+        '''
+        if kwargs:
+            raise ArgumentError(
+                f"Shell Command object cannot take keyword arguments"
+            )
+        return self.__execute_command(
+            self.__add_args(self.cmd_str, *args)
+        )
+
+    def __add_args(self, cmd_str: str, *args) -> str:
+        '''
+            Add arguments to command string
+
+            Returns a string with the command string
+            and arguments appended to it
+
+            e.g.
+
+                In:
+
+                Cmd().i.am.a.command.withh.arguments("arg1")
+
+                cmd_str = "i am a command withh arguments"
+                args = ("arg1",)
+
+                will return:
+                    "i am a command withh arguments arg1"
+        '''
+        args_str = ' '.join(str(arg) for arg in args)
+        return f"{cmd_str} {args_str}"
+
+    def __execute_command(self, cmd_str: str) -> tuple[str, str]:
+        '''
+            Execute command in cmd_str
+        '''
+        Cmd._log.debug(cmd_str)
+
+        output = subprocess.run(
+            cmd_str,
+            capture_output=True,
+            shell=True, # There's more to this but the main
+                        # reason is that shell=False will
+                        # raise exceptions on non-zero exit codes
+            text=True,
+            check=False # Don't raise exception on non-zero exit code
+        )
+
+        if output.stdout:
+            Cmd._log.info(output.stdout)
+
+        if output.stderr:
+            Cmd._log.error(output.stderr)
+
+        if output.returncode != 0:
+            raise NonZeroExit(
+                cmd_str,
+                output.returncode,
+                output.stdout,
+                output.stderr
+            )
+
+        stdout = output.stdout.strip() if output.stdout else ''
+        stderr = output.stderr.strip() if output.stderr else ''
+
+        return stdout, stderr
+

minishell-0.0.1/src/minishell/config.py

@@ -0,0 +1,58 @@
+# Copyright (C) 2024 RomanLabs, Rafael Roman Otero
+# This file is part of API Pipe.
+#
+# API Pipe is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# API Pipe is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with API Pipe. If not, see <http://www.gnu.org/licenses/>.
+
+'''
+    Tool
+
+    This file is used to configure the tool
+'''
+
+#logs
+# (these are Paths not strings)
+log_formatter = "%(message)s"
+log_show_time = False
+log_words_to_highlight = [
+    "importing",
+    "exporting",
+    "validating",
+    "deleting",
+    "getting",
+    "writing",
+    "reading",
+    "found",
+    "making",
+    "removing",
+    "selecting",
+    "emptying",
+    "initializing",
+    "logging",
+    "checking",
+    "requesting",
+    "imported",
+    "collecting",
+    "parsing",
+    "loading",
+    "cleaning",
+    "fetching",
+    "converting",
+    "created",
+    "Initialiazing",
+    "rendering",
+    "appending",
+    "processing",
+    "creating",
+    "created"
+]

minishell-0.0.1/src/minishell/error.py

@@ -0,0 +1,58 @@
+# Copyright (C) 2024 RomanLabs, Rafael Roman Otero
+# This file is part of API Pipe.
+#
+# API Pipe is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# API Pipe is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with API Pipe. If not, see <http://www.gnu.org/licenses/>.
+
+'''
+    error.py
+'''
+from minishell import logger
+
+log = logger.stdout(
+    __name__,
+    logger.logging.CRITICAL
+)
+
+class ArgumentError(TypeError):
+    '''
+        ArgumentError
+
+        Raised when an argument is invalid
+    '''
+    def __init__(self, msg: str):
+
+        super().__init__(msg)
+
+class NonZeroExit(RuntimeError):
+    '''
+        CommandError
+
+        Raised when a command fails
+    '''
+    def __init__(self,
+        command: str,
+        return_code: int,
+        stdout: str,
+        stderr: str
+    ):
+        if stdout:
+            stdout = f"\n{stdout}"
+        if stderr:
+            stderr = f"\n{stderr}"
+
+        super().__init__(
+            f"Command '{command}' failed with return code {return_code}:"
+            f"{stdout}"
+            f"{stderr}"
+        )

minishell-0.0.1/src/minishell/logger.py

@@ -0,0 +1,70 @@
+# Copyright (C) 2024 RomanLabs, Rafael Roman Otero
+# This file is part of API Pipe.
+#
+# API Pipe is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# API Pipe is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with API Pipe. If not, see <http://www.gnu.org/licenses/>.
+
+'''
+    logger.py
+'''
+import logging
+from rich.logging import RichHandler
+from rich.traceback import install
+
+from minishell import config
+
+def enable_pretty_tracebacks() -> None:
+    '''
+        Enable Pretty Traceback
+
+        Uses rich to print pretty tracebacks
+    '''
+    install()
+
+def stdout(name: str, log_level: int) -> logging.Logger:
+    '''
+        Sets up a logger that logs to stdout
+
+        Uses RichHandler to pretty print logs
+    '''
+    words_to_highlight = config.log_words_to_highlight
+
+    handler = RichHandler(
+        show_time=config.log_show_time,
+        keywords=[w.lower() for w in words_to_highlight] + \
+                 [w.upper() for w in words_to_highlight] + \
+                 [w.capitalize() for w in words_to_highlight]
+    )
+
+    logger = CustomLogger(name)
+    logger.setLevel(log_level)
+    formatter = logging.Formatter(config.log_formatter)
+    handler.setFormatter(formatter)
+    logger.addHandler(handler)
+
+    return logger
+
+class CustomLogger(logging.Logger):
+    '''
+        Extends the logging.Logger class
+        with  custom methods
+    '''
+    def flush(self) -> None:
+        '''
+            Flush
+
+            Flushes the logger
+        '''
+        for handler in self.handlers:
+            handler.flush()
+

minishell-0.0.1/src/minishell/manual_test_run.py

@@ -0,0 +1,50 @@
+# Copyright (C) 2024 RomanLabs, Rafael Roman Otero
+# This file is part of API Pipe.
+#
+# API Pipe is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# API Pipe is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with API Pipe. If not, see <http://www.gnu.org/licenses/>.
+
+'''
+    Run Manual Test
+    (entry point)
+
+    For help type:
+      poetry run manual-test-run --help
+'''
+import logging
+
+from minishell.cmd import Cmd
+from minishell import logger
+
+log = logger.stdout(
+    __name__,
+    logging.DEBUG
+)
+
+def main():
+    '''
+        main
+    '''
+    Cmd.date()
+    Cmd.uname("-s")
+    Cmd.ipconfig.getifaddr.en0()
+    Cmd().ls(
+        "-l",
+        "tests/integration/ls_test_dir/file"
+    )
+    Cmd().cat(
+        "tests/integration/ls_test_dir/file"
+    )
+
+    stdout, _ = Cmd().ipconfig.getifaddr.en0()
+    print("My IP Address is: ", stdout)