# Copyright 2013 Donald Stufft # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # https://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. import os import os.path import functools import getpass import sys import argparse import warnings import collections import configparser from urllib.parse import urlparse, urlunparse from requests.exceptions import HTTPError try: import keyring # noqa except ImportError: pass from twine import exceptions # Shim for input to allow testing. input_func = input DEFAULT_REPOSITORY = "https://upload.pypi.org/legacy/" TEST_REPOSITORY = "https://test.pypi.org/legacy/" def get_config(path="~/.pypirc"): # even if the config file does not exist, set up the parser # variable to reduce the number of if/else statements parser = configparser.RawConfigParser() # this list will only be used if index-servers # is not defined in the config file index_servers = ["pypi", "testpypi"] # default configuration for each repository defaults = {"username": None, "password": None} # Expand user strings in the path path = os.path.expanduser(path) # Parse the rc file if os.path.isfile(path): parser.read(path) # Get a list of index_servers from the config file # format: https://docs.python.org/3/distutils/packageindex.html#pypirc if parser.has_option("distutils", "index-servers"): index_servers = parser.get("distutils", "index-servers").split() for key in ["username", "password"]: if parser.has_option("server-login", key): defaults[key] = parser.get("server-login", key) config = collections.defaultdict(lambda: defaults.copy()) # don't require users to manually configure URLs for these repositories config["pypi"]["repository"] = DEFAULT_REPOSITORY if "testpypi" in index_servers: config["testpypi"]["repository"] = TEST_REPOSITORY # optional configuration values for individual repositories for repository in index_servers: for key in [ "username", "repository", "password", "ca_cert", "client_cert", ]: if parser.has_option(repository, key): config[repository][key] = parser.get(repository, key) # convert the defaultdict to a regular dict at this point # to prevent surprising behavior later on return dict(config) def get_repository_from_config(config_file, repository, repository_url=None): # Get our config from, if provided, command-line values for the # repository name and URL, or the .pypirc file if repository_url and "://" in repository_url: # prefer CLI `repository_url` over `repository` or .pypirc return { "repository": repository_url, "username": None, "password": None, } if repository_url and "://" not in repository_url: raise exceptions.UnreachableRepositoryURLDetected( "Repository URL {} has no protocol. Please add " "'https://'. \n".format(repository_url)) try: return get_config(config_file)[repository] except KeyError: msg = ( "Missing '{repo}' section from the configuration file\n" "or not a complete URL in --repository-url.\n" "Maybe you have a out-dated '{cfg}' format?\n" "more info: " "https://docs.python.org/distutils/packageindex.html#pypirc\n" ).format( repo=repository, cfg=config_file ) raise exceptions.InvalidConfiguration(msg) _HOSTNAMES = {"pypi.python.org", "testpypi.python.org", "upload.pypi.org", "test.pypi.org"} def normalize_repository_url(url): parsed = urlparse(url) if parsed.netloc in _HOSTNAMES: return urlunparse(("https",) + parsed[1:]) return urlunparse(parsed) def check_status_code(response, verbose): """ Shouldn't happen, thanks to the UploadToDeprecatedPyPIDetected exception, but this is in case that breaks and it does. """ if (response.status_code == 410 and response.url.startswith(("https://pypi.python.org", "https://testpypi.python.org"))): print("It appears you're uploading to pypi.python.org (or " "testpypi.python.org). You've received a 410 error response. " "Uploading to those sites is deprecated. The new sites are " "pypi.org and test.pypi.org. Try using " "https://upload.pypi.org/legacy/ " "(or https://test.pypi.org/legacy/) to upload your packages " "instead. These are the default URLs for Twine now. More at " "https://packaging.python.org/guides/migrating-to-pypi-org/ ") try: response.raise_for_status() except HTTPError as err: if response.text: if verbose: print('Content received from server:\n{}'.format( response.text)) else: print('NOTE: Try --verbose to see response content.') raise err def get_userpass_value(cli_value, config, key, prompt_strategy=None): """Gets the username / password from config. Uses the following rules: 1. If it is specified on the cli (`cli_value`), use that. 2. If `config[key]` is specified, use that. 3. If `prompt_strategy`, prompt using `prompt_strategy`. 4. Otherwise return None :param cli_value: The value supplied from the command line or `None`. :type cli_value: unicode or `None` :param config: Config dictionary :type config: dict :param key: Key to find the config value. :type key: unicode :prompt_strategy: Argumentless function to return fallback value. :type prompt_strategy: function :returns: The value for the username / password :rtype: unicode """ if cli_value is not None: return cli_value elif config.get(key) is not None: return config[key] elif prompt_strategy: return prompt_strategy() else: return None def get_username_from_keyring(system): if 'keyring' not in sys.modules: return try: getter = sys.modules['keyring'].get_credential except AttributeError: return None try: creds = getter(system, None) if creds: return creds.username except Exception as exc: warnings.warn(str(exc)) def password_prompt(prompt_text): # Always expects unicode for our own sanity return getpass.getpass(prompt_text) def get_password_from_keyring(system, username): if 'keyring' not in sys.modules: return try: return sys.modules['keyring'].get_password(system, username) except Exception as exc: warnings.warn(str(exc)) def username_from_keyring_or_prompt(system): return ( get_username_from_keyring(system) or input_func('Enter your username: ') ) def password_from_keyring_or_prompt(system, username): return ( get_password_from_keyring(system, username) or password_prompt('Enter your password: ') ) def get_username(system, cli_value, config): return get_userpass_value( cli_value, config, key='username', prompt_strategy=functools.partial( username_from_keyring_or_prompt, system, ), ) get_cacert = functools.partial( get_userpass_value, key='ca_cert', ) get_clientcert = functools.partial( get_userpass_value, key='client_cert', ) class EnvironmentDefault(argparse.Action): """Get values from environment variable.""" def __init__(self, env, required=True, default=None, **kwargs): default = os.environ.get(env, default) self.env = env if default: required = False super().__init__(default=default, required=required, **kwargs) def __call__(self, parser, namespace, values, option_string=None): setattr(namespace, self.dest, values) def get_password(system, username, cli_value, config): return get_userpass_value( cli_value, config, key='password', prompt_strategy=functools.partial( password_from_keyring_or_prompt, system, username, ), ) def no_positional(allow_self=False): """A decorator that doesn't allow for positional arguments. :param bool allow_self: Whether to allow ``self`` as a positional argument. """ def reject_positional_args(function): @functools.wraps(function) def wrapper(*args, **kwargs): allowed_positional_args = 0 if allow_self: allowed_positional_args = 1 received_positional_args = len(args) if received_positional_args > allowed_positional_args: function_name = function.__name__ verb = 'were' if received_positional_args > 1 else 'was' raise TypeError(('{}() takes {} positional arguments but {} ' '{} given').format( function_name, allowed_positional_args, received_positional_args, verb, )) return function(*args, **kwargs) return wrapper return reject_positional_args