Skip to content

Stop monkey-patching ScriptWriter #2007

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gtristan merged 2 commits into from
May 4, 2025
Merged

Stop monkey-patching ScriptWriter #2007

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fbf8723
Upgrade setuptools version
abderrahim May 4, 2025
3eb32c7
Stop monkey patching ScriptWriter
abderrahim May 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@
#
[build-system]
requires = [
# We need at least version 36.6.0 that introduced "build_meta"
"setuptools>=36.6.0",
# We need at least version 41.2.0 to support python 3.9
"setuptools>=41.2.0",
# In order to build wheels, and as required by PEP 517
"wheel",
# Require a new enough cython for the python versions we support
Expand Down
45 changes: 0 additions & 45 deletions setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,6 @@

try:
from setuptools import setup, find_packages, Command, Extension
from setuptools.command.easy_install import ScriptWriter
except ImportError:
print(
"BuildStream requires setuptools in order to build. Install it using"
Expand Down Expand Up @@ -156,50 +155,6 @@ def list_testing_datafiles():
return [str(f) for f in data_dir.rglob("*")]


#####################################################
# Monkey-patching setuptools for performance #
#####################################################
#
# The template of easy_install.ScriptWriter is inefficient in our case as it
# imports pkg_resources. Patching the template only doesn't work because of the
# old string formatting used (%). This forces us to overwrite the class function
# as well.
#
# The patch was inspired from https://github.com/ninjaaron/fast-entry_points
# which we believe was also inspired from the code from `setuptools` project.
#
# This also sets an environment variable to disable gRPC fork support as it
# can cause problems in certain environments and BuildStream doesn't need it.
TEMPLATE = """\
# -*- coding: utf-8 -*-
import os
import sys

from {0} import {1}

if __name__ == '__main__':
os.environ['GRPC_ENABLE_FORK_SUPPORT'] = '0'
sys.exit({2}())"""


# Modify the get_args() function of the ScriptWriter class
# Note: the pylint no-member warning has been disabled as the functions: get_header(),
# ensure_safe_name() and _get_script_args() are all members of this class.
# pylint: disable=no-member
@classmethod
def get_args(cls, dist, header=None):
if header is None:
header = cls.get_header()
for name, ep in dist.get_entry_map("console_scripts").items():
cls._ensure_safe_name(name)
script_text = TEMPLATE.format(ep.module_name, ep.attrs[0], ".".join(ep.attrs))
args = cls._get_script_args("console", name, header, script_text)
yield from args


ScriptWriter.get_args = get_args


#####################################################
# gRPC command for code generation #
#####################################################
Expand Down
Loading