Merge pull request #70 from britive/develop

v1.2.1

Author: twratl

.gitignore

@@ -10,6 +10,7 @@ testing-variables.txt
 .DS_Store
 site/
 lock-test.py
+test.py
 
 # C extensions
 *.so

CHANGELOG.md

@@ -2,6 +2,22 @@
 
 All changes to the package starting with v0.3.1 will be logged here.
 
+## v1.2.1 [2023-03-14]
+#### What's New
+* None
+
+#### Enhancements
+* None
+
+#### Bug Fixes
+* `api` command shell completion fixed - dynamic sourcing of `method` values and options from the Britive Python SDK.
+
+#### Dependencies
+* `britive>=2.17.0`
+
+#### Other
+* None
+
 ## v1.2.0 [2023-03-03]
 #### What's New
 * Support for Azure Managed Identities as federation providers.

requirements.txt

@@ -1,4 +1,4 @@
-britive>=2.16.0
+britive>=2.17.0
 certifi>=2022.12.7
 charset-normalizer==2.1.0
 click==8.1.3
@@ -11,7 +11,7 @@ tabulate==0.8.10
 toml==0.10.2
 urllib3==1.26.9
 cryptography~=39.0.1
-pytest==7.1.2
+pytest
 mkdocs==1.3.1
 mkdocs-click==0.8.0
 twine~=4.0.1

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = pybritive
-version = 1.2.0
+version = 1.2.1
 author = Britive Inc.
 author_email = support@britive.com
 description = A pure Python CLI for Britive
@@ -26,7 +26,7 @@ install_requires =
     toml
     cryptography~=39.0.1
     python-dateutil
-    britive>=2.16.0
+    britive>=2.17.0
     jmespath
     pyjwt
 

src/pybritive/commands/api.py

@@ -1,6 +1,14 @@
 import click
+from click import Command
 from ..helpers.build_britive import build_britive
 from ..options.britive_options import britive_options
+from ..completers.api_command import command_api_patch_shell_complete
+from ..helpers.api_method_argument_dectorator import click_smart_api_method_argument
+
+
+# this holds all the click version logic to gracefully degrade functionality
+# depending on the click version
+command_api_patch_shell_complete(Command)
 
 
 @click.command(
@@ -11,7 +19,7 @@
 )
 @build_britive
 @britive_options(names='query,output_format,tenant,token,passphrase,federation_provider')
-@click.argument('method')
+@click_smart_api_method_argument  # need to gracefully handle older version of click
 def api(ctx, query, output_format, tenant, token, passphrase, federation_provider, method):
     """Exposes the Britive Python SDK methods to the CLI.
 

src/pybritive/completers/api.py

@@ -0,0 +1,32 @@
+from britive.britive import Britive
+import json
+
+
+def api_completer(ctx, param, incomplete):
+    # create an instance of the Britive class, so we can inspect it
+    # this doesn't need to actually connect to any tenant, and we couldn't even if we
+    # wanted to since when performing shell completion we have no tenant/token
+    # context in order to properly establish a connection.
+    b = Britive(token='ignore', tenant='britive.com', query_features=False)
+
+    # parse the incomplete command, so we can determine where in the "hierarchy" we are
+    # and what commands/subcommands the user should be presented with
+    parts = incomplete.split('.')[:-1]
+    not_base_level = len(parts) > 0
+    for part in parts:
+        b = getattr(b, part)
+
+    options = []
+
+    # vars happen at all levels
+    options += [var for var, value in vars(b).items() if str(value).startswith('<britive.') and var != 'britive']
+
+    # dir only happens at non "base" levels
+    if not_base_level:
+        options += [func for func in dir(b) if callable(getattr(b, func)) and not func.startswith("_")]
+
+    # pull it all back together and make it look nice
+    existing = '.'.join(parts)
+    options = [f'{existing}.{o}' if not_base_level else o for o in options]
+
+    return [o for o in options if o.lower().startswith(incomplete.lower())]

src/pybritive/completers/api_command.py

@@ -0,0 +1,139 @@
+import typing as t
+import inspect
+from britive.britive import Britive
+import pkg_resources
+
+
+def get_dynamic_method_parameters(method):
+    try:
+        # create an instance of the Britive class, so we can inspect it
+        # this doesn't need to actually connect to any tenant, and we couldn't even if we
+        # wanted to since when performing shell completion we have no tenant/token
+        # context in order to properly establish a connection.
+        b = Britive(token='ignore', tenant='britive.com', query_features=False)
+
+        # parse the method, so we can determine where in the "hierarchy" we are
+        # and what commands/subcommands the user should be presented with
+        for part in method.split('.'):
+            b = getattr(b, part)
+
+        params = {}
+        spec = inspect.getfullargspec(b)
+
+        # reformat parameters into a more consumable dict while holds all the required details
+        helper = spec[6]
+        helper.pop('return', None)
+        for param, param_type in helper.items():
+            params[param] = {
+                'type': str(param_type).split("'")[1]
+            }
+
+        defaults = list(spec[3])
+        names = list(spec[0])
+
+        if len(defaults) > 0:
+            for i in range(1, len(defaults) + 1):
+                name = names[-1 * i]
+                default = defaults[-1 * i]
+                params[name]['default'] = default
+
+        try:  # we don't REALLY need the doc string so if there are errors just eat them and move on
+            doc_lines = inspect.getdoc(b)
+            doc_lines = doc_lines.replace(':returns:', 'RETURNSPLIT')
+            doc_lines = doc_lines.replace(':return:', 'RETURNSPLIT')
+            doc_lines = doc_lines.split('RETURNSPLIT')[0].split(':param ')[1:]
+
+            for line in doc_lines:
+                helper = line.split(':')
+                name = helper[0].strip()
+                help_text = ''.join(helper[1].strip().splitlines()).replace('    ', ' ')
+                params[name]['help'] = help_text
+        except:
+            pass
+
+        param_list = []
+
+        for name, values in params.items():
+            help_text = values.get('help') or ''
+
+            if 'default' in values.keys():  # cannot do a .get('default') as the default value could be False/None/etc.
+                preamble = f'[optional: default = {values["default"]}]'
+                if help_text == '':
+                    help_text = preamble
+                else:
+                    help_text = f'{preamble} - {help_text}'
+
+            param = {
+                'flag': f'--{name.replace("_", "-")}',
+                'help': help_text
+            }
+
+            param_list.append(param)
+
+        return param_list
+    except Exception as e:
+        return []
+
+
+def command_api_patch_shell_complete(cls):
+    # click < 8.0.0 does shell completion different...
+    # not all the classes/decorators are available, so we cannot
+    # create custom shell completions like we can with click > 8.0.0
+    major, minor, patch = pkg_resources.get_distribution('click').version.split('.')[0:3]
+
+    # we cannot patch the shell_complete method because it does not exist (click 7.x doesn't have it)
+    # future proofing this as well in case click 9.x changes things up a lot
+    if int(major) != 8:
+        return
+
+    # we could potentially patch but there could be changes to shell_complete method which are not
+    # accounted for in this patch - we will have to manually review any changes and ensure they are
+    # backwards compatible.
+    if int(minor) != 1:
+        return
+
+    from click.shell_completion import CompletionItem
+    from click.core import ParameterSource
+    from click import Context, Option
+
+    # https://stackoverflow.com/questions/43778914/python3-using-super-in-eq-methods-raises-runtimeerror-super-class
+    __class__ = cls  # provide closure cell for super()
+
+    def shell_complete(self, ctx: Context, incomplete: str) -> t.List["CompletionItem"]:
+        from click.shell_completion import CompletionItem
+
+        results: t.List["CompletionItem"] = []
+
+        if incomplete and not incomplete[0].isalnum():
+            method = ctx.params.get('method')
+            if method:
+                dynamic_params = get_dynamic_method_parameters(method)
+
+                results.extend(
+                    CompletionItem(p['flag'], help=p['help'])
+                    for p in dynamic_params if p['flag'].startswith(incomplete)
+                )
+
+            for param in self.get_params(ctx):
+                if (
+                    not isinstance(param, Option)
+                    or param.hidden
+                    or (
+                        not param.multiple
+                        and ctx.get_parameter_source(param.name)  # type: ignore
+                        is ParameterSource.COMMANDLINE
+                    )
+                ):
+                    continue
+
+                results.extend(
+                    CompletionItem(name, help=param.help)
+                    for name in [*param.opts, *param.secondary_opts]
+                    if name.startswith(incomplete)
+                )
+
+        results.extend(super().shell_complete(ctx, incomplete))
+
+        return results
+
+    cls.shell_complete = shell_complete

src/pybritive/helpers/api_method_argument_dectorator.py

@@ -0,0 +1,15 @@
+import click
+import pkg_resources
+from ..completers.api import api_completer
+
+click_major_version = int(pkg_resources.get_distribution('click').version.split('.')[0])
+
+
+def click_smart_api_method_argument(func):
+    if click_major_version >= 8:
+        dec = click.argument('method', shell_complete=api_completer)
+    else:
+        dec = click.argument('method')
+    return dec(func)
+
+