blob: 5d6ebcfa4cb78215e5e361bcb3d3061208329164 [file] [log] [blame]
Martin v. Löwis55f1bb82005-03-21 20:56:35 +00001"""distutils.command.upload
2
3Implements the Distutils 'upload' subcommand (upload package to PyPI)."""
Tarek Ziadédda92f72009-02-27 12:53:34 +00004import sys
Martin v. Löwis98858c92005-03-21 21:00:59 +00005import os
Martin v. Löwisca5d8fe2005-03-24 19:40:57 +00006import socket
Martin v. Löwis98858c92005-03-21 21:00:59 +00007import platform
Tarek Ziadéa1cc0402009-06-15 23:30:13 +00008from urllib2 import urlopen, Request, HTTPError
Tarek Ziadé2421d562009-12-20 23:23:34 +00009from base64 import standard_b64encode
Martin v. Löwis98858c92005-03-21 21:00:59 +000010import urlparse
11import cStringIO as StringIO
Georg Brandl392c6fc2008-05-25 07:25:25 +000012from ConfigParser import ConfigParser
Tarek Ziadéd7c5cee2009-06-15 23:04:29 +000013from hashlib import md5
Alexandre Vassalottieb8cef22008-05-16 02:06:59 +000014
Tarek Ziadéd7c5cee2009-06-15 23:04:29 +000015from distutils.errors import *
16from distutils.core import PyPIRCCommand
17from distutils.spawn import spawn
18from distutils import log
Martin v. Löwis98858c92005-03-21 21:00:59 +000019
Andrew M. Kuchlingaac5c862008-05-11 14:00:00 +000020class upload(PyPIRCCommand):
Martin v. Löwis98858c92005-03-21 21:00:59 +000021
22 description = "upload binary package to PyPI"
23
Andrew M. Kuchlingaac5c862008-05-11 14:00:00 +000024 user_options = PyPIRCCommand.user_options + [
Martin v. Löwisf74b9232005-03-22 15:51:14 +000025 ('sign', 's',
26 'sign files to upload using gpg'),
Phillip J. Eby2e550b32006-03-30 02:12:14 +000027 ('identity=', 'i', 'GPG identity used to sign files'),
Martin v. Löwis98858c92005-03-21 21:00:59 +000028 ]
Andrew M. Kuchlingaac5c862008-05-11 14:00:00 +000029
30 boolean_options = PyPIRCCommand.boolean_options + ['sign']
Martin v. Löwis98858c92005-03-21 21:00:59 +000031
32 def initialize_options(self):
Andrew M. Kuchlingaac5c862008-05-11 14:00:00 +000033 PyPIRCCommand.initialize_options(self)
Martin v. Löwis98858c92005-03-21 21:00:59 +000034 self.username = ''
35 self.password = ''
Martin v. Löwis98858c92005-03-21 21:00:59 +000036 self.show_response = 0
Martin v. Löwisf74b9232005-03-22 15:51:14 +000037 self.sign = False
Phillip J. Eby2e550b32006-03-30 02:12:14 +000038 self.identity = None
Martin v. Löwis98858c92005-03-21 21:00:59 +000039
40 def finalize_options(self):
Andrew M. Kuchlingaac5c862008-05-11 14:00:00 +000041 PyPIRCCommand.finalize_options(self)
Phillip J. Eby2e550b32006-03-30 02:12:14 +000042 if self.identity and not self.sign:
43 raise DistutilsOptionError(
44 "Must use --sign for --identity to have meaning"
45 )
Andrew M. Kuchlingaac5c862008-05-11 14:00:00 +000046 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']
Martin v. Löwis98858c92005-03-21 21:00:59 +000052
Tarek Ziadé1a240fb2009-01-08 23:56:31 +000053 # 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
Martin v. Löwis98858c92005-03-21 21:00:59 +000058 def run(self):
59 if not self.distribution.dist_files:
60 raise DistutilsOptionError("No dist file created in earlier command")
Martin v. Löwis98da5622005-03-23 18:54:36 +000061 for command, pyversion, filename in self.distribution.dist_files:
62 self.upload_file(command, pyversion, filename)
Martin v. Löwis98858c92005-03-21 21:00:59 +000063
Martin v. Löwis98da5622005-03-23 18:54:36 +000064 def upload_file(self, command, pyversion, filename):
Tarek Ziadéa1cc0402009-06-15 23:30:13 +000065 # 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
Martin v. Löwisf74b9232005-03-22 15:51:14 +000074 # Sign if requested
75 if self.sign:
Phillip J. Eby2e550b32006-03-30 02:12:14 +000076 gpg_args = ["gpg", "--detach-sign", "-a", filename]
77 if self.identity:
78 gpg_args[2:2] = ["--local-user", self.identity]
79 spawn(gpg_args,
Martin v. Löwisf74b9232005-03-22 15:51:14 +000080 dry_run=self.dry_run)
Martin v. Löwis98858c92005-03-21 21:00:59 +000081
Martin v. Löwis6d0c85a2006-01-08 10:48:54 +000082 # Fill in the data - send all the meta-data in case we need to
83 # register a new release
Phillip J. Eby5cb78462005-07-07 15:36:20 +000084 content = open(filename,'rb').read()
Martin v. Löwis6d0c85a2006-01-08 10:48:54 +000085 meta = self.distribution.metadata
Martin v. Löwis98858c92005-03-21 21:00:59 +000086 data = {
Martin v. Löwis6d0c85a2006-01-08 10:48:54 +000087 # 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(),
Martin v. Löwis98858c92005-03-21 21:00:59 +0000117 }
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
Martin v. Löwisf74b9232005-03-22 15:51:14 +0000127 if self.sign:
128 data['gpg_signature'] = (os.path.basename(filename) + ".asc",
129 open(filename+".asc").read())
130
Martin v. Löwis98858c92005-03-21 21:00:59 +0000131 # set up the authentication
Tarek Ziadé2421d562009-12-20 23:23:34 +0000132 auth = "Basic " + standard_b64encode(self.username + ":" +
133 self.password)
Martin v. Löwis98858c92005-03-21 21:00:59 +0000134
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
Tarek Ziadéd7c5cee2009-06-15 23:04:29 +0000142 if not isinstance(value, list):
Martin v. Löwis98858c92005-03-21 21:00:59 +0000143 value = [value]
144 for value in value:
Tarek Ziadéd7c5cee2009-06-15 23:04:29 +0000145 if isinstance(value, tuple):
Martin v. Löwis98858c92005-03-21 21:00:59 +0000146 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
Tarek Ziadéa1cc0402009-06-15 23:30:13 +0000165 headers = {'Content-type':
166 'multipart/form-data; boundary=%s' % boundary,
167 'Content-length': str(len(body)),
168 'Authorization': auth}
Martin v. Löwis98858c92005-03-21 21:00:59 +0000169
Tarek Ziadéa1cc0402009-06-15 23:30:13 +0000170 request = Request(self.repository, data=body,
171 headers=headers)
172 # send the data
Martin v. Löwis98858c92005-03-21 21:00:59 +0000173 try:
Tarek Ziadéa1cc0402009-06-15 23:30:13 +0000174 result = urlopen(request)
175 status = result.getcode()
176 reason = result.msg
Martin v. Löwis98858c92005-03-21 21:00:59 +0000177 except socket.error, e:
Phillip J. Eby137ff792006-07-10 19:18:35 +0000178 self.announce(str(e), log.ERROR)
Martin v. Löwis98858c92005-03-21 21:00:59 +0000179 return
Tarek Ziadéa1cc0402009-06-15 23:30:13 +0000180 except HTTPError, e:
181 status = e.code
182 reason = e.msg
Martin v. Löwis98858c92005-03-21 21:00:59 +0000183
Tarek Ziadéa1cc0402009-06-15 23:30:13 +0000184 if status == 200:
185 self.announce('Server response (%s): %s' % (status, reason),
Martin v. Löwis98858c92005-03-21 21:00:59 +0000186 log.INFO)
187 else:
Tarek Ziadéa1cc0402009-06-15 23:30:13 +0000188 self.announce('Upload failed (%s): %s' % (status, reason),
Martin v. Löwisf74b9232005-03-22 15:51:14 +0000189 log.ERROR)
Martin v. Löwis98858c92005-03-21 21:00:59 +0000190 if self.show_response:
Tarek Ziadéa1cc0402009-06-15 23:30:13 +0000191 self.announce('-'*75, result.read(), '-'*75)