Updating mozdownload (excluding tests)

mozdownload/cli.py

+#!/usr/bin/env python
+
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+import argparse
+import os
+import pkg_resources
+import sys
+
+from . import factory
+from . import scraper
+
+
+version = pkg_resources.require("mozdownload")[0].version
+
+__doc__ = """
+Module to handle downloads for different types of archive.mozilla.org hosted
+applications.
+
+mozdownload version: %(version)s
+""" % {'version': version}
+
+
+def cli():
+    """Main function for the downloader"""
+
+    parser = argparse.ArgumentParser(description=__doc__)
+    parser.add_argument('--application', '-a',
+                        dest='application',
+                        choices=scraper.APPLICATIONS,
+                        default='firefox',
+                        metavar='APPLICATION',
+                        help='The name of the application to download, default: "%(default)s"')
+    parser.add_argument('--base_url',
+                        dest='base_url',
+                        default=scraper.BASE_URL,
+                        metavar='BASE_URL',
+                        help='The base url to be used, default: "%(default)s"')
+    parser.add_argument('--build-number',
+                        dest='build_number',
+                        type=int,
+                        metavar='BUILD_NUMBER',
+                        help='Number of the build (for candidate, daily, and tinderbox builds)')
+    parser.add_argument('--destination', '-d',
+                        dest='destination',
+                        default=os.getcwd(),
+                        metavar='DESTINATION',
+                        help='Directory or file name to download the '
+                             'file to, default: current working directory')
+    parser.add_argument('--extension',
+                        dest='extension',
+                        metavar='EXTENSION',
+                        help='File extension of the build (e.g. "zip"), default: '
+                             'the standard build extension on the platform.')
+    parser.add_argument('--locale', '-l',
+                        dest='locale',
+                        metavar='LOCALE',
+                        help='Locale of the application, default: "en-US" or "multi"')
+    parser.add_argument('--log-level',
+                        action='store',
+                        dest='log_level',
+                        default='INFO',
+                        metavar='LOG_LEVEL',
+                        help='Threshold for log output (default: %(default)s)')
+    parser.add_argument('--password',
+                        dest='password',
+                        metavar='PASSWORD',
+                        help='Password for basic HTTP authentication.')
+    parser.add_argument('--platform', '-p',
+                        dest='platform',
+                        choices=scraper.PLATFORM_FRAGMENTS.keys(),
+                        metavar='PLATFORM',
+                        help='Platform of the application')
+    parser.add_argument('--retry-attempts',
+                        dest='retry_attempts',
+                        default=0,
+                        type=int,
+                        metavar='RETRY_ATTEMPTS',
+                        help='Number of times the download will be attempted in '
+                             'the event of a failure, default: %(default)s')
+    parser.add_argument('--retry-delay',
+                        dest='retry_delay',
+                        default=10.,
+                        type=float,
+                        metavar='RETRY_DELAY',
+                        help='Amount of time (in seconds) to wait between retry '
+                             'attempts, default: %(default)s')
+    parser.add_argument('--stub',
+                        dest='is_stub_installer',
+                        action='store_true',
+                        help='Stub installer (Only applicable to Windows builds).')
+    parser.add_argument('--timeout',
+                        dest='timeout',
+                        type=float,
+                        metavar='TIMEOUT',
+                        help='Amount of time (in seconds) until a download times out.')
+    parser.add_argument('--type', '-t',
+                        dest='scraper_type',
+                        choices=factory.scraper_types.keys(),
+                        default='release',
+                        metavar='SCRAPER_TYPE',
+                        help='Type of build to download, default: "%(default)s"')
+    parser.add_argument('--url',
+                        dest='url',
+                        metavar='URL',
+                        help='URL to download. Note: Reserved characters (such '
+                             'as &) must be escaped or put in quotes otherwise '
+                             'CLI output may be abnormal.')
+    parser.add_argument('--username',
+                        dest='username',
+                        metavar='USERNAME',
+                        help='Username for basic HTTP authentication.')
+    parser.add_argument('--version', '-v',
+                        dest='version',
+                        metavar='VERSION',
+                        help='Version of the application to be downloaded for release '
+                             'and candidate builds, i.e. "3.6"')
+
+    # Group for daily builds
+    group = parser.add_argument_group('Daily builds', 'Extra options for daily builds.')
+    group.add_argument('--branch',
+                       dest='branch',
+                       default='mozilla-central',
+                       metavar='BRANCH',
+                       help='Name of the branch, default: "%(default)s"')
+    group.add_argument('--build-id',
+                       dest='build_id',
+                       metavar='BUILD_ID',
+                       help='ID of the build to download.')
+    group.add_argument('--date',
+                       dest='date',
+                       metavar='DATE',
+                       help='Date of the build, default: latest build')
+
+    # Group for tinderbox builds
+    group = parser.add_argument_group('Tinderbox builds', 'Extra options for tinderbox builds.')
+    group.add_argument('--debug-build',
+                       dest='debug_build',
+                       action='store_true',
+                       help='Download a debug build.')
+
+    # Group for try builds
+    group = parser.add_argument_group('Try builds', 'Extra options for try builds.')
+    group.add_argument('--changeset',
+                       dest='changeset',
+                       help='Changeset of the try build to download')
+
+    kwargs = vars(parser.parse_args())
+
+    # Gives instructions to user when no arguments were passed
+    if len(sys.argv) == 1:
+        print(__doc__)
+        parser.format_usage()
+        print('Specify --help for more information on args. '
+              'Please see the README for examples.')
+        return
+
+    try:
+        scraper_type = kwargs.pop('scraper_type')
+
+        # If a URL has been specified use the direct scraper
+        if kwargs.get('url'):
+            scraper_type = 'direct'
+
+        build = factory.FactoryScraper(scraper_type, **kwargs)
+        build.download()
+    except KeyboardInterrupt:
+        print('\nDownload interrupted by the user')
+
+
+if __name__ == '__main__':
+    cli()