tracim.command

Complexity

Total Complexity

16

Size/Duplication

Total Lines	105
Duplicated Lines	0 %

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	TracimCLI.prepare_to_run_command()	0	2	1
A	TracimCLI.initialize_app()	0	2	1
A	Extender.__call__()	0	15	4
A	TracimCLI.__init__()	0	6	1
A	TracimCLI.clean_up()	0	4	2
A	AppContextCommand.take_action()	0	6	4
A	TestTracimCommand.take_app_action()	0	6	1
A	AppContextCommand.get_parser()	0	11	1

# -*- coding: utf-8 -*-

This module should have a docstring.

There seems to be a cyclic import (tracim.models.auth -> tracim.models.data).

There seems to be a cyclic import (tracim.models.data -> tracim.models.revision_protection).

import sys
import argparse
import transaction

from cliff.app import App
from cliff.command import Command
from cliff.commandmanager import CommandManager

from pyramid.paster import bootstrap
from pyramid.scripting import AppEnvironment
from tracim.exceptions import CommandAbortedError


class TracimCLI(App):

This class should have a docstring.

The variable __class__ seems to be unused.

    def __init__(self) -> None:
        super(TracimCLI, self).__init__(
            description='TracimCli',
            version='0.1',
            command_manager=CommandManager('tracimcli'),
            deferred_help=True,
            )

    def initialize_app(self, argv) -> None:
        self.LOG.debug('initialize_app')

    def prepare_to_run_command(self, cmd) -> None:
        self.LOG.debug('prepare_to_run_command %s', cmd.__class__.__name__)

    def clean_up(self, cmd, result, err) -> None:
        self.LOG.debug('clean_up %s', cmd.__class__.__name__)
        if err:
            self.LOG.debug('got an error: %s', err)


def main(argv=sys.argv[1:]):

The default value sys.argv[1:] (builtins.list) might cause unintended side-effects.

This function should have a docstring.

    myapp = TracimCLI()
    return myapp.run(argv)


if __name__ == "__main__":
    main()


class AppContextCommand(Command):

The variable __class__ seems to be unused.

    """
    Command who initialize app context at beginning of take_action method.
    """
    auto_setup_context = True

    def take_action(self, parsed_args: argparse.Namespace) -> None:

The variable argparse does not seem to be defined.

        super(AppContextCommand, self).take_action(parsed_args)
        if self.auto_setup_context:
            with bootstrap(parsed_args.config_file) as app_context:
                with app_context['request'].tm:
                    self.take_app_action(parsed_args, app_context)

The Instance of AppContextCommand does not seem to have a member named take_app_action.

    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
        parser = super(AppContextCommand, self).get_parser(prog_name)

        parser.add_argument(
            "-c",
            "--config",
            help='application config file to read (default: development.ini)',
            dest='config_file',
            default="development.ini"
        )
        return parser

    # def run(self, parsed_args):
    #     super().run(parsed_args)
    #     transaction.commit()


# TODO - G.M - 10-04-2018 - [Cleanup][tempExample] - Drop this

TODO and FIXME comments should generally be avoided.

class TestTracimCommand(AppContextCommand):

This class should have a docstring.

The variable __class__ seems to be unused.

    def take_app_action(

This method should have a docstring.

This method could be written as a function/class method.

            self,
            parser: argparse.ArgumentParser,

The variable argparse does not seem to be defined.

The argument parser seems to be unused.

            app_context: AppEnvironment

The argument app_context seems to be unused.

    ) -> None:
        print('test')


class Extender(argparse.Action):

The variable __class__ seems to be unused.

    """
    Copied class from http://stackoverflow.com/a/12461237/801924
    """
    def __call__(self, parser, namespace, values, option_strings=None):
        # Need None here incase `argparse.SUPPRESS` was supplied for `dest`
        dest = getattr(namespace, self.dest, None)
        # print dest,self.default,values,option_strings
        if not hasattr(dest, 'extend') or dest == self.default:
            dest = []
            setattr(namespace, self.dest, dest)
            # if default isn't set to None, this method might be called
            # with the default as `values` for other arguements which
            # share this destination.
            parser.set_defaults(**{self.dest: None})
        try:
            dest.extend(values)
        except ValueError:
            dest.append(values)