320 lines
12 KiB
Python
320 lines
12 KiB
Python
|
"""distutils.command.register
|
||
|
|
|
||
|
|
Implements the Distutils 'register' command (register with the repository).
|
||
|
|
"""
|
||
|
|
|
||
|
|
# created 2002/10/21, Richard Jones
|
||
|
|
|
||
|
|
import getpass
|
||
|
|
import io
|
||
|
|
import urllib.parse
|
||
|
|
import urllib.request
|
||
|
|
from warnings import warn
|
||
|
|
|
||
|
|
from distutils.core import PyPIRCCommand
|
||
|
|
from distutils import log
|
||
|
|
|
||
|
|
|
||
|
|
class register(PyPIRCCommand):
|
||
|
|
|
||
|
|
description = "register the distribution with the Python package index"
|
||
|
|
user_options = PyPIRCCommand.user_options + [
|
||
|
|
('list-classifiers', None, 'list the valid Trove classifiers'),
|
||
|
|
(
|
||
|
|
'strict',
|
||
|
|
None,
|
||
|
|
'Will stop the registering if the meta-data are not fully compliant',
|
||
|
|
),
|
||
|
|
]
|
||
|
|
boolean_options = PyPIRCCommand.boolean_options + [
|
||
|
|
'verify',
|
||
|
|
'list-classifiers',
|
||
|
|
'strict',
|
||
|
|
]
|
||
|
|
|
||
|
|
sub_commands = [('check', lambda self: True)]
|
||
|
|
|
||
|
|
def initialize_options(self):
|
||
|
|
PyPIRCCommand.initialize_options(self)
|
||
|
|
self.list_classifiers = 0
|
||
|
|
self.strict = 0
|
||
|
|
|
||
|
|
def finalize_options(self):
|
||
|
|
PyPIRCCommand.finalize_options(self)
|
||
|
|
# setting options for the `check` subcommand
|
||
|
|
check_options = {
|
||
|
|
'strict': ('register', self.strict),
|
||
|
|
'restructuredtext': ('register', 1),
|
||
|
|
}
|
||
|
|
self.distribution.command_options['check'] = check_options
|
||
|
|
|
||
|
|
def run(self):
|
||
|
|
self.finalize_options()
|
||
|
|
self._set_config()
|
||
|
|
|
||
|
|
# Run sub commands
|
||
|
|
for cmd_name in self.get_sub_commands():
|
||
|
|
self.run_command(cmd_name)
|
||
|
|
|
||
|
|
if self.dry_run:
|
||
|
|
self.verify_metadata()
|
||
|
|
elif self.list_classifiers:
|
||
|
|
self.classifiers()
|
||
|
|
else:
|
||
|
|
self.send_metadata()
|
||
|
|
|
||
|
|
def check_metadata(self):
|
||
|
|
"""Deprecated API."""
|
||
|
|
warn(
|
||
|
|
"distutils.command.register.check_metadata is deprecated; "
|
||
|
|
"use the check command instead",
|
||
|
|
DeprecationWarning,
|
||
|
|
)
|
||
|
|
check = self.distribution.get_command_obj('check')
|
||
|
|
check.ensure_finalized()
|
||
|
|
check.strict = self.strict
|
||
|
|
check.restructuredtext = 1
|
||
|
|
check.run()
|
||
|
|
|
||
|
|
def _set_config(self):
|
||
|
|
'''Reads the configuration file and set attributes.'''
|
||
|
|
config = self._read_pypirc()
|
||
|
|
if config != {}:
|
||
|
|
self.username = config['username']
|
||
|
|
self.password = config['password']
|
||
|
|
self.repository = config['repository']
|
||
|
|
self.realm = config['realm']
|
||
|
|
self.has_config = True
|
||
|
|
else:
|
||
|
|
if self.repository not in ('pypi', self.DEFAULT_REPOSITORY):
|
||
|
|
raise ValueError('%s not found in .pypirc' % self.repository)
|
||
|
|
if self.repository == 'pypi':
|
||
|
|
self.repository = self.DEFAULT_REPOSITORY
|
||
|
|
self.has_config = False
|
||
|
|
|
||
|
|
def classifiers(self):
|
||
|
|
'''Fetch the list of classifiers from the server.'''
|
||
|
|
url = self.repository + '?:action=list_classifiers'
|
||
|
|
response = urllib.request.urlopen(url)
|
||
|
|
log.info(self._read_pypi_response(response))
|
||
|
|
|
||
|
|
def verify_metadata(self):
|
||
|
|
'''Send the metadata to the package index server to be checked.'''
|
||
|
|
# send the info to the server and report the result
|
||
|
|
(code, result) = self.post_to_server(self.build_post_data('verify'))
|
||
|
|
log.info('Server response (%s): %s', code, result)
|
||
|
|
|
||
|
|
def send_metadata(self): # noqa: C901
|
||
|
|
'''Send the metadata to the package index server.
|
||
|
|
|
||
|
|
Well, do the following:
|
||
|
|
1. figure who the user is, and then
|
||
|
|
2. send the data as a Basic auth'ed POST.
|
||
|
|
|
||
|
|
First we try to read the username/password from $HOME/.pypirc,
|
||
|
|
which is a ConfigParser-formatted file with a section
|
||
|
|
[distutils] containing username and password entries (both
|
||
|
|
in clear text). Eg:
|
||
|
|
|
||
|
|
[distutils]
|
||
|
|
index-servers =
|
||
|
|
pypi
|
||
|
|
|
||
|
|
[pypi]
|
||
|
|
username: fred
|
||
|
|
password: sekrit
|
||
|
|
|
||
|
|
Otherwise, to figure who the user is, we offer the user three
|
||
|
|
choices:
|
||
|
|
|
||
|
|
1. use existing login,
|
||
|
|
2. register as a new user, or
|
||
|
|
3. set the password to a random string and email the user.
|
||
|
|
|
||
|
|
'''
|
||
|
|
# see if we can short-cut and get the username/password from the
|
||
|
|
# config
|
||
|
|
if self.has_config:
|
||
|
|
choice = '1'
|
||
|
|
username = self.username
|
||
|
|
password = self.password
|
||
|
|
else:
|
||
|
|
choice = 'x'
|
||
|
|
username = password = ''
|
||
|
|
|
||
|
|
# get the user's login info
|
||
|
|
choices = '1 2 3 4'.split()
|
||
|
|
while choice not in choices:
|
||
|
|
self.announce(
|
||
|
|
'''\
|
||
|
|
We need to know who you are, so please choose either:
|
||
|
|
1. use your existing login,
|
||
|
|
2. register as a new user,
|
||
|
|
3. have the server generate a new password for you (and email it to you), or
|
||
|
|
4. quit
|
||
|
|
Your selection [default 1]: ''',
|
||
|
|
log.INFO,
|
||
|
|
)
|
||
|
|
choice = input()
|
||
|
|
if not choice:
|
||
|
|
choice = '1'
|
||
|
|
elif choice not in choices:
|
||
|
|
print('Please choose one of the four options!')
|
||
|
|
|
||
|
|
if choice == '1':
|
||
|
|
# get the username and password
|
||
|
|
while not username:
|
||
|
|
username = input('Username: ')
|
||
|
|
while not password:
|
||
|
|
password = getpass.getpass('Password: ')
|
||
|
|
|
||
|
|
# set up the authentication
|
||
|
|
auth = urllib.request.HTTPPasswordMgr()
|
||
|
|
host = urllib.parse.urlparse(self.repository)[1]
|
||
|
|
auth.add_password(self.realm, host, username, password)
|
||
|
|
# send the info to the server and report the result
|
||
|
|
code, result = self.post_to_server(self.build_post_data('submit'), auth)
|
||
|
|
self.announce('Server response ({}): {}'.format(code, result), log.INFO)
|
||
|
|
|
||
|
|
# possibly save the login
|
||
|
|
if code == 200:
|
||
|
|
if self.has_config:
|
||
|
|
# sharing the password in the distribution instance
|
||
|
|
# so the upload command can reuse it
|
||
|
|
self.distribution.password = password
|
||
|
|
else:
|
||
|
|
self.announce(
|
||
|
|
(
|
||
|
|
'I can store your PyPI login so future '
|
||
|
|
'submissions will be faster.'
|
||
|
|
),
|
||
|
|
log.INFO,
|
||
|
|
)
|
||
|
|
self.announce(
|
||
|
|
'(the login will be stored in %s)' % self._get_rc_file(),
|
||
|
|
log.INFO,
|
||
|
|
)
|
||
|
|
choice = 'X'
|
||
|
|
while choice.lower() not in 'yn':
|
||
|
|
choice = input('Save your login (y/N)?')
|
||
|
|
if not choice:
|
||
|
|
choice = 'n'
|
||
|
|
if choice.lower() == 'y':
|
||
|
|
self._store_pypirc(username, password)
|
||
|
|
|
||
|
|
elif choice == '2':
|
||
|
|
data = {':action': 'user'}
|
||
|
|
data['name'] = data['password'] = data['email'] = ''
|
||
|
|
data['confirm'] = None
|
||
|
|
while not data['name']:
|
||
|
|
data['name'] = input('Username: ')
|
||
|
|
while data['password'] != data['confirm']:
|
||
|
|
while not data['password']:
|
||
|
|
data['password'] = getpass.getpass('Password: ')
|
||
|
|
while not data['confirm']:
|
||
|
|
data['confirm'] = getpass.getpass(' Confirm: ')
|
||
|
|
if data['password'] != data['confirm']:
|
||
|
|
data['password'] = ''
|
||
|
|
data['confirm'] = None
|
||
|
|
print("Password and confirm don't match!")
|
||
|
|
while not data['email']:
|
||
|
|
data['email'] = input(' EMail: ')
|
||
|
|
code, result = self.post_to_server(data)
|
||
|
|
if code != 200:
|
||
|
|
log.info('Server response (%s): %s', code, result)
|
||
|
|
else:
|
||
|
|
log.info('You will receive an email shortly.')
|
||
|
|
log.info('Follow the instructions in it to ' 'complete registration.')
|
||
|
|
elif choice == '3':
|
||
|
|
data = {':action': 'password_reset'}
|
||
|
|
data['email'] = ''
|
||
|
|
while not data['email']:
|
||
|
|
data['email'] = input('Your email address: ')
|
||
|
|
code, result = self.post_to_server(data)
|
||
|
|
log.info('Server response (%s): %s', code, result)
|
||
|
|
|
||
|
|
def build_post_data(self, action):
|
||
|
|
# figure the data to send - the metadata plus some additional
|
||
|
|
# information used by the package server
|
||
|
|
meta = self.distribution.metadata
|
||
|
|
data = {
|
||
|
|
':action': action,
|
||
|
|
'metadata_version': '1.0',
|
||
|
|
'name': meta.get_name(),
|
||
|
|
'version': meta.get_version(),
|
||
|
|
'summary': meta.get_description(),
|
||
|
|
'home_page': meta.get_url(),
|
||
|
|
'author': meta.get_contact(),
|
||
|
|
'author_email': meta.get_contact_email(),
|
||
|
|
'license': meta.get_licence(),
|
||
|
|
'description': meta.get_long_description(),
|
||
|
|
'keywords': meta.get_keywords(),
|
||
|
|
'platform': meta.get_platforms(),
|
||
|
|
'classifiers': meta.get_classifiers(),
|
||
|
|
'download_url': meta.get_download_url(),
|
||
|
|
# PEP 314
|
||
|
|
'provides': meta.get_provides(),
|
||
|
|
'requires': meta.get_requires(),
|
||
|
|
'obsoletes': meta.get_obsoletes(),
|
||
|
|
}
|
||
|
|
if data['provides'] or data['requires'] or data['obsoletes']:
|
||
|
|
data['metadata_version'] = '1.1'
|
||
|
|
return data
|
||
|
|
|
||
|
|
def post_to_server(self, data, auth=None): # noqa: C901
|
||
|
|
'''Post a query to the server, and return a string response.'''
|
||
|
|
if 'name' in data:
|
||
|
|
self.announce(
|
||
|
|
'Registering {} to {}'.format(data['name'], self.repository), log.INFO
|
||
|
|
)
|
||
|
|
# Build up the MIME payload for the urllib2 POST data
|
||
|
|
boundary = '--------------GHSKFJDLGDS7543FJKLFHRE75642756743254'
|
||
|
|
sep_boundary = '\n--' + boundary
|
||
|
|
end_boundary = sep_boundary + '--'
|
||
|
|
body = io.StringIO()
|
||
|
|
for key, value in data.items():
|
||
|
|
# handle multiple entries for the same name
|
||
|
|
if type(value) not in (type([]), type(())):
|
||
|
|
value = [value]
|
||
|
|
for value in value:
|
||
|
|
value = str(value)
|
||
|
|
body.write(sep_boundary)
|
||
|
|
body.write('\nContent-Disposition: form-data; name="%s"' % key)
|
||
|
|
body.write("\n\n")
|
||
|
|
body.write(value)
|
||
|
|
if value and value[-1] == '\r':
|
||
|
|
body.write('\n') # write an extra newline (lurve Macs)
|
||
|
|
body.write(end_boundary)
|
||
|
|
body.write("\n")
|
||
|
|
body = body.getvalue().encode("utf-8")
|
||
|
|
|
||
|
|
# build the Request
|
||
|
|
headers = {
|
||
|
|
'Content-type': 'multipart/form-data; boundary=%s; charset=utf-8'
|
||
|
|
% boundary,
|
||
|
|
'Content-length': str(len(body)),
|
||
|
|
}
|
||
|
|
req = urllib.request.Request(self.repository, body, headers)
|
||
|
|
|
||
|
|
# handle HTTP and include the Basic Auth handler
|
||
|
|
opener = urllib.request.build_opener(
|
||
|
|
urllib.request.HTTPBasicAuthHandler(password_mgr=auth)
|
||
|
|
)
|
||
|
|
data = ''
|
||
|
|
try:
|
||
|
|
result = opener.open(req)
|
||
|
|
except urllib.error.HTTPError as e:
|
||
|
|
if self.show_response:
|
||
|
|
data = e.fp.read()
|
||
|
|
result = e.code, e.msg
|
||
|
|
except urllib.error.URLError as e:
|
||
|
|
result = 500, str(e)
|
||
|
|
else:
|
||
|
|
if self.show_response:
|
||
|
|
data = self._read_pypi_response(result)
|
||
|
|
result = 200, 'OK'
|
||
|
|
if self.show_response:
|
||
|
|
msg = '\n'.join(('-' * 75, data, '-' * 75))
|
||
|
|
self.announce(msg, log.INFO)
|
||
|
|
return result
|