impose-cli 0.0.0__tar.gz

impose-cli-0.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 samuel-chai-902
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

impose-cli-0.0.0/PKG-INFO

@@ -0,0 +1,11 @@
+Metadata-Version: 1.0
+Name: impose-cli
+Version: 0.0.0
+Summary: Create a CLI tool easily.
+Home-page: UNKNOWN
+Author: scdev
+Author-email: samuel.chai.development@gmail.com
+License: UNKNOWN
+Description: UNKNOWN
+Keywords: python,cli,click
+Platform: UNKNOWN

impose-cli-0.0.0/README.md

@@ -0,0 +1,9 @@
+# Impose CLI
+
+Impose CLI is a simple tool used to generate a CLI tool by using one decorator.
+
+### How to use
+Functions that are meant to be CLI commands should be decorator with @impose
+In the main method, the impose_cli(target=None)() method should be called.
+
+If target is None, then the commands will be from the same file. Otherwise, include the directory for your commands.

impose-cli-0.0.0/impose_cli/__init__.py

@@ -0,0 +1 @@
+from impose_cli.impose_cli import impose, impose_cli

impose-cli-0.0.0/impose_cli/impose_cli.py

@@ -0,0 +1,117 @@
+import ast
+import click
+from importlib.util import spec_from_file_location, module_from_spec
+from inspect import getframeinfo, currentframe
+from inspect import Parameter, signature as sig
+from os import listdir
+from os.path import exists, join, dirname, abspath
+
+
+def impose(func):
+    return func
+
+
+def expose(func: click.Group):
+    func()
+
+
+def impose_cli(target: [str, None] = None) -> None:
+    """
+    If target is a directory, then each file will be a group and all functions will be a command
+    If medium is a file, then there will be no group and all functions will be a command
+    :param target:
+    :return:
+    """
+
+    class ImposeFunctionVisitor(ast.NodeVisitor):
+        def __init__(self):
+            self.imposed_functions = []
+
+        def visit_FunctionDef(self, node):
+            if hasattr(node, 'decorator_list'):
+                for decorator in node.decorator_list:
+                    if isinstance(decorator, ast.Name) and decorator.id == 'impose':
+                        self.imposed_functions.append(node.name)
+
+    def find_imposed_functions(filename):
+        with open(filename, 'r') as file:
+            file_contents = file.read()
+        module = ast.parse(file_contents)
+        visitor = ImposeFunctionVisitor()
+        visitor.visit(module)
+        return visitor.imposed_functions
+
+    def find_files(origin, target):
+        if target is None:
+            return [origin]
+
+        else:
+            directory = join(dirname(origin), target)
+            if not exists(directory):
+                raise FileNotFoundError(f"There is no directory {directory}.")
+
+            dirs = [x for x in listdir(directory) if x.endswith('.py')]
+            return [abspath(join(directory, f)) for f in dirs]
+
+    def load_module_from_file(file_path, module_name):
+        spec = spec_from_file_location(module_name, file_path)
+        module = module_from_spec(spec)
+        spec.loader.exec_module(module)
+        return module
+
+    def analyze_functions(module, function):
+        signature = sig(getattr(module, function))
+        parameters = signature.parameters
+        args_with_defaults = [[p.name, p.default, p.annotation if p.annotation.__name__ != '_empty' else None] for p in parameters.values() if p.default != Parameter.empty]
+        args_without_defaults = [[p.name, p.annotation if p.annotation.__name__ != '_empty' else None] for p in parameters.values() if p.default == Parameter.empty and p.default is not None]
+        return args_without_defaults, args_with_defaults
+
+    def create_dynamic_group(group_name, command_list):
+        dynamic_group = click.Group(name=group_name)
+
+        for cmd in command_list:
+            dynamic_command = click.Command(name=cmd['name'].replace('_', '-'), callback=cmd['callback'])
+
+            for arg in cmd['arguments']:
+                arg_name = arg[0].replace('_', '-')
+                if arg[1] is not None:
+                    dynamic_command.params.append(click.Argument((arg_name,), type=arg[1]))
+                else:
+                    dynamic_command.params.append(click.Argument((arg_name,)))
+
+            for opt in cmd['options']:
+                opt_name = opt[0].replace('_', '-')
+                if opt[2] is not None:
+                    dynamic_command.params.append(click.Option((f"--{opt_name}",), default=opt[1], type=opt[2]))
+                else:
+                    dynamic_command.params.append(click.Option((f"--{opt_name}",), default=opt[2]))
+
+            dynamic_group.add_command(dynamic_command)
+
+        return dynamic_group
+
+    origin_files = find_files(getframeinfo(currentframe().f_back)[0], target)
+
+    meta = {}
+    for origin_file in origin_files:
+        module_name = origin_file.split('/')[-1].replace('.py', '')
+        meta[module_name] = []
+        module = load_module_from_file(origin_file, module_name)
+        functions = find_imposed_functions(origin_file)
+        for function in functions:
+            args, opts = analyze_functions(module, function)
+            meta[module_name].append({
+                "name": function,
+                "arguments": args,
+                "options": opts,
+                "callback": getattr(module, function)
+            })
+
+    if target is not None:
+        main_group = create_dynamic_group('cli', [])
+        keys = meta.keys()
+        for key in keys:
+            main_group.add_command(create_dynamic_group(key, meta[key]))
+        return main_group
+    else:
+        return create_dynamic_group('cli', meta[list(meta.keys())[0]])

impose-cli-0.0.0/impose_cli.egg-info/PKG-INFO

@@ -0,0 +1,11 @@
+Metadata-Version: 1.0
+Name: impose-cli
+Version: 0.0.0
+Summary: Create a CLI tool easily.
+Home-page: UNKNOWN
+Author: scdev
+Author-email: samuel.chai.development@gmail.com
+License: UNKNOWN
+Description: UNKNOWN
+Keywords: python,cli,click
+Platform: UNKNOWN

impose-cli-0.0.0/impose_cli.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+LICENSE
+README.md
+setup.py
+impose_cli/__init__.py
+impose_cli/impose_cli.py
+impose_cli.egg-info/PKG-INFO
+impose_cli.egg-info/SOURCES.txt
+impose_cli.egg-info/dependency_links.txt
+impose_cli.egg-info/requires.txt
+impose_cli.egg-info/top_level.txt
+tests/__init__.py
+tests/test.py

impose-cli-0.0.0/impose_cli.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

impose-cli-0.0.0/impose_cli.egg-info/requires.txt

@@ -0,0 +1 @@
+click

impose-cli-0.0.0/impose_cli.egg-info/top_level.txt

@@ -0,0 +1,2 @@
+impose_cli
+tests

impose-cli-0.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

impose-cli-0.0.0/setup.py

@@ -0,0 +1,26 @@
+from subprocess import run, CalledProcessError
+from setuptools import setup, find_packages
+
+
+def get_version():
+    output = run('git describe --tags', capture_output=True, shell=True).stdout.decode('utf-8')
+    return ''.join(filter(lambda x: x.isdigit() or x == '.', list(output)))
+
+
+with open('requirements.txt') as f:
+    requirements = f.read().splitlines()
+
+VERSION = get_version()
+DESCRIPTION = 'Create a CLI tool easily.'
+
+# Setting up
+setup(
+    name="impose-cli",
+    version=VERSION,
+    author="scdev",
+    author_email="samuel.chai.development@gmail.com",
+    description=DESCRIPTION,
+    packages=find_packages(),
+    install_requires=requirements,
+    keywords=['python', 'cli', 'click'],
+)

impose-cli-0.0.0/tests/test.py

@@ -0,0 +1,35 @@
+import pytest
+from impose_cli.impose_cli import impose, impose_cli
+
+
+@impose
+def function_without_arguments():
+    return True
+
+
+@impose
+def function_with_arguments(arg1, arg2):
+    return True
+
+
+@impose
+def function_with_arguments_with_defaults(arg1: str = 'yes'):
+    return arg1
+
+
+def testing_correct_argument_parsing():
+    commands = impose_cli().commands
+    assert len(commands['function-without-arguments'].params) == 0
+    assert len(commands['function-with-arguments'].params) == 2
+    assert commands['function-with-arguments'].params[0].opts == ['arg1']
+    assert commands['function-with-arguments'].params[0].type.name == 'text'
+    assert len(commands['function-with-arguments-with-defaults'].params) == 1
+    assert commands['function-with-arguments-with-defaults'].params[0].required == False
+    assert commands['function-with-arguments-with-defaults'].params[0].default == 'yes'
+    assert commands['function-with-arguments-with-defaults'].params[0].opts == ['--arg1']
+
+
+def testing_impose_decorator():
+    assert function_without_arguments() == True
+    assert function_with_arguments(None, None) == True
+    assert function_with_arguments_with_defaults('str') == 'str'