Lib/distutils/command/upload.py

   1 """distutils.command.upload
   2
   3 Implements the Distutils 'upload' subcommand (upload package to PyPI)."""
   4 import sys
   5 import os
   6 import socket
   7 import platform
   8 from urllib2 import urlopen, Request, HTTPError
   9 import base64
  10 import urlparse
  11 import cStringIO as StringIO
  12 from ConfigParser import ConfigParser
  13 from hashlib import md5
  14
  15 from distutils.errors import *
  16 from distutils.core import PyPIRCCommand
  17 from distutils.spawn import spawn
  18 from distutils import log
  19
  20 class upload(PyPIRCCommand):
  21
  22     description = "upload binary package to PyPI"
  23
  24     user_options = PyPIRCCommand.user_options + [
  25         ('sign', 's',
  26          'sign files to upload using gpg'),
  27         ('identity=', 'i', 'GPG identity used to sign files'),
  28         ]
  29
  30     boolean_options = PyPIRCCommand.boolean_options + ['sign']
  31
  32     def initialize_options(self):
  33         PyPIRCCommand.initialize_options(self)
  34         self.username = ''
  35         self.password = ''
  36         self.show_response = 0
  37         self.sign = False
  38         self.identity = None
  39
  40     def finalize_options(self):
  41         PyPIRCCommand.finalize_options(self)
  42         if self.identity and not self.sign:
  43             raise DistutilsOptionError(
  44                 "Must use --sign for --identity to have meaning"
  45             )
  46         config = self._read_pypirc()
  47         if config != {}:
  48             self.username = config['username']
  49             self.password = config['password']
  50             self.repository = config['repository']
  51             self.realm = config['realm']
  52
  53         # getting the password from the distribution
  54         # if previously set by the register command
  55         if not self.password and self.distribution.password:
  56             self.password = self.distribution.password
  57
  58     def run(self):
  59         if not self.distribution.dist_files:
  60             raise DistutilsOptionError("No dist file created in earlier command")
  61         for command, pyversion, filename in self.distribution.dist_files:
  62             self.upload_file(command, pyversion, filename)
  63
  64     def upload_file(self, command, pyversion, filename):
  65         # Makes sure the repository URL is compliant
  66         schema, netloc, url, params, query, fragments = \
  67             urlparse.urlparse(self.repository)
  68         if params or query or fragments:
  69             raise AssertionError("Incompatible url %s" % self.repository)
  70
  71         if schema not in ('http', 'https'):
  72             raise AssertionError("unsupported schema " + schema)
  73
  74         # Sign if requested
  75         if self.sign:
  76             gpg_args = ["gpg", "--detach-sign", "-a", filename]
  77             if self.identity:
  78                 gpg_args[2:2] = ["--local-user", self.identity]
  79             spawn(gpg_args,
  80                   dry_run=self.dry_run)
  81
  82         # Fill in the data - send all the meta-data in case we need to
  83         # register a new release
  84         content = open(filename,'rb').read()
  85         meta = self.distribution.metadata
  86         data = {
  87             # action
  88             ':action': 'file_upload',
  89             'protcol_version': '1',
  90
  91             # identify release
  92             'name': meta.get_name(),
  93             'version': meta.get_version(),
  94
  95             # file content
  96             'content': (os.path.basename(filename),content),
  97             'filetype': command,
  98             'pyversion': pyversion,
  99             'md5_digest': md5(content).hexdigest(),
 100
 101             # additional meta-data
 102             'metadata_version' : '1.0',
 103             'summary': meta.get_description(),
 104             'home_page': meta.get_url(),
 105             'author': meta.get_contact(),
 106             'author_email': meta.get_contact_email(),
 107             'license': meta.get_licence(),
 108             'description': meta.get_long_description(),
 109             'keywords': meta.get_keywords(),
 110             'platform': meta.get_platforms(),
 111             'classifiers': meta.get_classifiers(),
 112             'download_url': meta.get_download_url(),
 113             # PEP 314
 114             'provides': meta.get_provides(),
 115             'requires': meta.get_requires(),
 116             'obsoletes': meta.get_obsoletes(),
 117             }
 118         comment = ''
 119         if command == 'bdist_rpm':
 120             dist, version, id = platform.dist()
 121             if dist:
 122                 comment = 'built for %s %s' % (dist, version)
 123         elif command == 'bdist_dumb':
 124             comment = 'built for %s' % platform.platform(terse=1)
 125         data['comment'] = comment
 126
 127         if self.sign:
 128             data['gpg_signature'] = (os.path.basename(filename) + ".asc",
 129                                      open(filename+".asc").read())
 130
 131         # set up the authentication
 132         auth = "Basic " + base64.encodestring(self.username + ":" +
 133                                               self.password).strip()
 134
 135         # Build up the MIME payload for the POST data
 136         boundary = '--------------GHSKFJDLGDS7543FJKLFHRE75642756743254'
 137         sep_boundary = '\n--' + boundary
 138         end_boundary = sep_boundary + '--'
 139         body = StringIO.StringIO()
 140         for key, value in data.items():
 141             # handle multiple entries for the same name
 142             if not isinstance(value, list):
 143                 value = [value]
 144             for value in value:
 145                 if isinstance(value, tuple):
 146                     fn = ';filename="%s"' % value[0]
 147                     value = value[1]
 148                 else:
 149                     fn = ""
 150                 value = str(value)
 151                 body.write(sep_boundary)
 152                 body.write('\nContent-Disposition: form-data; name="%s"'%key)
 153                 body.write(fn)
 154                 body.write("\n\n")
 155                 body.write(value)
 156                 if value and value[-1] == '\r':
 157                     body.write('\n')  # write an extra newline (lurve Macs)
 158         body.write(end_boundary)
 159         body.write("\n")
 160         body = body.getvalue()
 161
 162         self.announce("Submitting %s to %s" % (filename, self.repository), log.INFO)
 163
 164         # build the Request
 165         headers = {'Content-type':
 166                         'multipart/form-data; boundary=%s' % boundary,
 167                    'Content-length': str(len(body)),
 168                    'Authorization': auth}
 169
 170         request = Request(self.repository, data=body,
 171                           headers=headers)
 172         # send the data
 173         try:
 174             result = urlopen(request)
 175             status = result.getcode()
 176             reason = result.msg
 177         except socket.error, e:
 178             self.announce(str(e), log.ERROR)
 179             return
 180         except HTTPError, e:
 181             status = e.code
 182             reason = e.msg
 183
 184         if status == 200:
 185             self.announce('Server response (%s): %s' % (status, reason),
 186                           log.INFO)
 187         else:
 188             self.announce('Upload failed (%s): %s' % (status, reason),
 189                           log.ERROR)
 190         if self.show_response:
 191             self.announce('-'*75, result.read(), '-'*75)