clarifai 11.3.0rc1__py3-none-any.whl → 11.3.0rc3__py3-none-any.whl

clarifai/__init__.py

@@ -1 +1 @@
-__version__ = "11.3.0rc1"
+__version__ = "11.3.0rc3"

clarifai/cli/__main__.py

@@ -1,4 +1,4 @@
 from clarifai.cli.base import main
 
 if __name__ == "__main__":
-  main()
+    main()

clarifai/cli/base.py

@@ -1,5 +1,6 @@
 import json
 import os
+import shutil
 import sys
 
 import click
@@ -11,117 +12,135 @@ from clarifai.utils.constants import DEFAULT_CONFIG
 from clarifai.utils.logging import logger
 
 
-#@click.group(cls=CustomMultiGroup)
+# @click.group(cls=CustomMultiGroup)
 @click.group(cls=AliasedGroup)
 @click.option('--config', default=DEFAULT_CONFIG)
 @click.pass_context
 def cli(ctx, config):
-  """Clarifai CLI"""
-  ctx.ensure_object(dict)
-  if os.path.exists(config):
-    cfg = Config.from_yaml(filename=config)
-    ctx.obj = cfg
-  else:
-    cfg = Config(
-        filename=config,
-        current_context='default',
-        contexts={
-            'default':
-                Context(
+    """Clarifai CLI"""
+    ctx.ensure_object(dict)
+    if os.path.exists(config):
+        cfg = Config.from_yaml(filename=config)
+        ctx.obj = cfg
+    else:
+        cfg = Config(
+            filename=config,
+            current_context='default',
+            contexts={
+                'default': Context(
                     'default',
                     CLARIFAI_PAT=os.environ.get('CLARIFAI_PAT', ''),
                     CLARIFAI_USER_ID=os.environ.get('CLARIFAI_USER_ID', ''),
                     CLARIFAI_API_BASE=os.environ.get('CLARIFAI_API_BASE', 'api.clarifai.com'),
                 )
-        })
-    try:
-      cfg.to_yaml(config)
-    except Exception:
-      logger.warning("Could not write configuration to disk. Could be a read only file system.")
-    ctx.obj = cfg  # still have the default config even if couldn't write.
+            },
+        )
+        try:
+            cfg.to_yaml(config)
+        except Exception:
+            logger.warning(
+                "Could not write configuration to disk. Could be a read only file system."
+            )
+        ctx.obj = cfg  # still have the default config even if couldn't write.
 
 
 @cli.command()
 @click.argument('shell', type=click.Choice(['bash', 'zsh']))
 def shell_completion(shell):
-  """Shell completion script"""
-  os.system(f"_CLARIFAI_COMPLETE={shell}_source clarifai")
+    """Shell completion script"""
+    os.system(f"_CLARIFAI_COMPLETE={shell}_source clarifai")
 
 
-@cli.group(['cfg'], cls=AliasedGroup)
+@cli.group(
+    ['cfg'],
+    cls=AliasedGroup,
+    context_settings={'max_content_width': shutil.get_terminal_size().columns - 10},
+)
 def config():
-  """Manage CLI configuration"""
+    """Manage CLI configuration"""
 
 
 @config.command(['e'])
 @click.pass_context
 def edit(ctx):
-  """Edit the configuration file"""
-  os.system(f'{os.environ.get("EDITOR", "vi")} {ctx.obj.filename}')
+    """Edit the configuration file"""
+    os.system(f'{os.environ.get("EDITOR", "vi")} {ctx.obj.filename}')
 
 
 @config.command(['current'])
 @click.option('-o', '--output-format', default='name', type=click.Choice(['name', 'json', 'yaml']))
 @click.pass_context
 def current_context(ctx, output_format):
-  """Get the current context"""
-  if output_format == 'name':
-    print(ctx.obj.current_context)
-  else:
-    if output_format == 'json':
-      print(json.dumps(ctx.obj.contexts[ctx.obj.current_context].to_serializable_dict()))
+    """Get the current context"""
+    if output_format == 'name':
+        print(ctx.obj.current_context)
+    elif output_format == 'json':
+        print(json.dumps(ctx.obj.contexts[ctx.obj.current_context].to_serializable_dict()))
     else:
-      print(yaml.safe_dump(ctx.obj.contexts[ctx.obj.current_context].to_serializable_dict()))
+        print(yaml.safe_dump(ctx.obj.contexts[ctx.obj.current_context].to_serializable_dict()))
 
 
 @config.command(['list', 'ls'])
 @click.option(
-    '-o', '--output-format', default='wide', type=click.Choice(['wide', 'name', 'json', 'yaml']))
+    '-o', '--output-format', default='wide', type=click.Choice(['wide', 'name', 'json', 'yaml'])
+)
 @click.pass_context
 def get_contexts(ctx, output_format):
-  """Get all contexts"""
-  if output_format == 'wide':
-    formatter = TableFormatter(custom_columns={
-        '': lambda c: '*' if c.name == ctx.obj.current_context else '',
-        'NAME': lambda c: c.name,
-        'USER_ID': lambda c: c.user_id,
-        'API_BASE': lambda c: c.api_base,
-        'PAT': lambda c: pat_display(c.pat),
-    })
-    print(formatter.format(ctx.obj.contexts.values(), fmt="plain"))
-  elif output_format == 'name':
-    print('\n'.join(ctx.obj.contexts))
-  elif output_format in ('json', 'yaml'):
-    dicts = [v.__dict__ for c, v in ctx.obj.contexts.items()]
-    for d in dicts:
-      d.pop('pat')
-    if output_format == 'json':
-      print(json.dumps(dicts))
-    elif output_format == 'yaml':
-      print(yaml.safe_dump(dicts))
+    """Get all contexts"""
+    if output_format == 'wide':
+        columns = {
+            '': lambda c: '*' if c.name == ctx.obj.current_context else '',
+            'NAME': lambda c: c.name,
+            'USER_ID': lambda c: c.user_id,
+            'API_BASE': lambda c: c.api_base,
+            'PAT': lambda c: pat_display(c.pat),
+        }
+        additional_columns = set()
+        for cont in ctx.obj.contexts.values():
+            if 'env' in cont:
+                for key in cont.to_column_names():
+                    if key not in columns:
+                        additional_columns.add(key)
+        for key in sorted(additional_columns):
+            columns[key] = lambda c, k=key: getattr(c, k) if hasattr(c, k) else ""
+
+        formatter = TableFormatter(
+            custom_columns=columns,
+        )
+        print(formatter.format(ctx.obj.contexts.values(), fmt="plain"))
+    elif output_format == 'name':
+        print('\n'.join(ctx.obj.contexts))
+    elif output_format in ('json', 'yaml'):
+        dicts = [v.__dict__ for c, v in ctx.obj.contexts.items()]
+        for d in dicts:
+            d.pop('pat')
+        if output_format == 'json':
+            print(json.dumps(dicts))
+        elif output_format == 'yaml':
+            print(yaml.safe_dump(dicts))
 
 
 @config.command(['use'])
 @click.argument('context-name', type=str)
 @click.pass_context
 def use_context(ctx, context_name):
-  """Set the current context"""
-  if context_name not in ctx.obj.contexts:
-    raise click.UsageError('Context not found')
-  ctx.obj.current_context = context_name
-  ctx.obj.to_yaml()
-  print(f'Set {context_name} as the current context')
+    """Set the current context"""
+    if context_name not in ctx.obj.contexts:
+        raise click.UsageError('Context not found')
+    ctx.obj.current_context = context_name
+    ctx.obj.to_yaml()
+    print(f'Set {context_name} as the current context')
 
 
 @config.command(['cat'])
 @click.option('-o', '--output-format', default='yaml', type=click.Choice(['yaml', 'json']))
 @click.pass_obj
 def dump(ctx_obj, output_format):
-  """Dump the configuration to stdout"""
-  if output_format == 'yaml':
-    yaml.safe_dump(ctx_obj.to_dict(), sys.stdout)
-  else:
-    json.dump(ctx_obj.to_dict(), sys.stdout, indent=2)
+    """Dump the configuration to stdout"""
+    if output_format == 'yaml':
+        yaml.safe_dump(ctx_obj.to_dict(), sys.stdout)
+    else:
+        json.dump(ctx_obj.to_dict(), sys.stdout, indent=2)
 
 
 @cli.command()
@@ -129,56 +148,43 @@ def dump(ctx_obj, output_format):
 @click.option('--user_id', required=False, help='User ID')
 @click.pass_context
 def login(ctx, api_url, user_id):
-  """Login command to set PAT and other configurations."""
+    """Login command to set PAT and other configurations."""
 
-  name = input('context name (default: "default"): ')
-  user_id = user_id if user_id is not None else input('user id: ')
-  pat = input_or_default(
-      'personal access token value (default: "ENVVAR" to get our of env var rather than config): ',
-      'ENVVAR')
+    name = input('context name (default: "default"): ')
+    user_id = user_id if user_id is not None else input('user id: ')
+    pat = input_or_default(
+        'personal access token value (default: "ENVVAR" to get our of env var rather than config): ',
+        'ENVVAR',
+    )
 
-  context = Context(
-      name,
-      CLARIFAI_API_BASE=api_url,
-      CLARIFAI_USER_ID=user_id,
-      CLARIFAI_PAT=pat,
-  )
+    context = Context(
+        name,
+        CLARIFAI_API_BASE=api_url,
+        CLARIFAI_USER_ID=user_id,
+        CLARIFAI_PAT=pat,
+    )
 
-  if context.name == '':
-    context.name = 'default'
+    if context.name == '':
+        context.name = 'default'
 
-  ctx.obj.contexts[context.name] = context
-  ctx.obj.current_context = context.name
+    ctx.obj.contexts[context.name] = context
+    ctx.obj.current_context = context.name
 
-  ctx.obj.to_yaml()
+    ctx.obj.to_yaml()
 
 
 @cli.group(cls=AliasedGroup)
 def context():
-  """Manage contexts"""
+    """Manage contexts"""
 
 
 def pat_display(pat):
-  return pat[:5] + "****"
-
-
-@context.command(['ls'])
-@click.pass_context
-def list(ctx):
-  """List available contexts"""
-  formatter = TableFormatter(custom_columns={
-      '': lambda c: '*' if c.name == ctx.obj.current_context else '',
-      'NAME': lambda c: c.name,
-      'USER_ID': lambda c: c.user_id,
-      'API_BASE': lambda c: c.api_base,
-      'PAT': lambda c: pat_display(c.pat)
-  })
-  print(formatter.format(ctx.obj.contexts.values(), fmt="plain"))
+    return pat[:5] + "****"
 
 
 def input_or_default(prompt, default):
-  value = input(prompt)
-  return value if value else default
+    value = input(prompt)
+    return value if value else default
 
 
 @context.command()
@@ -194,23 +200,25 @@ def create(
     base_url=None,
     pat=None,
 ):
-  """Create a new context"""
-  if name in ctx.obj.contexts:
-    print(f'{name} already exists')
-    exit(1)
-  if not user_id:
-    user_id = input('user id: ')
-  if not base_url:
-    base_url = input_or_default('base url (default: https://api.clarifai.com): ',
-                                'https://api.clarifai.com')
-  if not pat:
-    pat = input_or_default(
-        'personal access token value (default: "ENVVAR" to get our of env var rather than config): ',
-        'ENVVAR')
-
-  context = Context(name, CLARIFAI_USER_ID=user_id, CLARIFAI_API_BASE=base_url, CLARIFAI_PAT=pat)
-  ctx.obj.contexts[context.name] = context
-  ctx.obj.to_yaml()
+    """Create a new context"""
+    if name in ctx.obj.contexts:
+        print(f'{name} already exists')
+        sys.exit(1)
+    if not user_id:
+        user_id = input('user id: ')
+    if not base_url:
+        base_url = input_or_default(
+            'base url (default: https://api.clarifai.com): ', 'https://api.clarifai.com'
+        )
+    if not pat:
+        pat = input_or_default(
+            'personal access token value (default: "ENVVAR" to get our of env var rather than config): ',
+            'ENVVAR',
+        )
+
+    context = Context(name, CLARIFAI_USER_ID=user_id, CLARIFAI_API_BASE=base_url, CLARIFAI_PAT=pat)
+    ctx.obj.contexts[context.name] = context
+    ctx.obj.to_yaml()
 
 
 # write a click command to delete a context
@@ -218,25 +226,25 @@ def create(
 @click.argument('name')
 @click.pass_context
 def delete(ctx, name):
-  """Delete a context"""
-  if name not in ctx.obj.contexts:
-    print(f'{name} is not a valid context')
-    exit(1)
-  ctx.obj.contexts.pop(name)
-  ctx.obj.to_yaml()
-  print(f'{name} deleted')
+    """Delete a context"""
+    if name not in ctx.obj.contexts:
+        print(f'{name} is not a valid context')
+        sys.exit(1)
+    ctx.obj.contexts.pop(name)
+    ctx.obj.to_yaml()
+    print(f'{name} deleted')
 
 
 @context.command()
 @click.argument('name', type=str)
 @click.pass_context
 def use(ctx, name):
-  """Set the current context"""
-  if name not in ctx.obj.contexts:
-    raise click.UsageError('Context not found')
-  ctx.obj.current_context = name
-  ctx.obj.to_yaml()
-  print(f'Set {name} as the current context')
+    """Set the current context"""
+    if name not in ctx.obj.contexts:
+        raise click.UsageError('Context not found')
+    ctx.obj.current_context = name
+    ctx.obj.to_yaml()
+    print(f'Set {name} as the current context')
 
 
 @cli.command()
@@ -244,12 +252,12 @@ def use(ctx, name):
 @click.option('--context', type=str, help='Context to use')
 @click.pass_context
 def run(ctx, script, context=None):
-  """Execute a script with the current context's environment"""
-  context = ctx.obj.current if not context else context
-  cmd = f'CLARIFAI_USER_ID={context.user_id} CLARIFAI_API_BASE={context.base_url} CLARIFAI_PAT={context.pat} '
-  cmd += ' '.join([f'{k}={v}' for k, v in context.env.items()])
-  cmd += f' {script}'
-  os.system(cmd)
+    """Execute a script with the current context's environment"""
+    context = ctx.obj.current if not context else context
+    cmd = f'CLARIFAI_USER_ID={context.user_id} CLARIFAI_API_BASE={context.base_url} CLARIFAI_PAT={context.pat} '
+    cmd += ' '.join([f'{k}={v}' for k, v in context.env.items()])
+    cmd += f' {script}'
+    os.system(cmd)
 
 
 # Import the CLI commands to register them
@@ -257,4 +265,4 @@ load_command_modules()
 
 
 def main():
-  cli()
+    cli()

clarifai/cli/compute_cluster.py

@@ -1,12 +1,18 @@
+import shutil
+
 import click
 
 from clarifai.cli.base import cli
 from clarifai.utils.cli import AliasedGroup, display_co_resources, validate_context
 
 
-@cli.group(['computecluster', 'cc'], cls=AliasedGroup)
+@cli.group(
+    ['computecluster', 'cc'],
+    cls=AliasedGroup,
+    context_settings={'max_content_width': shutil.get_terminal_size().columns - 10},
+)
 def computecluster():
-  """Manage Compute Clusters: create, delete, list"""
+    """Manage Compute Clusters: create, delete, list"""
 
 
 @computecluster.command(['c'])
@@ -15,18 +21,21 @@ def computecluster():
     '--config',
     type=click.Path(exists=True),
     required=True,
-    help='Path to the compute cluster config file.')
+    help='Path to the compute cluster config file.',
+)
 @click.pass_context
 def create(ctx, compute_cluster_id, config):
-  """Create a new Compute Cluster with the given config file."""
-  from clarifai.client.user import User
-  validate_context(ctx)
-  user = User(
-      user_id=ctx.obj.current.user_id, pat=ctx.obj.current.pat, base_url=ctx.obj.current.api_base)
-  if compute_cluster_id:
-    user.create_compute_cluster(config, compute_cluster_id=compute_cluster_id)
-  else:
-    user.create_compute_cluster(config)
+    """Create a new Compute Cluster with the given config file."""
+    from clarifai.client.user import User
+
+    validate_context(ctx)
+    user = User(
+        user_id=ctx.obj.current.user_id, pat=ctx.obj.current.pat, base_url=ctx.obj.current.api_base
+    )
+    if compute_cluster_id:
+        user.create_compute_cluster(config, compute_cluster_id=compute_cluster_id)
+    else:
+        user.create_compute_cluster(config)
 
 
 @computecluster.command(['ls'])
@@ -34,28 +43,33 @@ def create(ctx, compute_cluster_id, config):
 @click.option('--per_page', required=False, help='Number of items per page.', default=16)
 @click.pass_context
 def list(ctx, page_no, per_page):
-  """List all compute clusters for the user."""
-  from clarifai.client.user import User
-  validate_context(ctx)
-  user = User(
-      user_id=ctx.obj.current.user_id, pat=ctx.obj.current.pat, base_url=ctx.obj.current.api_base)
-  response = user.list_compute_clusters(page_no, per_page)
-  display_co_resources(
-      response,
-      custom_columns={
-          'ID': lambda c: c.id,
-          'USER_ID': lambda c: c.user_id,
-          'DESCRIPTION': lambda c: c.description,
-      })
+    """List all compute clusters for the user."""
+    from clarifai.client.user import User
+
+    validate_context(ctx)
+    user = User(
+        user_id=ctx.obj.current.user_id, pat=ctx.obj.current.pat, base_url=ctx.obj.current.api_base
+    )
+    response = user.list_compute_clusters(page_no, per_page)
+    display_co_resources(
+        response,
+        custom_columns={
+            'ID': lambda c: c.id,
+            'USER_ID': lambda c: c.user_id,
+            'DESCRIPTION': lambda c: c.description,
+        },
+    )
 
 
 @computecluster.command(['rm'])
 @click.argument('compute_cluster_id')
 @click.pass_context
 def delete(ctx, compute_cluster_id):
-  """Deletes a compute cluster for the user."""
-  from clarifai.client.user import User
-  validate_context(ctx)
-  user = User(
-      user_id=ctx.obj.current.user_id, pat=ctx.obj.current.pat, base_url=ctx.obj.current.api_base)
-  user.delete_compute_clusters([compute_cluster_id])
+    """Deletes a compute cluster for the user."""
+    from clarifai.client.user import User
+
+    validate_context(ctx)
+    user = User(
+        user_id=ctx.obj.current.user_id, pat=ctx.obj.current.pat, base_url=ctx.obj.current.api_base
+    )
+    user.delete_compute_clusters([compute_cluster_id])