From 9fbb12944cf3a5b9ff4f65054f3240ee8dd698df Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Norman=20J=C3=A4ckel?= Date: Wed, 24 Feb 2016 00:42:45 +0100 Subject: [PATCH] Updated start script help text and custom commands. Fixed #1987. --- openslides/__main__.py | 56 ++++++++++++++----- .../core/management/commands/backupdb.py | 20 ++++--- .../core/management/commands/runserver.py | 2 + .../management/commands/createsuperuser.py | 8 ++- 4 files changed, 62 insertions(+), 24 deletions(-) diff --git a/openslides/__main__.py b/openslides/__main__.py index ff9cc9fa8..7b7312c6b 100644 --- a/openslides/__main__.py +++ b/openslides/__main__.py @@ -51,12 +51,22 @@ def get_parser(): # Init parser description = 'Start script for OpenSlides.' if 'manage.py' not in sys.argv[0]: - description += (' If it is called without any argument, this will be ' - 'treated as if it is called with the "start" subcommand. ' - 'That means OpenSlides will setup default settings and ' - 'database, start the tornado webserver, launch the ' - 'default web browser and open the webinterface.') - parser = ExceptionArgumentParser(description=description) + description += """ + If it is called without any argument, this will be treated as + if it is called with the 'start' subcommand. That means + OpenSlides will setup default settings and database, start the + tornado webserver, launch the default web browser and open the + webinterface. + """ + epilog = """ + There are some more subcommands available. They belong to Django's + command-line utility for administrative tasks. Type '%(prog)s help' + (without the two hyphen-minus characters) to list them all. Type + '%(prog)s help ' for help on a specific subcommand. + """ + parser = ExceptionArgumentParser( + description=description, + epilog=epilog) # Add version argument parser.add_argument( @@ -71,14 +81,18 @@ def get_parser(): title='Available subcommands', description="Type '%s --help' for help on a " "specific subcommand." % parser.prog, - help='You can choose only one subcommand at once.') + help='You can choose only one subcommand at once.', + metavar='') # Subcommand start + start_help = ( + 'Setup settings and database, start tornado webserver, launch the ' + 'default web browser and open the webinterface. The environment ' + 'variable DJANGO_SETTINGS_MODULE is ignored.') subcommand_start = subparsers.add_parser( 'start', - help='Setup settings and database, start tornado webserver, launch the ' - 'default web browser and open the webinterface. The environment ' - 'variable DJANGO_SETTINGS_MODULE is ignored.') + description=start_help, + help=start_help) subcommand_start.add_argument( '--no-browser', action='store_true', @@ -92,12 +106,14 @@ def get_parser(): subcommand_start.add_argument( '--development', action='store_true', - help='Command for development purposes.') + help='Option for development purposes.') # Subcommand createsettings + createsettings_help = 'Creates the settings file.' subcommand_createsettings = subparsers.add_parser( 'createsettings', - help='Create the settings file.') + description=createsettings_help, + help=createsettings_help) subcommand_createsettings.set_defaults(callback=createsettings) subcommand_createsettings.add_argument( '--settings_path', @@ -107,7 +123,21 @@ def get_parser(): subcommand_createsettings.add_argument( '--development', action='store_true', - help='Command for development purposes.') + help='Option for development purposes.') + + # Help text for several Django subcommands + django_subcommands = ( + ('backupdb', 'Backups the SQLite3 database.'), + ('createsuperuser', 'Creates or resets the admin user.'), + ('migrate', 'Updates database schema.'), + ('runserver', 'Starts the Tornado webserver.'), + ) + for django_subcommand, help_text in django_subcommands: + subparsers._choices_actions.append( + subparsers._ChoicesPseudoAction( + django_subcommand, + (), + help_text)) return parser diff --git a/openslides/core/management/commands/backupdb.py b/openslides/core/management/commands/backupdb.py index a074965ec..87703d81b 100644 --- a/openslides/core/management/commands/backupdb.py +++ b/openslides/core/management/commands/backupdb.py @@ -1,21 +1,25 @@ import shutil -from optparse import make_option # TODO: Use argpase in Django 1.8 -from django.core.management.base import CommandError, NoArgsCommand +from django.core.management.base import BaseCommand, CommandError from django.db import connection, transaction from openslides.utils.main import get_database_path_from_settings -class Command(NoArgsCommand): +class Command(BaseCommand): """ - Commands to create or reset the adminuser + Command to backup the SQLite3 database. """ - option_list = NoArgsCommand.option_list + ( - make_option('--path', dest='path'), - ) + help = 'Backups the SQLite3 database.' - def handle_noargs(self, **options): + def add_arguments(self, parser): + parser.add_argument( + '--path', + default='database_backup.sqlite', + help='Path for the backup file (Default: database_backup.sqlite).' + ) + + def handle(self, *args, **options): path = options.get('path') @transaction.atomic diff --git a/openslides/core/management/commands/runserver.py b/openslides/core/management/commands/runserver.py index 6d21cab06..69453b00a 100644 --- a/openslides/core/management/commands/runserver.py +++ b/openslides/core/management/commands/runserver.py @@ -21,6 +21,8 @@ class Command(_Command): The Code is from django 1.9 """ + help = 'Starts the Tornado webserver.' + # TODO: do not start tornado when the settings says so def inner_run(self, *args, **options): diff --git a/openslides/users/management/commands/createsuperuser.py b/openslides/users/management/commands/createsuperuser.py index e6397ab96..3cd477edb 100644 --- a/openslides/users/management/commands/createsuperuser.py +++ b/openslides/users/management/commands/createsuperuser.py @@ -1,13 +1,15 @@ -from django.core.management.base import NoArgsCommand +from django.core.management.base import BaseCommand from ...models import User -class Command(NoArgsCommand): +class Command(BaseCommand): """ Command to create or reset the admin user. """ - def handle_noargs(self, **options): + help = 'Creates or resets the admin user.' + + def handle(self, *args, **options): created = User.objects.create_or_reset_admin_user() if created: self.stdout.write('Admin user successfully created.')