degal/main.py
author Tero Marttila <terom@fixme.fi>
Thu, 11 Jun 2009 23:57:53 +0300
changeset 101 698dc68a985d
parent 92 eb50b4f7812d
child 109 66a01c0806f1
permissions -rw-r--r--
split --force-update into --force-thumb/--force-html options, implement for main
48
20355dd2e61a new structure for bin/degal, adding degal/commands, degal/main
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     1
"""
20355dd2e61a new structure for bin/degal, adding degal/commands, degal/main
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     2
    Main entry point for the command-line interface
20355dd2e61a new structure for bin/degal, adding degal/commands, degal/main
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     3
"""
20355dd2e61a new structure for bin/degal, adding degal/commands, degal/main
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     4
72
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
     5
import gallery, commands, config as config_module
48
20355dd2e61a new structure for bin/degal, adding degal/commands, degal/main
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     6
20355dd2e61a new structure for bin/degal, adding degal/commands, degal/main
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     7
from optparse import OptionParser
20355dd2e61a new structure for bin/degal, adding degal/commands, degal/main
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     8
20355dd2e61a new structure for bin/degal, adding degal/commands, degal/main
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     9
def option_parser (command_name) :
20355dd2e61a new structure for bin/degal, adding degal/commands, degal/main
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    10
    """
20355dd2e61a new structure for bin/degal, adding degal/commands, degal/main
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    11
        Build the OptionParser that we use
20355dd2e61a new structure for bin/degal, adding degal/commands, degal/main
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    12
    """
20355dd2e61a new structure for bin/degal, adding degal/commands, degal/main
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    13
    
20355dd2e61a new structure for bin/degal, adding degal/commands, degal/main
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    14
    # create parser using the given command
20355dd2e61a new structure for bin/degal, adding degal/commands, degal/main
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    15
    parser = OptionParser(prog=command_name)
20355dd2e61a new structure for bin/degal, adding degal/commands, degal/main
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    16
    
20355dd2e61a new structure for bin/degal, adding degal/commands, degal/main
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    17
    # define options
87
a7a18893730d implement up-to-date checking for commands.main, and add --force-update option
Tero Marttila <terom@fixme.fi>
parents: 76
diff changeset
    18
    parser.add_option('-G', "--gallery-path",   metavar='DIR',  dest='gallery_path',    default=None,
a7a18893730d implement up-to-date checking for commands.main, and add --force-update option
Tero Marttila <terom@fixme.fi>
parents: 76
diff changeset
    19
            help="Use DIR as the Gallery path [default: CWD]")
a7a18893730d implement up-to-date checking for commands.main, and add --force-update option
Tero Marttila <terom@fixme.fi>
parents: 76
diff changeset
    20
a7a18893730d implement up-to-date checking for commands.main, and add --force-update option
Tero Marttila <terom@fixme.fi>
parents: 76
diff changeset
    21
    parser.add_option('-R', "--read-only",      dest='read_only',  action="store_true", default=False,
a7a18893730d implement up-to-date checking for commands.main, and add --force-update option
Tero Marttila <terom@fixme.fi>
parents: 76
diff changeset
    22
            help="Do not attempt to modify the gallery")
a7a18893730d implement up-to-date checking for commands.main, and add --force-update option
Tero Marttila <terom@fixme.fi>
parents: 76
diff changeset
    23
a7a18893730d implement up-to-date checking for commands.main, and add --force-update option
Tero Marttila <terom@fixme.fi>
parents: 76
diff changeset
    24
    parser.add_option('-F', "--force-update",   dest='force_update', action="store_true", default=False,
101
698dc68a985d split --force-update into --force-thumb/--force-html options, implement for main
Tero Marttila <terom@fixme.fi>
parents: 92
diff changeset
    25
            help="--force-thumb + --force-html")
698dc68a985d split --force-update into --force-thumb/--force-html options, implement for main
Tero Marttila <terom@fixme.fi>
parents: 92
diff changeset
    26
698dc68a985d split --force-update into --force-thumb/--force-html options, implement for main
Tero Marttila <terom@fixme.fi>
parents: 92
diff changeset
    27
    parser.add_option("--force-thumb",          dest='force_thumb', action="store_true", default=False,
698dc68a985d split --force-update into --force-thumb/--force-html options, implement for main
Tero Marttila <terom@fixme.fi>
parents: 92
diff changeset
    28
            help="Force-update all thumbnails")
698dc68a985d split --force-update into --force-thumb/--force-html options, implement for main
Tero Marttila <terom@fixme.fi>
parents: 92
diff changeset
    29
698dc68a985d split --force-update into --force-thumb/--force-html options, implement for main
Tero Marttila <terom@fixme.fi>
parents: 92
diff changeset
    30
    parser.add_option("--force-html",           dest='force_html', action="store_true", default=False,
698dc68a985d split --force-update into --force-thumb/--force-html options, implement for main
Tero Marttila <terom@fixme.fi>
parents: 92
diff changeset
    31
            help="Force-update all .html files")
698dc68a985d split --force-update into --force-thumb/--force-html options, implement for main
Tero Marttila <terom@fixme.fi>
parents: 92
diff changeset
    32
698dc68a985d split --force-update into --force-thumb/--force-html options, implement for main
Tero Marttila <terom@fixme.fi>
parents: 92
diff changeset
    33
    parser.add_option('-d', "--debug",          dest='debug', action="store_true", default=False,
698dc68a985d split --force-update into --force-thumb/--force-html options, implement for main
Tero Marttila <terom@fixme.fi>
parents: 92
diff changeset
    34
            help="Show debug output")
698dc68a985d split --force-update into --force-thumb/--force-html options, implement for main
Tero Marttila <terom@fixme.fi>
parents: 92
diff changeset
    35
698dc68a985d split --force-update into --force-thumb/--force-html options, implement for main
Tero Marttila <terom@fixme.fi>
parents: 92
diff changeset
    36
    parser.add_option('-q', "--quiet",           dest='quiet', action="store_true", default=False,
698dc68a985d split --force-update into --force-thumb/--force-html options, implement for main
Tero Marttila <terom@fixme.fi>
parents: 92
diff changeset
    37
            help="Reduced output")
48
20355dd2e61a new structure for bin/degal, adding degal/commands, degal/main
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    38
    
20355dd2e61a new structure for bin/degal, adding degal/commands, degal/main
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    39
    return parser
20355dd2e61a new structure for bin/degal, adding degal/commands, degal/main
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    40
72
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    41
def build_config (options) :
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    42
    """
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    43
        Build a configuration object with the given options
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    44
    """
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    45
    
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    46
    # build default config
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    47
    config = config_module.Configuration()
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    48
    
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    49
    # apply options
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    50
    if options.gallery_path :
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    51
        config.gallery_path = options.gallery_path
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    52
    
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    53
    if options.read_only :
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    54
        config.read_only = True
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    55
87
a7a18893730d implement up-to-date checking for commands.main, and add --force-update option
Tero Marttila <terom@fixme.fi>
parents: 76
diff changeset
    56
    if options.force_update :
101
698dc68a985d split --force-update into --force-thumb/--force-html options, implement for main
Tero Marttila <terom@fixme.fi>
parents: 92
diff changeset
    57
        config.force_html = True
698dc68a985d split --force-update into --force-thumb/--force-html options, implement for main
Tero Marttila <terom@fixme.fi>
parents: 92
diff changeset
    58
        config.force_thumb = True
698dc68a985d split --force-update into --force-thumb/--force-html options, implement for main
Tero Marttila <terom@fixme.fi>
parents: 92
diff changeset
    59
    
698dc68a985d split --force-update into --force-thumb/--force-html options, implement for main
Tero Marttila <terom@fixme.fi>
parents: 92
diff changeset
    60
    if options.force_thumb :
698dc68a985d split --force-update into --force-thumb/--force-html options, implement for main
Tero Marttila <terom@fixme.fi>
parents: 92
diff changeset
    61
        config.force_thumb = True
698dc68a985d split --force-update into --force-thumb/--force-html options, implement for main
Tero Marttila <terom@fixme.fi>
parents: 92
diff changeset
    62
698dc68a985d split --force-update into --force-thumb/--force-html options, implement for main
Tero Marttila <terom@fixme.fi>
parents: 92
diff changeset
    63
    if options.force_html :
698dc68a985d split --force-update into --force-thumb/--force-html options, implement for main
Tero Marttila <terom@fixme.fi>
parents: 92
diff changeset
    64
        config.force_html = True
698dc68a985d split --force-update into --force-thumb/--force-html options, implement for main
Tero Marttila <terom@fixme.fi>
parents: 92
diff changeset
    65
698dc68a985d split --force-update into --force-thumb/--force-html options, implement for main
Tero Marttila <terom@fixme.fi>
parents: 92
diff changeset
    66
    if options.debug :
698dc68a985d split --force-update into --force-thumb/--force-html options, implement for main
Tero Marttila <terom@fixme.fi>
parents: 92
diff changeset
    67
        config.log_level = config_module.logging.DEBUG
698dc68a985d split --force-update into --force-thumb/--force-html options, implement for main
Tero Marttila <terom@fixme.fi>
parents: 92
diff changeset
    68
698dc68a985d split --force-update into --force-thumb/--force-html options, implement for main
Tero Marttila <terom@fixme.fi>
parents: 92
diff changeset
    69
    if options.quiet :
698dc68a985d split --force-update into --force-thumb/--force-html options, implement for main
Tero Marttila <terom@fixme.fi>
parents: 92
diff changeset
    70
        config.log_level = config_module.logging.WARN
87
a7a18893730d implement up-to-date checking for commands.main, and add --force-update option
Tero Marttila <terom@fixme.fi>
parents: 76
diff changeset
    71
72
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    72
    # XXX: load config file(s)
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    73
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    74
    return config
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    75
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    76
def load_gallery (config) :
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    77
    """
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    78
        Create the Gallery object that we are manipulating
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    79
    """
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    80
    
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    81
    # read path from config
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    82
    return gallery.Gallery(config.gallery_path, config)
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    83
76
e22d9f699081 misc. fixes
Tero Marttila <terom@fixme.fi>
parents: 72
diff changeset
    84
def load_command (config, args) :
72
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    85
    """
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    86
        Figure out what command to run and with what args
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    87
    """
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    88
    
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    89
    # XXX: hardcoded
76
e22d9f699081 misc. fixes
Tero Marttila <terom@fixme.fi>
parents: 72
diff changeset
    90
    return commands.main, args, {}
e22d9f699081 misc. fixes
Tero Marttila <terom@fixme.fi>
parents: 72
diff changeset
    91
e22d9f699081 misc. fixes
Tero Marttila <terom@fixme.fi>
parents: 72
diff changeset
    92
def run_command (config, gallery, command, args, kwargs) :
e22d9f699081 misc. fixes
Tero Marttila <terom@fixme.fi>
parents: 72
diff changeset
    93
    """
e22d9f699081 misc. fixes
Tero Marttila <terom@fixme.fi>
parents: 72
diff changeset
    94
        Run the given command
e22d9f699081 misc. fixes
Tero Marttila <terom@fixme.fi>
parents: 72
diff changeset
    95
    """
e22d9f699081 misc. fixes
Tero Marttila <terom@fixme.fi>
parents: 72
diff changeset
    96
    
e22d9f699081 misc. fixes
Tero Marttila <terom@fixme.fi>
parents: 72
diff changeset
    97
    # setup the command execution context
e22d9f699081 misc. fixes
Tero Marttila <terom@fixme.fi>
parents: 72
diff changeset
    98
    command_ctx = command.setup(config, gallery)
92
eb50b4f7812d move Command exception handling into command.py, and handle KeyboardInterrupt
Tero Marttila <terom@fixme.fi>
parents: 87
diff changeset
    99
  
eb50b4f7812d move Command exception handling into command.py, and handle KeyboardInterrupt
Tero Marttila <terom@fixme.fi>
parents: 87
diff changeset
   100
    # run with error handling
eb50b4f7812d move Command exception handling into command.py, and handle KeyboardInterrupt
Tero Marttila <terom@fixme.fi>
parents: 87
diff changeset
   101
    return command_ctx.run()
72
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
   102
48
20355dd2e61a new structure for bin/degal, adding degal/commands, degal/main
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   103
def main (argv) :
20355dd2e61a new structure for bin/degal, adding degal/commands, degal/main
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   104
    """
20355dd2e61a new structure for bin/degal, adding degal/commands, degal/main
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   105
        Main entry point
20355dd2e61a new structure for bin/degal, adding degal/commands, degal/main
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   106
    """
20355dd2e61a new structure for bin/degal, adding degal/commands, degal/main
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   107
76
e22d9f699081 misc. fixes
Tero Marttila <terom@fixme.fi>
parents: 72
diff changeset
   108
    ## load commands
e22d9f699081 misc. fixes
Tero Marttila <terom@fixme.fi>
parents: 72
diff changeset
   109
    #commands = load_commands()
72
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
   110
48
20355dd2e61a new structure for bin/degal, adding degal/commands, degal/main
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   111
    # build optparser
20355dd2e61a new structure for bin/degal, adding degal/commands, degal/main
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   112
    parser = option_parser(argv[0])
20355dd2e61a new structure for bin/degal, adding degal/commands, degal/main
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   113
    
20355dd2e61a new structure for bin/degal, adding degal/commands, degal/main
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   114
    # parse the given argv
72
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
   115
    options, args = parser.parse_args(argv[1:])
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
   116
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
   117
    # build our config
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
   118
    config = build_config(options)
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
   119
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
   120
    # open gallery
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
   121
    gallery = load_gallery(config)
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
   122
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
   123
    # figure out what command to run
76
e22d9f699081 misc. fixes
Tero Marttila <terom@fixme.fi>
parents: 72
diff changeset
   124
    command, args, kwargs = load_command(config, args)
e22d9f699081 misc. fixes
Tero Marttila <terom@fixme.fi>
parents: 72
diff changeset
   125
48
20355dd2e61a new structure for bin/degal, adding degal/commands, degal/main
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   126
    # run the selected command
76
e22d9f699081 misc. fixes
Tero Marttila <terom@fixme.fi>
parents: 72
diff changeset
   127
    ret = run_command(config, gallery, command, args, kwargs)
72
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
   128
    
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
   129
    if ret is None :
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
   130
        # success
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
   131
        return 0
48
20355dd2e61a new structure for bin/degal, adding degal/commands, degal/main
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   132
72
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
   133
    else :
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
   134
        # exit with error code
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
   135
        assert isinstance(ret, int)
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
   136
        return ret
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
   137