Scons

Latest version: v4.7.0

Safety actively analyzes 613777 Python packages for vulnerabilities to keep your Python projects secure.

Scan your dependencies

Page 1 of 13

4.7.0

From Ataf Fazledin Ahamed:
- Use of NotImplemented instead of NotImplementedError for special methods
of _ListVariable class

From Joseph Brill:
- Fix issue 2755: the msvs tool no longer writes the OS environment SCONS_HOME
value into the SCons environment when the SCONS_HOME variable already exists
in the SCons environment. Prior to this change, a valid user-defined SCons
environment value for SCONS_HOME would be overwritten with the OS environment
value of SCONS_HOME which could be None (i.e., undefined).
- Update the windows registry keys for detection of Visual Studio 2015 Express
('14.0Exp'): the VS2015 registry key ('WDExpress') appears to be different
than the registry key ('VCExpress') for earlier Visual Studio express
versions. The registry key value is relative to the installation root rather
than the VC folder and requires additional path components during evaluation.
- Fix the vs-6.0-exec.py test script: the msvs generated project is 'foo.dsp'
and the command-line invocation of the Visual Studio development environment
program was attempting to build 'test.dsp'. The command-line invocation was
changed to build 'foo.dsp'.
- Update the msvs project generation test scripts: the msvs project execution
tests could produce a "false positive" test result when the test executable is
correctly built via the SConstruct env.Program() call and the command-line
invocation of the Visual Studio development environment program fails. The
test passes due to the existence of the test executable from the initial
build. The tests were modified to delete the test executable, object file,
and sconsign file prior to the command-line invocation of the VS development
binary.
- Method unlink_files was added to the TestCmd class that unlinks a list of
files from a specified directory. An attempt to unlink a file is made only
when the file exists; otherwise, the file is ignored.
- Fix issue 4320: add an optional argument list string to configure's CheckFunc
method so that the generated function argument list matches the function's
prototype when including a header file.

From Thaddeus Crews:
- Explicitly wrap non-serializable values in json dump
- Implemented SCons.Util.sctyping as a safe means of hinting complex types. Currently
only implemented for `Executor` as a proof-of-concept.

From William Deegan:
- Fix sphinx config to handle SCons versions with post such as: 4.6.0.post1

From Michał Górny:
- Remove unnecessary dependencies on pypi packages from setup.cfg

From Sten Grüner:
- Fix of the --debug=sconscript option to return exist statements when using return
statement with stop flag enabled

From Prabhu S. Khalsa:
- Fix typo in user documentation (issue 4458)

From Andrew Morrow:
- The NewParallel scheduler is now the default, the `tm_v2` flag is removed,
and the old scheduler is opt-in under `--experimental=legacy_sched`. Additionally,
the new scheduler is now used for -j1 builds as well.
- A python interpreter with support for the `threading` package is now required,
and this is enforced on startup. SCons currently sets its minimum supported
Python to 3.6, and it was not until Python 3.7 where `threading` became
default supported. In practice, we expect most real world Python 3.6 deployments
will have `threading` support enabled, so this will not be an issue.
- CacheDir writes no longer happen within the taskmaster critical section,
and therefore can run in parallel with both other CacheDir writes and the
taskmaster DAG walk.
- The NewParallel scheduler now only adds threads as new work requiring execution
is discovered, up to the limit set by -j. This should reduce resource utilization
when the achievable parallelism in the DAG is less than the -j limit.

From Mats Wichmann:
- Add support for Python 3.13 (as of alpha 2). So far only affects
expected bytecodes in ActionTests.py.
- sconsign cleanup - remove some dead code, minor manpage tweaks.
- Be more cautious about encodings fetching command output on Windows.
Problem occurs in piped-spawn scenario, used by Configure tests.
Fixes 3529.
- Clarify/fix documentation of Scanners in User Guide and Manpage.
Fixes 4468.
- Fix bad typing in Action.py: process() and strfunction().
- Add Pseudo() to global functions, had been omitted. Fixes 4474.
- Improve handling of file data that SCons itself processes - try
harder to decode non-UTF-8 text. SCons.Util.to_Text now exists
to convert a byte stream, such as "raw" file data. Fixes 3569, 4462.
The Pseudo manpage entry was updated to provide more clarity.
- Clarify how SCons finds the project top directory, and what that is used for.
- The internal routine which implements the PyPackageDir function
would fail with an exception if called with a module which is
not found. It will now return None. Updated manpage entry and
docstring..
- Doc update: standardized on the use of a new entity &MSVC; to
describe the Microsoft C++ compiler. Update the version table slightly.
Amplified the usage of MSVC_VERSION.
- Improve SharedLibrary docs a bit.
- More consistent use of &Python; in the manpage. A few links added.
A warning about overwriting env['ENV'] and one about Configure
checks possibly not running in in no-exec mode also added.
- Update warnings module: adds docstrings, drop three unused warnings
(DeprecatedSourceCodeWarning, TaskmasterNeedsExecuteWarning,
DeprecatedMissingSConscriptWarning) add two warnings to manpage
(cache-cleanup-error, future-reserved-variable), improve unittest, tweak
Sphinx build.
- Add locking around creation of CacheDir config file. Fixes 4489.
- Clarify MergeFlags usage of a dict argument.
- SCons documentation build can now be controlled through SKIP_DOC
variable - rather than just true/false can now specify
skip none, skip all, skip pdf docs, skip api docs.

4.6.0

From Max Bachmann:
- Add missing directories to searched paths for mingw installs

From Joseph Brill:
- Fix issue 4312: the cached installed msvc list had an indirect dependency
on the target architecture in the environment dictionary. The first call
to construct the installed msvc list now forces the target architecture to be
undefined, constructs the installed msvc list, and then restores the original
target architecture.
Note: an indirect dependency on the VSWHERE construction variable in the
environment remains.
- Fix issue 4312: explicitly guard against an empty regular expression list
when msvc is not installed.
- When trying to find a valid msvc batch file, check that the compiler executable
(cl.exe) exists for VS6 to VS2015 to avoid executing the msvc batch file. Always
check that the compiler executable is found on the msvc script environment path
after running the msvc batch file. Only use the sdk batch files when all of the
msvc script host/target combinations have been exhausted and a valid script was
not found.
- Add ARM64 host configurations for windows and msvc.
Note: VS2013 and earlier has not been tested on ARM64.
- If necessary, automatically define VSCMD_SKIP_SENDTELEMETRY for VS2019 and later
on ARM64 hosts when using an arm32 build of python to prevent a powershell dll
not found error pop-up window.
- Fix an issue where test SConfTests.py would fail when mscommon debugging
was enabled. The mscommon debug filter class registered with the logging
module was refactored.
- Add arm64 to the MSVS supported architectures list for VS2017 and later to be
consistent with the current documentation of MSVS_ARCH.
- Fix an issue with an unhandled MissingConfiguration exception due to an msvc
registry query that returns a path that does not exist. Multiple invocation
paths were not prepared to handle the MissingConfiguration exception. The
MissingConfiguration exception type was removed.
- The MSCommon module import was changed from a relative import to a top-level
absolute import in the following Microsoft tools: midl, mslib, mslink, mssdk, msvc,
msvs. Moving any of these tools that used relative imports to the scons site tools
folder would fail on import (i.e., the relative import paths become invalid when
moved).
- The detection of the msvc compiler executable (cl.exe) has been modified:
* The host os environment path is no longer evaluated for the existence of the
msvc compiler executable when searching the detection dictionary.
* The existence of the msvc compiler executable is checked in the detection
dictionary and the scons ENV path before the detection dictionary is merged
into the scons ENV.
* Different warnings are produced when the msvc compiler is not detected in the
detection dictionary based on whether or not an msvc compiler was detected in
the scons ENV path (i.e., a msvc compiler executable already exists in the
user's ENV path prior to detection).
* The warning message issued when a msvc compiler executable is not found in the
detection dictionary was modified by adding the word "requested":
Old warning: "Could not find MSVC compiler 'cl'."
New warning: "Could not find requested MSVC compiler 'cl'.".
* An additonal sentence is appended to the warning message issued when an msvc
compiler executable is not found in the msvc detection dictionary and is found
in the user's ENV path prior to detection:
" A 'cl' was found on the scons ENV path which may be erroneous."

From Vitaly Cheptsov:
- Fix race condition in `Mkdir` which can happen when two `SConscript`
are processed simultaneously by two separate build commands.

From William Deegan:
- The --debug flag now has a 'json' option which will write information
generated by --debug={count, memory, time, action-timestamps} and about
the build.
- Obsoleted YACCVCGFILESUFFIX, being replaced by YACC_GRAPH_FILE_SUFFIX.
If YACC_GRAPH_FILE_SUFFIX is not set, it will respect YACCVCGFILESUFFIX.

From Sten Grüner
- The newly added --debug=sconscript option (new) will output notices when
entering an exiting each SConscript as they are processed.

From Philipp Maierhöfer:
- Fix gfortran tool initialization. Defaults to using binary named gfortran
as would be expected, and properly set's SHFORTRAN flags to include -fPIC
where previously it was only doing so for the other fortran versions (F77,..)

From Jonathon Reinhart:
- Fix another instance of `int main()` in CheckLib() causing failures
when using -Wstrict-prototypes.

From Mats Wichmann
- C scanner's dictifyCPPDEFINES routine did not understand the possible
combinations of CPPDEFINES - not aware of a "name=value" string either
embedded in a sequence, or by itself. The conditional C scanner thus
did not always properly apply the defines. The regular C scanner does
not use these, so was not affected. [fixes 4193]
- Minor cleanup for ValidateOptions - docs and docstring tweaked,
add missed versionadded indicator.
- Added some typing annotations generated by a tool, to eliminate manual
work in future on things which are safe for the tool to produce.
Then manually fixed up some things related to bool that the tool did
not handly ideally. For example, simple functions which just did
"return 1" were interpreted by the tool as returning int, when bool
was really the intent. Functions/methods named like "is_*", "has_*",
"exists" are now pretty consistently marked as "-> bool".
- Simplify some code due to pylint observation: "C2801: Unnecessarily
calls dunder method __call__. Invoke instance directly."
- Python 3.9 dropped the alias base64.decodestring, deprecated since 3.1.
Only used in msvs.py. Use base64.decodebytes instead.
- When debugging (--debug=pdb), the filenames SConstruct and SConscript
are now recognized when manipulating breakpoints. Previously,
only a full pathname to an sconscript file worked, as pdb requires
a .py extension to open a file that is not an absolute path.
- SCons test runner now uses pathlib to normalize and compare paths
to test files.
- D compilers : added support for generation of .di interface files.
New variables DI_FILE_DIR, DI_FILE_DIR_PREFIX, DI_FILE_DIR_SUFFIX,
DI_FILE_SUFFIX.
- Fixed: when using the mingw tool, if an msys2 Python is used (os.sep
is '/' rather than the Windows default '\'), certain Configure checks
could fail due to the construction of the path to run the compiled check.
- Added effort to find mingw if it comes from Chocolatey install of msys2.
- Minor doc fixes: signature of Alias() now matches implementation
to avoid problem if kwargs used; case of Alias with no targets is
mentioned in text (was already shown in example); now mention that
Action([item]) does not return a ListAction - previously implied
that if arg was a list, a ListAction was *always* returned; mention
default Decider and sort the names of available decider functions,
and add a version marking. Minor fiddling with Alias.py docstrings.
- Python 3.12 support: new bytecodes for ActionTests.py, adapt to
changes to pathlib module in runtest.py (PosixPath no longer
converts slashes if given a Windows-style path). Also switch to
using `subTest` in `ActionTests`, so that we can see all 21 fails
due to bytecode changes (previously testcases aborted on the first
assert fail so we only saw seven), and use unittest asserts to
simplify complex printing stanzas.
- Added copyright headers to files in test/ that didn't have them.
- Drop three unused methods from the Environment Base class:
get_src_sig_type and get_tgt_sig_type, as well as "private"
_changed_source. These were orphaned when the long-deprecated
Source Signatures and Target Signatures were removed, these were
missed at that time.
- Remove dead code: some mocked classes in unit tests had methods
which have been removed from the Node class they're mocking,
there's no need to shadow those any more as there are no callers.
The methods are depends_on (base functionality removed in 2005)
and is_pseudeo_derived (base functionality removed in 2006). There
may well be more!
- Added pass_test() call to test/MSVC/MSVC_BATCH-spaces-targetdir.py.
It looked it was missing a more detailed check, but it should be
sufficient just to check the build worked. Renamed the fixture
dir to follow naming convention in test/MSVC overall, and added
a sconstest.skip file, also to follow convention.
- Marked some scanner methods as staticmethod.
- Class ActionBase is now an abstract base class to more accurately
reflect its usage. Derived _ActionAction inherits the ABC, so it
now declares (actually raises NotImplementedError) two methods it
doesn't use so it can be instantiated by unittests and others.
- The yacc tool now understands the bison behavior of --header,
--defines and --graph being called without option-argument as being
synonyms for -d (first two) and -g. -H also recognized as a synonym
for -d. Default value for $YACC_GRAPH_FILE_SUFFIX changed to '.gv'
to match current bison default (since bison 3.8). Set this variable
to '.dot' if using byacc. The graph file name (-g) is now generated
relative to the requested target file name, not to the source file
name, to match actual current behavior (only affects if target
explicitly requested with a different base name
than source). Docs updated. Fixes 4326 and 4327.
- Cleaned up dblite module (checker warnings, etc.).
- Some cleanup in the FortranCommon tool.
- Rewrite the internal _subproc routine - a new scons_subproc_run() now
makes use of Python's subprocess.run in a more natural way, getting
around some of the issues with attempted context manager use, fetching
output, etc. - we let the subprocess module do the hard work,
since it's well debugged and supported. _subproc is no longer
called by internal code, but remains in place in case there are builds
which call to it (even though it was never "published API").
- Changed the message about scons -H to clarify it shows built-in options.
- Improve CacheDir() Documentation.
- Release-building setup tweaked. (most of) the targets listed in
SCons' own "scons --help" now work again.
- Fix platform unit test on Windows for Py 3.12+. Fixes 4376.
- More tweaking of test framework overview (which is duplicated onto
the website, but not in the regular documentation section).
- Extend range of recognized Java versions to 20.
- Builder calls now accept PathLike objects in source lists. Fixes 4398.
- The Help() function now takes an additional keyword argument
keep_local: when starting to build a help message, you can now
retain help from AddOption calls, but omit help for SCons' own
command-line options with "Help(newtext, append=True, local_only=True)".
- A little more code "modernization", done via "pypgrade" tool set
to "3.6 and above" setting.
- Finish the change to make calling SConscript() with a nonexistent
file an error. It has issued a warning since 3.0, with "warn instead
of fail" deprecated since 3.1. Fixes 3958.
- Minor (non-functional) cleanup of some tests, particuarly test/MSVC.
- Added more error handling while reading msvc config cache.
(Enabled/specified by SCONS_CACHE_MSVC_CONFIG).
The existing cache will be discarded if there's a decode error reading it.
It's possible there's a race condition creating this issue in certain CI
builds. Also add a simple filesystem-based locking protocol to try to
avoid the problem occuring.
- Update the first two chapters on building with SCons in the User Guide.
- Update docs on Export/Import - make sure mutable/immutable status has
been mentioned.
- Some cleanup to the Util package, including renaming SCons.Util.types
to SCons.Util.sctypes to avoid any possible confusion with the
Python stdlib types module.
- TeX tests: skip tests that use makeindex or epstopdf not installed, or
if `kpsewhich glossaries.sty` fails.
- Added a .note.GNU-stack section to the test assembler files to
avoid the GNU linker issuing warnings for its absence.
- Eliminate more http: references (mostly in comments/docstrings where
they really weren't harmful). A few links labeled dead with no alt.
- Add JDK 21 LTS support
- Add a LIBLITERALPREFIX variable which can be set to the linker's
prefix for considering a library argument unmodified (e.g. for the
GNU linker, the ':' in '-l:libfoo.a'). Fixes Github issue 3951.
- Update PCH builder docs with some usage notes.

4.5.2

From Michał Górny:
- Remove the redundant `wheel` dependency from `pyproject.toml`,
as it is added automatically by the setuptools PEP517 backend.

From Mats Wichmann
- Fix a problem (4321) in 4.5.0/4.5.1 where ParseConfig could cause an
exception in MergeFlags when the result would be to add preprocessor
defines to existing CPPDEFINES. The following code illustrates the
circumstances that could trigger this:
env=Environment(CPPDEFINES=['a'])
env.Append(CPPDEFINES=['b'])
env.MergeFlags({'CPPDEFINES': 'c'})

4.5.1

From Mats Wichmann
- Fix a problem in 4.5.0 where using something like the following code
will cause a Clone()'d environment to share the CPPDEFINES with the
original Environment() which was cloned. Causing leakage of changes
to CPPDEFINES when they should be completely independent after the Clone.
env=Environment(CPPDEFINES=['a'])
env.Append(CPPDEFINES=['b']) (or AppendUnique,Prepend,PrependUnique)
env1=env.Clone()
env1.Append(CPPDEFINES=['c']) (or any other modification, but not overwriting CPPDEFINES
Now env['CPPDEFINES'] will contain 'c' when it should not.

4.5.0

From Anatoli Babenia:
- Do not initialize DefaultEnvironment when calling EnsureSConsVersion(),
EnsurePythonVersion(), Exit(), GetLaunchDir() and SConscriptChdir().
- Remove unused private method SConsEnvironment._exceeds_version().

From William Deegan:
- Added ValidateOptions() which will check that all command line options are in either
those specified by SCons itself, or by AddOption() in SConstruct/SConscript. It should
not be called until all AddOption() calls are completed. Resolves Issue 4187
- Refactored SCons/Taskmaster into a package. Moved SCons/Jobs.py into that package.
NOTE: If you hook into SCons.Jobs, you'll have to change that to use SCons.Taskmaster.Jobs
- Changed the Taskmaster trace logic to use python's logging module. The output formatting
should remain (mostly) the same. Minor update to unittest for this to adjust for 1 less newline.
- Migrated logging logic for --taskmastertrace to use Python's logging module. Added logging
to NewParallel Job class (Andrew Morrow's new parallel job implementation)
- Ninja: Fix execution environment sanitation for launching ninja. Previously if you set an
execution environment variable set to a python list it would crash. Now it
will create a string joining the list with os.pathsep
- Move execution environment sanitation from Action._subproc() to
SCons.Util.sanitize_shell_env(ENV)
- Moved rpm and debian directories under packaging
- Added logic to help packagers enable reproducible builds into packaging/etc/. Please
read packaging/etc/README.txt if you are interested.
- Added --experimental=tm_v2, which enables Andrew Morrow's new NewParallel Job implementation.
This should scale much better for highly parallel builds. You can also enable this via SetOption().
- Fixed command line argument --diskcheck: previously a value of 'none' was ignored.
SetOption('diskcheck','none') is unaffected, as it did not have the problem.
- Added overrides argument to SCons.Subst.scons_subst(), subst_list(), subst(), and Action's process(),
strfunction(). This allows passing a dictionary of envvars to override when evaluating subst()'d strings/lists
- Fixed Issue 4275 - when outputting compilation db and TEMPFILE was in use, the compilation db would have
command lines using the generated tempfile for long command lines, instead of the full command line for
the compilation step for the source/target pair.
- Renamed the qt tools to qt3 since the logic in that tool is only for QT version 3. Renamed all env vars
which affect qt3 from QT_ to QT3_. If you are still using SCons to build QT 3 code, you'll need to update
your SConscripts. Note that using 'qt' tool has been deprecated for some time.

From David H:
- Added JAVAPROCESSORPATH construction variable which populates -processorpath.
- Updated JavaScanner to scan JAVAPROCESSORPATH.

From Nickolai Korshunov
- Added FILE_ENCODING, to allow explicitly setting the text encoding for files
written by the Textfile() and Substfile() builders. If not specified, Textfile() and Substfile() builders
will write files as UTF-8. Fixed Issue 4302.

From Dan Mezhiborsky:
- Add newline to end of compilation db (compile_commands.json).

From Daniel Moody:
- Added error message to handle the case when SCons attempts to retrieve all the targets
for a specified builder from the CacheDir, fails to do so, and then runs into an error
when deleting the files which were retrieved. Previously if this happened there was no
errors or warnings.
- Fix issue 2757, where Configure checks that perform a check which reads a modified source
(including program, source or header file(s)) would incorrectly mark that file "up to date" so the
actual build would not see the file as modified. Leading to incorrect incremental builds.
Now configure checks now clear node info for non conftest nodes, so they will be re-evaluated for
the real taskmaster run when the build commences.

From Andrew Morrow
- Avoid returning UniqueList for `children` and other `Executor` APIs. This type
iterates more slowly than the builtin types. Also simplify uniquer_hashables to
use an faster implementation under the assumption of ordered dictionaries.

From Ryan Saunders:
- Fixed runtest.py failure on Windows caused by excessive escaping of the path to python.exe.

From Lukas Schrangl:
- Run LaTeX after biber/bibtex only if necessary

From Flaviu Tamas:
- Added -fsanitize support to ParseFlags(). This will propagate to CCFLAGS and LINKFLAGS.

From Mats Wichmann:
- A list argument as the source to the Copy() action function is now
correctly handled by converting elements to string. Copy errors out
if asked to copy a list to an existing non-directory destination.
Both the implementation and the strfunction which prints the progress
message were adjusted. Fixes 3009.
- doc: EnsureSConsVersion, EnsurePythonVersion, Exit, GetLaunchDir and
SConscriptChdir are now listed as Global functions only; the
Environment versions still work but are not documented.
- The Java scanner processing of JAVACLASSPATH for dependencies was
changed to split on os.pathsep instead of space, to match usage of
passing a path string like "xxx:yyy:zzz". This is not portable -
passing a POSIX-style path string (with ':') won't work on Windows
(';') - which is now documented with a hint to use a list instead
to be portable. Splitting on space broke paths with embedded spaces.
Fixes 4243.
- Cleanup: make sure BoolVariable usage in tests and examples uses Python
boolean values instead of 0/1.
- Stop telling people to run "python setup.py install" in the User Guide.
Adds new content on using virtualenvs to be able to have multiple
different SCons versions available on one system.
- Added the "DefaultEnvironment(tools=[])" stanza to a number of tests
that are known to be particularly slow. It's still just a tiny
speedup, but the Windows CI had been occasionally timing out,
so maybe this helps a bit.
- Remove an extra existence check in one ninja test that caused it
to be skipped on some otherwise-valid Windows installations.
- test framework tests now pass on Linux and Windows (the latter can
still run into problems on some configurations), and automated
tests are now run on changes in this area so future problems can
be spotted.
- The single-file Util module was split into a package with a few
functional areas getting their own files - Util.py had grown to
over 2100 lines.
- Add a zipapp package of scons-local: can use SCons from a local
file which does not need unpacking.
- Additional explanations for MSVSProject and MSVSSolution builders.
- Fix a problem (present in 4.4.0 only) where a Java inner class could
not be cached because the emitted filename contained a '$' and when
looked up through a node ended up generating a Python SyntaxError
because it was passed through scons_subst().
- Have the gfortran tool do a better job of honoring user preferences
for the dialect tools (F77, F90, F03 and F09, as well as the shared-library
equivalents SHF77, SHF90, SHF03, SHF09). Previously these were
unconditionally overwritten to 'gfortran'; the change should be more
in line with expectations of how these variables should work.
Also cleaned a few Fortran tests - test behavior does not change.
- Updated MSVC documentation - adds "version added" annotations on recently
added construction variables and provides a version-mapping table.
- Add Python 3.12 support, and indicate 3.11/3.12 support in package.

4.4.0

From Joseph Brill:
- Verify that a user specified msvc script (via MSVC_USE_SCRIPT) exists and raise an exception
when the user specified msvc script does not exist.
- Fix issue where if you only had mingw installed on a Windows system and no MSVC compiler, and
did not explicitly request the mingw tool, mingw tool initialization would fail and set the
default compiler to MSVC which wasn't installed, yielding broken build.
Updated mingw tool so that the generate and exists methods use the same mingw search paths
(issue 4134).
- Update the debug output written to stdout for MSVC initialization which is enabled by setting
SCONS_MSCOMMON_DEBUG=- to use the logging module. Also changed the debug output format
written to stdout to include more information about the source for each message of MSVC
initialization debugging output. A single space was added before the message for all
debugging output records written to stdout and to files.
- Refactor the data definitions for msvc configurations to allow derived data structures to be
constructed during initialization that removes the need for special case handling during
runtime execution. Special case handling of host/target combinations is eliminated and
replaced with pre-computed search lists that implicitly handle the differences between full
versions and express versions of msvc. This fixes an issue where Express versions of the MSVC
compiler were not detected due to differences in initial msvc detection and msvc batch file
determination when configuring the build environment. This could lead to build failures when
only an MSVC Express instance is installed and the MSVC version is not explicitly specified
(issue 2668 and issue 2697).
- Added MSVC_USE_SETTINGS construction variable to pass a dictionary to configure the msvc compiler
system environment as an alternative to bypassing Visual Studio autodetection entirely.
- Added MSVC_SDK_VERSION construction variable which allows building with a specific Microsoft
SDK version. This variable is used with the msvc batch file determined via autodetection subject
to validation constraints. Refer to the documentation for additional requirements and validation
details.
- Added MSVC_TOOLSET_VERSION construction variable which allows building with a specific toolset
version. This variable is used with the msvc batch file determined via autodetection subject to
validation constraints. This variable does not affect the autodetection and selection of msvc
instances. The toolset version is applied after an msvc instance is selected. This could be the
default version of msvc. Refer to the documentation for additional requirements and validation
details. Addresses issue 3265, issue 3664, and pull request 4149.
- Added MSVC_SPECTRE_LIBS construction variable which allows building with spectre-mitigated
Visual C++ libraries. This variable is used with the msvc batch file determined via autodetection
subject to validation constraints. Refer to the documentation for additional requirements and
validation details.
- Added MSVC_SCRIPT_ARGS construction variable which specifies command line arguments that are
passed to the msvc batch file determined via autodetection subject to validation constraints.
Refer to the documentation for additional requirements and validation details. Addresses
enhancement issue 4106.
- An exception is raised when MSVC_UWP_APP is enabled for Visual Studio 2013 and earlier.
Previous behavior was to silently ignore MSVC_UWP_APP when enabled for Visual Studio 2013
and earlier. Refer to the documentation for additional requirements and validation details.
MSVC_UWP_APP was extended to accept True, False, and None in addition to '1' and '0'.
- The imported system environment variable names for MSVC 7.0 and 6.0 have been changed to the
names set by their respective installers. Prior to this change, bypassing MSVC detection by
specifying the MSVC 7.0 batch file directly would fail due to using an erroneous environment
variable name. Arguments are no longer passed to the MSVC 6.0 to 7.1 batch files as no
arguments are required and could improve the effectiveness of the internal MSVC cache.
- Propagate the OS and windir environment variables from the system environment to the msvc
environment. The OS and windir environment variables are used in the MSVC 6.0 batch file
and the SDK 6.0-7.1 SetEnv.cmd batch files. Inclusion of the OS and windir environment
variables eliminates some partial paths and warnings generated by the MSVC 6.0 and SDK
6.0-7.1 batch files when the variables are not defined.
Note: Attempting to run the SDK 6.0-7.1 batch files directly via MSVC_USE_SCRIPT can lead to
build failures and/or incomplete build environments. The SDK 6.0-7.1 batch files
require delayed expansion to be enabled which is currently not supported and is
typically not enabled by default on the host system. The batch files may also require
environment variables that are not included by default in the msvc environment.
- Suppress issuing a warning when there are no installed Visual Studio instances for the default
tools configuration (issue 2813). When msvc is the default compiler because there are no
compilers installed, a build may fail due to the cl.exe command not being recognized. At
present, there is no easy way to detect during msvc initialization if the default environment
will be used later to build a program and/or library. There is no error/warning issued for the
default tools as there are legitimate SCons uses that do not require a c compiler.
- Added a global policy setting and an environment construction variable for specifying the
action to be taken when an msvc request cannot be satisfied. The available options are "error",
"exception", "warning", "warn", "ignore", and "suppress". The global policy variable may be
set and retrieved via the functions msvc_set_notfound_policy and msvc_get_notfound_policy,
respectively. These two methods may be imported from SCons.Tool.MSCommon. The environment
construction variable is MSVC_NOTFOUND_POLICY. When defined, the environment construction
variable overrides the global policy setting for a given environment. When the active policy
is "error" or "exception", an MSVCVersionNotFound exception is raised. When the active policy
is "warning" or "warn", a VisualCMissingWarning warning is issued and the constructed
environment is likely incomplete. When the active policy is "ignore" or "suppress", no action
is taken and the constructed environment is likely incomplete. As implemented, the default
global policy is "warning". The ability to set the global policy via an SCons command-line
option may be added in a future enhancement.
- Added a global policy setting and an environment construction variable for specifying the
action to be taken when msvc script errors are detected. The available options are "error",
"exception", "warning", "warn", "ignore", and "suppress". The global policy variable may be
set and retrieved via the functions msvc_set_scripterror_policy and msvc_get_scripterror_policy,
respectively. These two methods may be imported from SCons.Tool.MSCommon. The environment
construction variable is MSVC_SCRIPTERROR_POLICY. When defined, the environment construction
variable overrides the global policy setting for a given environment. When the active policy
is "error" or "exception", an MSVCScriptExecutionError exception is raised when msvc batch file
errors are detected. When the active policy is "warning" or "warn", an MSVCScriptExecutionWarning
warning is issued when msvc batch file errors are detected. When the active policy is "ignore" or
"suppress", msvc batch error messages are suppressed. As implemented, the default global policy
is "ignore". The ability to set the global policy via an SCons command-line option may be added
in a future enhancement.
- Added experimental function msvc_query_version_toolset to SCons.Tool.MSCommon. Given a version
specification, this function will return an msvc version and an msvc toolset version. The msvc
toolset version may be None. The msvc version and msvc toolset version can be used in the
environment construction variables MSVC_VERSION and MSVC_TOOLSET_VERSION, respectively. The
version specification may be an msvc version or an msvc toolset version. This is a proxy for
using an msvc toolset version to select an msvc instance. This function may be removed when an
msvc toolset version is used during msvc instance selection.
- Modify the MSCommon logger configuration to be independent of the root logger. This fixes an issue
when multiple loggers are created and the MSCommon logger added computed fields to the root logger
that are not present in other logging instances.
- Modify the MSVC_USE_SCRIPT_ARGS test fixture to disable the msvc cache. This fixes an issue where
the MSVC_USE_SCRIPT_ARGS test for success relied on a debug log message that was not produced when
the msvc cache file exists and the test keys are already in the cache as the msvc script invocation
was bypassed.

From William Deegan:
- Fix check for unsupported Python version. It was broken. Also now the error message
will include what is the minimum supported version of Python
- Fix ActionTests to work with python 3.10.1 (and higher)
NOTE: If you build with Python 3.10.0 and then rebuild with 3.10.1 (or higher), you may
see unexpected rebuilds. This is due to Python internals changing which changed
the signature of a Python Action Function.
- Fix a number of Python ResourceWarnings which are issued when running SCons and/or it's tests
with python 3.9 (or higher)
- Action._subproc() can now be used as a python context manager to ensure that the
POpen object is properly closed.
(Thanks to Mats Wichmann for catching that DummyPopen needed additional logic)
- Added project_url for mailing lists and Discord
- Updated project url in steup.cfg to be https instead of http
- Updated setup.cfg to remove Python 3.5 and add Python 3.10
- Added default values for source and target arguments to _defines() function. This
is used to expand CPPDEFINES (and others). Previous change added those arguments
with no defaults, so old usage where _defines() was called without source and target
arguments would yield an exception. This issue was found via qt4 and qt5 tools in
scons-contrib https://github.com/SCons/scons-contrib/issues/45

From David H:
- Add JavaScanner to include JAVACLASSPATH as a dependency when using the Java tool.
- Fix incorrect Java classpath generation when a NodeList is used as part of any JAVA*PATH variables.

From Daniel Moody:
- Add cache-debug messages for push failures.
- Ninja: Changed generated build.ninja file to run SCons only build Actions via
a SCons Deamon. Added logic for starting and connecting to SCons daemon (currently
only used for ninja)
- Ninja: Fix issue where Configure files weren't being properly processed when build run
via ninja.
- Ninja: Added ninja mingw support and improved ninja CommandGeneratorAction support.
- Ninja: Update ninja file generation to only create response files for build commands
which exceed MAXLINELENGTH
- Ninja: Added NINJA_GENERATED_SOURCE_ALIAS_NAME which allows user to specify an
Alias() which the ninja tool can use to determine which files are generated sources.
If this is not set by the user then the ninja tool will still dynamically determine
which files are generated sources based on NINJA_GENERATED_SOURCE_SUFFIXES, and create
a phony target _ninja_generated_sources. Generated sources will be built first by
ninja. This is needed because ninja cannot determine which generated sources are
required by other build targets. Code contributed by MongoDB
The downstream commit is here:
https://github.com/mongodb/mongo/commit/2fef432fa6e7cf3fd4f22ba3b193222c2887f14f
- Ninja: Added special case for ninja scons daemon to work in win32 python3.6 environments.
This particular environment does a bad job managing popen standard file handles, so
some special workarounds are needed.
- Ninja:Added user configurable setting of ninja depfile format via NINJA_DEPFILE_PARSE_FORMAT.
Now setting NINJA_DEPFILE_PARSE_FORMAT to [msvc,gcc,clang] can force the ninja expected
format. Compiler tools will also configure the variable automatically.
- Ninja: Made ninja tool force the ninja file as the only target.
- Ninja: Improved the default targets setup and made sure there is always a default target for
the ninja file, which excludes targets that start and stop the daemon.
- Ninja: Update ninja tool so targets passed to SCons are propagated to ninja when scons
automatically executes ninja.
- Small refactor of scons daemons using a shared StateInfo class for communication
between the scons interactive thread and the http server thread. Added error handling
for scons interactive failing to startup.
- Ninja: Updated ninja scons daemon scripts to output errors to stderr as well as the daemon log.
- Ninja: Fix typo in ninja scons daemon startup which causes ConnectionRefusedError to not retry
- Added SHELL_ENV_GENERATORS construction variable. This variable should be set to a list
(or an iterable) which contains functions to be called in order
when constructing the execution environment (Generally this is the shell environment
variables). This allows the user to customize how (for example) PATH is constructed.
Note that these are called for every build command run by SCons. It could have considerable
performance impact if not used carefully.
to connect to the server during start up.
- lex: Fixed an issue with the lex tool where file arguments specified to either "--header-file="
or "--tables-file=" which included a space in the path to the file would be processed incorrectly
- Ninja: added option "--skip-ninja-regen" to enable skipping regeneration of the ninja file
if scons can determine the ninja file doesnot need to be regenerated, which will also
skip restarting the scons daemon. Note this option is could result in incorrect rebuilds
if scons Glob or scons generated files are used in ninja build target's command lines.
- Ninja: Added new alias "shutdown-ninja-scons-daemon" to allow ninja to shutdown the daemon.
Also added cleanup to test framework to kill ninja scons daemons and clean ip daemon logs.
NOTE: Test for this requires python psutil module. It will be skipped if not present.
- Ninja: Added command line variable NINJA_CMD_ARGS that allows to pass through ninja command line args.
This can also be set in your Environment().

From Mats Wichmann:
- Tweak the way default site_scons paths on Windows are expressed to
conform to conventions (what they actually resolve to is unchanged),
drop a Py2 workaround, and pick a better "system" path, old one
remains supported (%AllUsersProfile%\scons\site_scons vs old
%AllUsersProfile%\Application Data\scons\site_scons).
- Fix testsuite to work on Windows systems where there is no usable
association for running .py files directly. There are a few tests where
we need to do this for internal reasons, those are skipped in that case.
Bad association could mean some other tool took it over (Visual
Studio Code is known to do this), or no association at all.
- Updated debug code in MSVC and MSVS tools to conform to the
suggested "lazy interpolation" use of the Python logging module.
Calls now look like 'debug("template %s", text)' rather than
'debug("template %s" % text)' so the logging system does the
interpolation only when/if needed (was a pylint warning).
- Update Help (-H) output a bit. Drop "ignored for compat" entry.
Pass window size to formatter so it formats for wider displays too.
- runtest.py now accepts -j 0 to auto-detect number of usable
processors for testing threads.
- Fixed crash in C scanner's dictify_CPPDEFINES() function which happens if
AppendUnique is called on CPPPATH. (Issue 4108).
- The MSVC script_env_cache now contains a sanity check: if the retrieved
tools path does not exist, the entry is invalidated so it will
be recomputed, in an attempt to avoid scons failing when certain
compiler version bumps have taken place. The dictionary key (uses
the name of a batch file and any arguments which may have been
passes), is now computed a bit differently: the dashes are left
off if there are no arguments. The default cachefile is changed
to have a .json suffix, for better recognition on Windows since
the contents are json.
- As "code modernization" all of SCons now uses the current super()
zero-argument syntax instead of direct calls to a parent class method
or the super() two-argument syntax.
- Renamed ParseFlag's internal data structure to "mapping" instead of
"dict" (avoid redefining builtin)
- Fix an old use-before-set bug in tex tool (issue 2888)
- Fix a test harness exception returning stderr if a wait_for timed out.
- ParseConfig now correctly passes the *unique* flag to a user-supplied
flag-merging function.
- Restore the ability of the content-timestamp decider to see that a
a source which is a symlink has changed if the file-system target of
that link has been modified (issue 3880)
- Modernize a few tests that use now-deprecated unittest.getTestCaseNames
and unittest.makeSuite - Python itself suggests the replacements.
- SCons.Tool.find_program_path now takes an optional add_path argument
to add a path to the execution environment if it was discovered in
default_paths. Previously, the routine, called by many tool modules,
never altered the execution environment, leaving it to the tools.
- A new construction variable FORTRANCOMMONFLAGS is added which is
applied to all Fortran dialects, in case someone needs to set some
flags globally. FORTRANFLAGS looked like it was intended for that,
but was not applied to other dialects, and e2e tests explicitly checked
that FORTRANFLAGS did not propagate outside the FORTRAN dialect,
so the conclusion is that behavior is intentional (issue 2257)
- SCons programmatic importing (tool modules and platform modules)
no longer uses the deprecated (since Py 3.10) importlib.load_module
routine, shifting to the preferred exec_module. Old Python 2 compatible
import fallback (using the imp module) in tool module loading is dropped.
Tool module loading no longer special-cases Jython, which is a dead
project as far as SCons (no timeline in sight for Python 3 support).
- Improvements to lex and yacc tools: better documentation of
extra-file options, add test for extra-file behavior.
- Two new construction variables are introduced for lex (LEX_HEADER_FILE
and LEX_TABLES_FILE) as the preferred way of specifying these extra-file
options.
- Two new construction variables are introduced for yacc
(YACC_HEADER_FILE and YACC_GRAPH_FILE) as the preferred way of
specifying these extra-file options.


From Zhichang Yu:
- Added MSVC_USE_SCRIPT_ARGS variable to pass arguments to MSVC_USE_SCRIPT.
- Added Configure.CheckMember() checker to check if struct/class has the specified member.

From Ivan Kravets, PlatformIO:
- Conditional C/C++ Preprocessor: Strip shell's backslashes from the computed include (-DFOO_H=\"foo.h\")

Page 1 of 13

© 2024 Safety CLI Cybersecurity Inc. All Rights Reserved.