argumentor-gardehal 0.0.0__tar.gz

argumentor_gardehal-0.0.0/.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

argumentor_gardehal-0.0.0/.github/workflows/publish.yml

@@ -0,0 +1,60 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published] 
+  workflow_dispatch: 
+
+permissions:
+  contents: read
+  id-token: write  
+
+jobs:
+  build:
+    name: Build Argumentor ${{github.ref_name}}
+    runs-on: ubuntu-latest
+    outputs:
+      version: ${{steps.get_version.outputs.version}}
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0  
+          persist-credentials: false
+          
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.x"
+          
+      - name: Install build dependencies
+        run: python -m pip install --upgrade build setuptools_scm twine
+
+      - name: Build distributions
+        run: python -m build
+
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: argumentor
+          path: dist/
+          
+      - name: List built files
+        run: ls -la dist/
+
+  publish:
+    name: Publish to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/project/argumentor-gardehal/
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: argumentor
+          path: dist/
+          
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

argumentor_gardehal-0.0.0/.gitignore

@@ -0,0 +1,183 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor  
+#  Cursor is an AI-powered code editor.`.cursorignore` specifies files/directories to 
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+Main.py

argumentor_gardehal-0.0.0/.vscode/settings.json

@@ -0,0 +1,13 @@
+{
+    "cSpell.words": [
+        "Argumentor",
+        "HITVALUE",
+        "ints",
+        "nosuchflag",
+        "someargument",
+        "somecommand",
+        "someflag",
+        "someprefix",
+        "updateexternal"
+    ]
+}

argumentor_gardehal-0.0.0/Argumentor/Argument.py

@@ -0,0 +1,72 @@
+import re
+
+from typing import TypeVar, Type, Callable
+
+T = TypeVar("T")
+
+class Argument():
+    name: str
+    alias: list[str]
+    typeT: Type[T]
+    optional: bool
+    castFunc: Callable[[str], T]
+    validateFunc: Callable[[T], bool]
+    useDefaultValue: bool
+    defaultValue: T
+    description: str
+    
+    def __init__(self, name: str, 
+        alias: list[str],
+        typeT: Type[T], 
+        optional: bool = False, 
+        castFunc: Callable[[str], T] = None, 
+        validateFunc: Callable[[T], bool] = None, 
+        useDefaultValue: bool = False, 
+        defaultValue: T = None, 
+        description: str = None):
+        """
+        Designates values input as arguments after commands 
+        eg. height in 
+        $ -dimensions height:100
+
+        Args:
+            name (str): Name of argument, key for dictionary in Return
+            alias (list[str]): Alias of argument.
+            typeT (Type[T]): Type of argument, str, int, bool, enum, etc.
+            optional (bool, optional): Argument is optional/nullable (from input). Defaults to False. Note that this implies the argument can be None in result, unless useDefaultValue and defaultValue are both set.
+            castFunc (Callable[[str], T], optional): Optional function for custom casting of input to typeT. Must take in 1 argument: str and return typeT. Defaults to None.
+            validateFunc (Callable[[T], bool], optional): Optional function for custom validation. Must take in 1 argument: typeT and return bool. Defaults to None.
+            useDefaultValue (bool, optional): Use a default value if casting and validation fails. Defaults to False.
+            defaultValue (T, optional): The default value to use if casting and validation fails, and useDefaultValue is True. Must be typeT. Defaults to None.
+            description (str, optional): Explaining what the argument is for. Defaults to None.
+        """
+        
+        invalidCharactersRegex = r"\W"
+        invalidNames = [e for e in alias + [name] if (re.search(invalidCharactersRegex, e))]
+        if(invalidNames):
+            raise AttributeError(f"Argument \"{name}\" name or alias ({invalidNames}) contain invalid characters, must be alphanumeric.")
+        
+        self.name = name
+        self.alias = alias
+        self.typeT = typeT
+        self.optional = optional
+        self.castFunc = castFunc
+        self.validateFunc = validateFunc
+        self.useDefaultValue = useDefaultValue
+        self.defaultValue = defaultValue
+        self.description = description
+                
+    def getFormattedDescription(self) -> str:
+        """
+        Get the description of arguments with formatting.
+
+        Returns:
+            str: String description.
+        """
+        
+        optionalDisplayString = "optional" if self.optional else "required"
+        typeDisplayString = f", type: {self.typeT.__name__}"
+        aliasDisplayString = f", alias: {", ".join(self.alias)}" if self.alias else ""
+        defaultDisplayString = f", default: {str(self.defaultValue)}" if self.useDefaultValue else ""
+        return f"* Argument {self.name} ({optionalDisplayString}{typeDisplayString}{defaultDisplayString}{aliasDisplayString}): \
+            \n\t{self.description}"

argumentor_gardehal-0.0.0/Argumentor/ArgumentValidation.py

@@ -0,0 +1,225 @@
+from .Argument import Argument
+from .Command import Command
+from .Flag import Flag
+
+import re
+
+class ArgumentValidation():
+    isValid: bool
+    namedArguments: dict[str, str]
+    validatedArguments: dict[str, str]
+    finalizedArguments: dict[str, object]
+    messages: list[str]
+    
+    namedInputRegex: str
+    flagInputRegex: str
+
+    def __init__(self, inputList: list[str], command: Command, namedArgDelim: str, flagPrefix: str):
+        """
+        Internal validation in Argumentor.
+
+        Args:
+            inputList (list[str]): List of inputs from user
+            command (Command): Command to validate input against
+            namedArgDelim (str): Delimiter used for named input, e.g. ":" in key:value
+            flagPrefix (str): Prefix for flags, e.g. "--updateexternal".
+        """
+        
+        self.isValid = False
+        self.namedArguments = {}
+        self.validatedArguments = {}
+        self.finalizedArguments = {}
+        self.messages = []
+
+        self.namedInputRegex = fr"^\w+{namedArgDelim}\S+"
+        self.flagInputRegex = fr"^{flagPrefix}\w+"
+
+        if(command.arguments):
+            self.__populateNamedArguments(inputList, namedArgDelim)
+            self.__validateNamedArguments(command.arguments)
+            self.__addPositionalArguments(inputList, command)
+            self.__castAndValidateArguments(command)
+        else:
+            self.isValid = True
+
+        if(command.flags):
+            self.__addFlags(inputList, flagPrefix, command.flags)
+        
+    def toString(self) -> str:
+        """
+        Returns string with class properties.
+
+        Returns: 
+            str: String of class properties.
+        """
+
+        return f""" \
+            isValid: {self.isValid},
+            namedArguments: {self.namedArguments},
+            validatedArguments: {self.validatedArguments},
+            finalizedArguments: {self.finalizedArguments},
+            messages: {self.messages},
+            """
+    
+    def __populateNamedArguments(self, inputList: list[str], namedArgDelim: str):
+        namedInputs = [e for e in inputList if(namedArgDelim in e)]
+        namedArguments = {}
+        for input in namedInputs:
+            namedSplit = input.split(namedArgDelim)
+            key = namedSplit[0]
+            value = namedArgDelim.join(namedSplit[1:])
+            namedArguments[key] = value
+            
+        self.namedArguments = namedArguments
+    
+    def __validateNamedArguments(self, arguments: list[Argument]):
+        argumentAliasMap = {}
+        for argument in arguments:
+            argumentAliasMap[argument.name] = argument.name
+            for alias in argument.alias:
+                argumentAliasMap[alias] = argument.name
+            
+        for key in self.namedArguments.keys():
+            if(key not in argumentAliasMap.keys()):
+                self.messages.append(self.__formatArgumentError(key, "Not a valid argument alias"))
+                continue
+            
+            if(key in self.validatedArguments.keys()):
+                self.messages.append(self.__formatArgumentError(key, "Alias was already added"))
+                continue
+            
+            self.validatedArguments[argumentAliasMap[key]] = self.namedArguments[key]
+    
+    def __addPositionalArguments(self, inputList: list[str], command: Command):
+        unnamedInput = [e for e in inputList if(not re.search(self.namedInputRegex, e) and not re.search(self.flagInputRegex, e))]
+        remainingArgument = [e for e in command.arguments if(e.name not in self.validatedArguments.keys())]
+
+        for i in range(len(unnamedInput)):
+            if(i >= len(remainingArgument)):
+                self.messages.append(f"Received more positional arguments ({len(unnamedInput)}) than expected ({len(remainingArgument)})")
+                for extraArg in unnamedInput[i:]:
+                    self.messages.append(f"{extraArg} not added, exceeds expected Arguments length")
+                    
+                break # unnamedInput loop
+            
+            unnamedArg = unnamedInput[i]
+            positionalArg = remainingArgument[i]
+            if(positionalArg.name in self.validatedArguments.keys()):
+                self.messages.append(self.__formatArgumentError(positionalArg.name, f"Already added as named argument {unnamedArg}"))
+                continue
+            
+            self.validatedArguments[positionalArg.name] = unnamedArg
+            
+    def __castAndValidateArguments(self, command: Command):
+        inputIsValid = True
+        
+        # Adding optional arguments not in input
+        # TODO new method?
+        for argument in command.arguments:
+            if(argument.optional and argument.name not in self.validatedArguments):
+                self.validatedArguments[argument.name] = None
+        
+        for key in self.validatedArguments.keys():
+            argument = [e for e in command.arguments if e.name is key][0]
+            if(argument is None):
+                self.messages.append(self.__formatArgumentError(key, "Critical error! No Argument object found"))
+                inputIsValid = False
+                continue
+            
+            value = self.validatedArguments[key]
+            if(value is None):
+                if(argument.useDefaultValue):
+                    self.messages.append(self.__formatArgumentError(key, f"Value was None and not optional, default value {argument.defaultValue} was applied"))
+                    castValue = argument.defaultValue
+                    continue
+                elif(argument.optional):
+                    self.finalizedArguments[key] = None
+                    continue
+                else:
+                    self.messages.append(self.__formatArgumentError(key, f"Critical error! Value was None, and Argument is not optional"))
+                    inputIsValid = False
+                    continue
+            
+            castSuccess = False
+            castValue = None
+            try:
+                if(argument.castFunc):
+                    castValue = argument.castFunc(value)
+                else:
+                    castValue = (argument.typeT)(value)
+                
+                if(castValue is None and not argument.optional):
+                    if(argument.useDefaultValue):
+                        self.messages.append(self.__formatArgumentError(key, f"Value was None but argument was not optional, default value {argument.defaultValue} was applied"))
+                        castValue = argument.defaultValue
+                        continue
+                    else:
+                        self.messages.append(self.__formatArgumentError(key, f"Critical error! Value was None, not optional, and no default was given")) # Remember useDefaultValue
+                        inputIsValid = False
+                        continue
+                
+                castSuccess = True
+            except Exception as ex:
+                if(argument.useDefaultValue):
+                    self.messages.append(self.__formatArgumentError(key, f"{value} could not be cast, default value {argument.defaultValue} was applied"))
+                    castValue = argument.defaultValue
+                    continue
+                else:
+                    self.messages.append(self.__formatArgumentError(key, f"Critical error! {value} could not be cast to {argument.typeT.__name__}")) 
+                    inputIsValid = False
+                    continue
+        
+            if(castSuccess and argument.validateFunc):
+                try: 
+                    resultValid = argument.validateFunc(castValue)
+                    if(not resultValid):
+                        if(argument.useDefaultValue):
+                            self.messages.append(self.__formatArgumentError(key, f"{value} did not pass validation, default value {argument.defaultValue} was applied"))
+                            castValue = argument.defaultValue
+                            continue
+                        else:
+                            self.messages.append(self.__formatArgumentError(key, f"Critical error! {value} did not pass validation"))
+                            inputIsValid = False
+                            continue
+                except Exception as ex:
+                    if(argument.useDefaultValue):
+                        self.messages.append(self.__formatArgumentError(key, f"{value} validation raised an exception, default value {argument.defaultValue} was applied"))
+                        castValue = argument.defaultValue
+                        continue
+                    else:
+                        self.messages.append(self.__formatArgumentError(key, f"Critical error! {value} validation raised an exception and no defaults were given"))
+                        inputIsValid = False
+                        continue
+        
+            self.finalizedArguments[key] = castValue
+            
+        requiredArgumentNames = [e.name for e in command.arguments if not e.optional]
+        if(len(self.finalizedArguments.keys())) < len(requiredArgumentNames):
+            self.messages.append(f"Critical error! Required arguments are missing (got {len(self.finalizedArguments.keys())}/{len(requiredArgumentNames)})")
+            inputIsValid = False
+        
+        if(inputIsValid):
+            for argument in command.arguments:
+                if(argument.name not in self.finalizedArguments.keys() and argument.useDefaultValue):
+                    self.finalizedArguments[argument.name] = argument.defaultValue
+        
+        self.isValid = inputIsValid
+    
+    def __addFlags(self, inputList: list[str], flagPrefix: str, flags: list[Flag]):
+        flagInputs = [e.removeprefix(flagPrefix) for e in inputList if(re.search(self.flagInputRegex, e))]
+        for flag in flags:
+            intersections = list(set(flagInputs) & set(flag.alias + [flag.name]))
+            if(intersections):
+                self.finalizedArguments[flag.name] = flag.value
+                for intersection in intersections:
+                    flagInputs.remove(intersection)
+            else:
+                self.finalizedArguments[flag.name] = flag.defaultValue
+        
+        if(flagInputs):
+            self.messages.append(self.__formatArgumentError(", ".join(flagInputs), f"No such flag(s)"))
+    
+    def __formatArgumentError(self, arg: str, error: str) -> str:
+        return f"{arg} error: {error}"
+    
+