Skip to content

Commit

Permalink
Ruff format
Browse files Browse the repository at this point in the history
  • Loading branch information
Georgi Valkov committed Sep 7, 2024
1 parent a14328a commit 992413f
Show file tree
Hide file tree
Showing 5 changed files with 215 additions and 192 deletions.
1 change: 1 addition & 0 deletions setup.py
View file
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
import setuptools

setuptools.setup()
199 changes: 115 additions & 84 deletions setuptools_py2cfg.py
View file
Original file line number Diff line number Diff line change
@@ -1,47 +1,77 @@
#!/usr/bin/env python3

'''
"""
converts an existing setup.py file to a setup.cfg in the format expected by setuptools
'''
"""

import setuptools

import os, io, re, sys
import os
import io
import re
import sys
import runpy
from argparse import ArgumentParser, ArgumentDefaultsHelpFormatter, FileType
from pathlib import Path
from functools import partial
from collections import defaultdict
from unittest.mock import Mock
from configparser import ConfigParser
import runpy


def parseargs(cli_args=None):
parser = ArgumentParser(formatter_class=ArgumentDefaultsHelpFormatter, description=__doc__)

parser.add_argument(
'-t', '--dangling-list-threshold', default=40, metavar='int', type=int,
help='lists longer than this many characters are converted to a dangling list')
"-t",
"--dangling-list-threshold",
default=40,
metavar="int",
type=int,
help="lists longer than this many characters are converted to a dangling list",
)
parser.add_argument(
'-i', '--dangling-list-indent', default=4, metavar='int', type=int,
help='number of spaces to use when indenting dangling lists')
"-i",
"--dangling-list-indent",
default=4,
metavar="int",
type=int,
help="number of spaces to use when indenting dangling lists",
)
parser.add_argument(
'-a', '--always-use-dangling-lists', action='store_const', const=0, default=False,
help='use dangling lists everywhere', dest='dangling_list_threshold')
"-a",
"--always-use-dangling-lists",
action="store_const",
const=0,
default=False,
help="use dangling lists everywhere",
dest="dangling_list_threshold",
)
parser.add_argument(
'-n', '--never-use-dangling-lists', action='store_const', const=99999, default=False,
help='never use dangling lists', dest='dangling_list_threshold')
"-n",
"--never-use-dangling-lists",
action="store_const",
const=99999,
default=False,
help="never use dangling lists",
dest="dangling_list_threshold",
)
parser.add_argument(
'setup_py', type=FileType('r'), default='./setup.py', nargs='?', metavar='path',
help='path to setup.py file')
"setup_py",
type=FileType("r"),
default="./setup.py",
nargs="?",
metavar="path",
help="path to setup.py file",
)

return parser.parse_args(cli_args)


def execsetup(setup_py: Path):
# Mock all function in the setuptools module.
global setuptools
sys.modules['setuptools'] = Mock(autospec=setuptools)
sys.modules["setuptools"] = Mock(autospec=setuptools)
import setuptools

cwd = Path.cwd()
Expand Down Expand Up @@ -73,17 +103,17 @@ def _main(cli_args=None):
# Dump and reformat sections to ini format.
config = ConfigParser(interpolation=None)
if metadata:
config['metadata'] = metadata
config["metadata"] = metadata
if options:
config['options'] = options
config["options"] = options
for section, value in sections.items():
config[section] = value

# Load the existing setup.cfg if it exists
setup_cfg = setuppy_dir / 'setup.cfg'
setup_cfg = setuppy_dir / "setup.cfg"
if setup_cfg.exists():
setup_cfg_parser = ConfigParser()
with open(setup_cfg, 'r') as f:
with open(setup_cfg, "r") as f:
setup_cfg_parser.read_file(f)

config = merge_configs(setup_cfg_parser, config)
Expand All @@ -92,10 +122,10 @@ def _main(cli_args=None):
config.write(buf)

# Convert leading tabs to spaces.
res = re.sub('^(\t+)', ' ' * args.dangling_list_indent, buf.getvalue(), 0, re.MULTILINE)
res = re.sub("^(\t+)", " " * args.dangling_list_indent, buf.getvalue(), 0, re.MULTILINE)

# Remove trailing whitespace.
res = re.sub(' +$', '', res, 0, re.MULTILINE)
res = re.sub(" +$", "", res, 0, re.MULTILINE)
return res.rstrip()


Expand All @@ -111,106 +141,106 @@ def py2cfg(setup, setuppy_dir, dangling_list_threshold):
find_or_list_comma = partial(find_or_list_comma, sections=sections, threshold=dangling_list_threshold)

metadata = {}
setif(setup, metadata, 'name')
setif(setup, metadata, 'version')
setif(setup, metadata, 'author')
setif(setup, metadata, 'author_email')
setif(setup, metadata, 'maintainer')
setif(setup, metadata, 'maintainer_email')
setif(setup, metadata, 'license', find_file)
setif(setup, metadata, 'description')
setif(setup, metadata, 'keywords', list_comma)
setif(setup, metadata, 'url')
setif(setup, metadata, 'download_url')
setif(setup, metadata, 'long_description', find_file)
setif(setup, metadata, 'long_description_content_type')
setif(setup, metadata, 'classifiers', join_lines)
setif(setup, metadata, 'platforms', list_comma)
setif(setup, metadata, 'provides', list_comma)
setif(setup, metadata, 'requires', list_comma)
setif(setup, metadata, 'obsoletes', list_comma)
setif(setup, metadata, 'project_urls', mapping)
setif(setup, metadata, "name")
setif(setup, metadata, "version")
setif(setup, metadata, "author")
setif(setup, metadata, "author_email")
setif(setup, metadata, "maintainer")
setif(setup, metadata, "maintainer_email")
setif(setup, metadata, "license", find_file)
setif(setup, metadata, "description")
setif(setup, metadata, "keywords", list_comma)
setif(setup, metadata, "url")
setif(setup, metadata, "download_url")
setif(setup, metadata, "long_description", find_file)
setif(setup, metadata, "long_description_content_type")
setif(setup, metadata, "classifiers", join_lines)
setif(setup, metadata, "platforms", list_comma)
setif(setup, metadata, "provides", list_comma)
setif(setup, metadata, "requires", list_comma)
setif(setup, metadata, "obsoletes", list_comma)
setif(setup, metadata, "project_urls", mapping)

options = {}
setif(setup, options, 'package_dir', mapping)
setif(setup, options, 'py_modules', list_comma)
setif(setup, options, 'packages', find_or_list_comma)
setif(setup, options, 'zip_safe')
setif(setup, options, 'setup_requires', list_semi)
setif(setup, options, 'install_requires', list_semi)
setif(setup, options, 'include_package_data')
setif(setup, options, 'python_requires')
setif(setup, options, 'use_2to3')
setif(setup, options, 'use_2to3_fixers', list_comma)
setif(setup, options, 'use_2to3_exclude_fixers', list_comma)
setif(setup, options, 'convert_2to3_doctest', list_comma)
setif(setup, options, 'scripts', list_comma)
setif(setup, options, 'eager_resources', list_comma)
setif(setup, options, 'dependency_links', list_comma)
setif(setup, options, 'test_suite')
setif(setup, options, 'tests_require', list_semi)
setif(setup, options, 'include_package_data')
setif(setup, options, 'namespace_packages', list_comma)
setif(setup, options, 'include_package_data')

entry_points = setup.get('entry_points')
setif(setup, options, "package_dir", mapping)
setif(setup, options, "py_modules", list_comma)
setif(setup, options, "packages", find_or_list_comma)
setif(setup, options, "zip_safe")
setif(setup, options, "setup_requires", list_semi)
setif(setup, options, "install_requires", list_semi)
setif(setup, options, "include_package_data")
setif(setup, options, "python_requires")
setif(setup, options, "use_2to3")
setif(setup, options, "use_2to3_fixers", list_comma)
setif(setup, options, "use_2to3_exclude_fixers", list_comma)
setif(setup, options, "convert_2to3_doctest", list_comma)
setif(setup, options, "scripts", list_comma)
setif(setup, options, "eager_resources", list_comma)
setif(setup, options, "dependency_links", list_comma)
setif(setup, options, "test_suite")
setif(setup, options, "tests_require", list_semi)
setif(setup, options, "include_package_data")
setif(setup, options, "namespace_packages", list_comma)
setif(setup, options, "include_package_data")

entry_points = setup.get("entry_points")
if entry_points:
if isinstance(entry_points, dict):
sections['options.entry_points'] = extract_section(entry_points)
sections["options.entry_points"] = extract_section(entry_points)
else:
pass # TODO: Handle entry_points in ini syntax.

if 'extras_require' in setup:
sections['options.extras_require'] = extract_section(setup['extras_require'])
if "extras_require" in setup:
sections["options.extras_require"] = extract_section(setup["extras_require"])

if 'package_data' in setup:
sections['options.package_data'] = extract_section(setup['package_data'])
if "package_data" in setup:
sections["options.package_data"] = extract_section(setup["package_data"])

if 'exclude_package_data' in setup:
sections['options.exclude_package_data'] = extract_section(setup['exclude_package_data'])
if "exclude_package_data" in setup:
sections["options.exclude_package_data"] = extract_section(setup["exclude_package_data"])

return metadata, options, sections


def find_file(content, setuppy_dir):
'''
"""
Search for a file inside the setup.py directory matching the given text.
Returns the original text if an exact match is not found.
>>> find_file('BSD 3-Clause License\n\nCopyright....')
'file: LICENSE'
>>> find_file('Revised BSD License')
'Revised BSD License'
'''
"""

for path in (p for p in setuppy_dir.iterdir() if p.is_file()):
try:
if path.read_text() == content:
return 'file: %s' % path.name
return "file: %s" % path.name
except:
pass
return content


def join_lines(seq):
return '\n' + '\n'.join(seq)
return "\n" + "\n".join(seq)


def list_semi(value, threshold):
s = '; '.join(value)
s = "; ".join(value)
return join_lines(value) if len(s) > threshold else s


def mapping(value):
return join_lines('\t' * 2 + k + " = " + v for k, v in value.items())
return join_lines("\t" * 2 + k + " = " + v for k, v in value.items())


def list_comma_orig(value, threshold):
''''''
value = value.split() if isinstance(value, str) else value
s = ', '.join(value)
s = ", ".join(value)
return join_lines(value) if len(s) > threshold else s


list_comma = list_comma_orig


Expand All @@ -224,34 +254,35 @@ def find_or_list_comma(value, threshold, sections):
call = setuptools.find_packages.call_args
args, findSection = list(call)
if findSection:
sections['options.packages.find'] = extract_section(findSection)
sections["options.packages.find"] = extract_section(findSection)

return 'find:'
return "find:"

return list_comma_orig(value, threshold)


def setif(src, dest, key, transform=None):
'''Assign value to `dest` if `key` exists in `src`, while optionally
applying a transformation to `src[key]`.'''
"""Assign value to `dest` if `key` exists in `src`, while optionally
applying a transformation to `src[key]`."""

if key in src:
dest[key] = transform(src[key]) if transform else src[key]


def extract_section(value):
'''
"""
Join all dictionary values into a semicolon separated list.
>>> extract_section({'tests': ['pytest >= 3.0.0', 'tox >= 2.6.0']})
{'tests': 'tox >= 2.6.0; pytest >= 3.0.0'}
'''
"""
if isinstance(value, dict):
return {k: list_semi(ensure_list(v)) for k, v in value.items()}


def merge_configs(cfg1, cfg2):
"""Merges two configurations"""

def to_dict(cfg):
return {k: dict(**v) for k, v in cfg.items()}

Expand Down Expand Up @@ -298,5 +329,5 @@ def key_order(key):
return merged_config


if __name__ == '__main__':
if __name__ == "__main__":
main()
Loading

0 comments on commit 992413f

Please sign in to comment.