#!/usr/bin/python3 """Script to create a new distribution. The following options are supported: -help Print documentation of this file and of setup.py -local Install the distribution as a local site-package. If a Pywikibot package is already there, it will be uninstalled first. -remote Upload the package to pypi. This cannot be done if the Pywikibot version is a development release. -clear Clear old dist folders -upgrade Upgrade distribution packages pip, setuptools, wheel and twine first -nodist Do not create a distribution. Useful to -clear or -upgrade only. Usage:: [pwb] make_dist [options] .. versionadded:: 7.3 .. versionchanged:: 7.4 - updates pip, setuptools, wheel and twine packages first - installs pre-releases over stable versions - also creates built distribution together with source distribution - `-upgrade` option was added .. versionchanged:: 7.5 - `clear` option was added - `nodist` option was added """ # # (C) Pywikibot team, 2022 # # Distributed under the terms of the MIT license. # import abc import shutil import sys from subprocess import check_call from pathlib import Path from pywikibot import __version__, error, info, input_yn, warning from pywikibot.backports import Tuple import setup class SetupBase(abc.ABC): """Setup distribution base class. .. versionadded:: 8.0 """ def __init__(self, local, remote, clear, upgrade, nodist) -> None: """Initializer.""" self.local = local self.remote = remote self.clear = clear self.upgrade = upgrade self.nodist = nodist self.folder = Path().resolve() def clear_old_dist(self) -> None: # pragma: no cover """Delete old dist folders. .. versionadded:: 7.5 """ info('Removing old dist folders... ', newline=False) shutil.rmtree(self.folder / 'build', ignore_errors=True) shutil.rmtree(self.folder / 'dist', ignore_errors=True) shutil.rmtree(self.folder / 'pywikibot.egg-info', ignore_errors=True) info('done') @abc.abstractmethod def copy_files(self) -> None: """Copy files.""" @abc.abstractmethod def cleanup(self) -> None: """Cleanup copied files.""" def run(self) -> None: # pragma: no cover """Run the installer script.""" if self.upgrade: check_call('python -m pip install --upgrade pip', shell=True) check_call( 'pip install --upgrade setuptools wheel twine ', shell=True) if self.clear: self.clear_old_dist() if self.nodist: return self.copy_files() try: setup.main() # create a new package except SystemExit as e: error(e) return finally: self.cleanup() if self.local: check_call('pip uninstall pywikibot -y', shell=True) check_call( 'pip install --no-index --pre --find-links=dist pywikibot', shell=True) if self.remote and input_yn( '<>Upload dist to pypi', automatic_quit=False): check_call('twine upload dist/*', shell=True) class SetupPywikibot(SetupBase): """Setup for Pywikibot distribution. .. versionadded:: 8.0 """ def __init__(self, *args) -> None: """Set source and target directories.""" super().__init__(*args) source = self.folder / 'scripts' / 'i18n' / 'pywikibot' target = self.folder / 'pywikibot' / 'scripts' / 'i18n' / 'pywikibot' self.target = target self.source = source def copy_files(self) -> None: # pragma: no cover """Copy i18n files to pywikibot.scripts folder. Pywikibot i18n files are used for some translations. They are copied to the pywikibot scripts folder. """ info(f'directory is {self.folder}') info(f'clear {self.target} directory') shutil.rmtree(self.target, ignore_errors=True) info('copy i18n files ... ', newline=False) shutil.copytree(self.source, self.target) info('done') def cleanup(self) -> None: # pragma: no cover """Remove all copied files from pywikibot scripts folder.""" info('Remove copied files... ', newline=False) shutil.rmtree(self.target) # restore pywikibot en.json file filename = 'en.json' self.target.mkdir() shutil.copy(self.source / filename, self.target / filename) info('done') def handle_args() -> Tuple[bool, bool, bool, bool, bool]: """Handle arguments and print documentation if requested. Read arguments from `sys.argv` and adjust it passing `sdist` to `setuptools.setup`. :return: Return whether dist is to be installed locally or to be uploaded """ if '-help' in sys.argv: # pragma: no cover info(__doc__) info(setup.__doc__) sys.exit() local = '-local' in sys.argv remote = '-remote' in sys.argv clear = '-clear' in sys.argv upgrade = '-upgrade' in sys.argv nodist = '-nodist' in sys.argv if nodist: local, remote = False, False if remote and 'dev' in __version__: warning('Distribution must not be a developmental release to upload.') remote = False sys.argv = [sys.argv[0], 'sdist', 'bdist_wheel'] return local, remote, clear, upgrade, nodist def main() -> None: # pragma: no cover """Script entry point.""" args = handle_args() SetupPywikibot(*args).run() if __name__ == '__main__': # pragma: no cover main()