shlex for windows
- Free software: Apache Software License 2.0
- Documentation: https://mslex.readthedocs.io.
This is the missing shlex package for windows shell quoting. It provides three functions -- split, quote, and join -- just like shlex.
Since time immemorial, windows quoting behavior has been strange. Prior to
(I think) Visual Studio 2005, it exhibited the extremely strange modulo 3
periodic behavior which is emulated here in split_msvcrt()
. Programs
compiled with the C runtime from Visual Studio 2005 and later exhibit the
somewhat less strange behavior emulated in split_ucrt()
.
Microsoft still ships a dll called msvcrt.dll
as part of Windows,
for compatibility reasons. And even though they have been very clear in
their documentation that nobody should ever link against this dll, people
still do, either for compatibility reasons of their own, or because it
is universally available on any version of windows you might care about
without needing to run an installer. And msvcrt.dll
preserves the
extremely strange argument parsing behavior from prior to VS 2005.
You can can download the latest version of msys2 today and build an
executable linking msvcrt.dll
on Windows 11, and it will parse
arguments like Windows 95.
mslex
will produce quoted strings that will be parsed correctly by
either modern C runtimes or by msvcrt.dll
. When parsing, mslex
parses it both ways and raises an error if they disagree. This can
be overridden by passing ucrt=True
or ucrt=False
to split
.
See also:
- Parsing C Command Line Arguments
- Windows is not a Microsoft Visual C/C++ Run-Time delivery channel
- How a Windows Program Splits Its Command Line Into Individual Arguments
- Everyone quotes command line arguments the wrong way
If you want to automatically use mslex on Windows, and shlex otherwise, check out the oslex package.