degal/main.py
author Tero Marttila <terom@fixme.fi>
Sun, 14 Jun 2009 16:19:27 +0300
changeset 109 66a01c0806f1
parent 101 698dc68a985d
child 111 ecceaf23c969
permissions -rw-r--r--
backout config.read_only as a useless feature
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('-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
    22
            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
    23
698dc68a985d split --force-update into --force-thumb/--force-html options, implement for main
Tero Marttila <terom@fixme.fi>
parents: 92
diff changeset
    24
    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
    25
            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
    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-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
    28
            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
    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('-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
    31
            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
    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('-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
    34
            help="Reduced output")
48
20355dd2e61a new structure for bin/degal, adding degal/commands, degal/main
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    35
    
20355dd2e61a new structure for bin/degal, adding degal/commands, degal/main
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    36
    return parser
20355dd2e61a new structure for bin/degal, adding degal/commands, degal/main
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    37
72
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    38
def build_config (options) :
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    39
    """
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    40
        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
    41
    """
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 default config
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    44
    config = config_module.Configuration()
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
    # apply options
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    47
    if options.gallery_path :
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    48
        config.gallery_path = options.gallery_path
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    49
    
87
a7a18893730d implement up-to-date checking for commands.main, and add --force-update option
Tero Marttila <terom@fixme.fi>
parents: 76
diff changeset
    50
    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
    51
        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
    52
        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
    53
    
698dc68a985d split --force-update into --force-thumb/--force-html options, implement for main
Tero Marttila <terom@fixme.fi>
parents: 92
diff changeset
    54
    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
    55
        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
    56
698dc68a985d split --force-update into --force-thumb/--force-html options, implement for main
Tero Marttila <terom@fixme.fi>
parents: 92
diff changeset
    57
    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
    58
        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
    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.debug :
698dc68a985d split --force-update into --force-thumb/--force-html options, implement for main
Tero Marttila <terom@fixme.fi>
parents: 92
diff changeset
    61
        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
    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.quiet :
698dc68a985d split --force-update into --force-thumb/--force-html options, implement for main
Tero Marttila <terom@fixme.fi>
parents: 92
diff changeset
    64
        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
    65
72
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    66
    # XXX: load config file(s)
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    67
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    68
    return config
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    69
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    70
def load_gallery (config) :
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    71
    """
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    72
        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
    73
    """
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    74
    
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    75
    # read path from config
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    76
    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
    77
76
e22d9f699081 misc. fixes
Tero Marttila <terom@fixme.fi>
parents: 72
diff changeset
    78
def load_command (config, args) :
72
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
        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
    81
    """
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    82
    
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    83
    # XXX: hardcoded
76
e22d9f699081 misc. fixes
Tero Marttila <terom@fixme.fi>
parents: 72
diff changeset
    84
    return commands.main, args, {}
e22d9f699081 misc. fixes
Tero Marttila <terom@fixme.fi>
parents: 72
diff changeset
    85
e22d9f699081 misc. fixes
Tero Marttila <terom@fixme.fi>
parents: 72
diff changeset
    86
def run_command (config, gallery, command, args, kwargs) :
e22d9f699081 misc. fixes
Tero Marttila <terom@fixme.fi>
parents: 72
diff changeset
    87
    """
e22d9f699081 misc. fixes
Tero Marttila <terom@fixme.fi>
parents: 72
diff changeset
    88
        Run the given command
e22d9f699081 misc. fixes
Tero Marttila <terom@fixme.fi>
parents: 72
diff changeset
    89
    """
e22d9f699081 misc. fixes
Tero Marttila <terom@fixme.fi>
parents: 72
diff changeset
    90
    
e22d9f699081 misc. fixes
Tero Marttila <terom@fixme.fi>
parents: 72
diff changeset
    91
    # setup the command execution context
e22d9f699081 misc. fixes
Tero Marttila <terom@fixme.fi>
parents: 72
diff changeset
    92
    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
    93
  
eb50b4f7812d move Command exception handling into command.py, and handle KeyboardInterrupt
Tero Marttila <terom@fixme.fi>
parents: 87
diff changeset
    94
    # run with error handling
eb50b4f7812d move Command exception handling into command.py, and handle KeyboardInterrupt
Tero Marttila <terom@fixme.fi>
parents: 87
diff changeset
    95
    return command_ctx.run()
72
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    96
48
20355dd2e61a new structure for bin/degal, adding degal/commands, degal/main
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    97
def main (argv) :
20355dd2e61a new structure for bin/degal, adding degal/commands, degal/main
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    98
    """
20355dd2e61a new structure for bin/degal, adding degal/commands, degal/main
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    99
        Main entry point
20355dd2e61a new structure for bin/degal, adding degal/commands, degal/main
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   100
    """
20355dd2e61a new structure for bin/degal, adding degal/commands, degal/main
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   101
76
e22d9f699081 misc. fixes
Tero Marttila <terom@fixme.fi>
parents: 72
diff changeset
   102
    ## load commands
e22d9f699081 misc. fixes
Tero Marttila <terom@fixme.fi>
parents: 72
diff changeset
   103
    #commands = load_commands()
72
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
   104
48
20355dd2e61a new structure for bin/degal, adding degal/commands, degal/main
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   105
    # build optparser
20355dd2e61a new structure for bin/degal, adding degal/commands, degal/main
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   106
    parser = option_parser(argv[0])
20355dd2e61a new structure for bin/degal, adding degal/commands, degal/main
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   107
    
20355dd2e61a new structure for bin/degal, adding degal/commands, degal/main
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   108
    # parse the given argv
72
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
   109
    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
   110
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
   111
    # build our config
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
   112
    config = build_config(options)
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
   113
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
   114
    # open gallery
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
   115
    gallery = load_gallery(config)
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
    # figure out what command to run
76
e22d9f699081 misc. fixes
Tero Marttila <terom@fixme.fi>
parents: 72
diff changeset
   118
    command, args, kwargs = load_command(config, args)
e22d9f699081 misc. fixes
Tero Marttila <terom@fixme.fi>
parents: 72
diff changeset
   119
48
20355dd2e61a new structure for bin/degal, adding degal/commands, degal/main
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   120
    # run the selected command
76
e22d9f699081 misc. fixes
Tero Marttila <terom@fixme.fi>
parents: 72
diff changeset
   121
    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
   122
    
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
   123
    if ret is None :
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
   124
        # success
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
   125
        return 0
48
20355dd2e61a new structure for bin/degal, adding degal/commands, degal/main
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   126
72
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
   127
    else :
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
   128
        # exit with error code
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
   129
        assert isinstance(ret, int)
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
   130
        return ret
168a2d065f17 use new command/gallery stuff in main.py
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
   131