cardinal_pythonlib.cmdline

Original code copyright (C) 2009-2022 Rudolf Cardinal (rudolf@pobox.com).

This file is part of cardinal_pythonlib.

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Functions for manipulating command-line parameters.

cardinal_pythonlib.cmdline.cmdline_quote(args: List[str], platform: int | str = 'this') → str[source]

Convert a list of command-line arguments to a suitably quoted command-line string that should be copy/pastable into a comand prompt.

cardinal_pythonlib.cmdline.cmdline_quote_posix(seq: List[str]) → str[source]

Quotes arguments for POSIX, producing a single string suitable for copying/pasting.

Based on subprocess.list2cmdline().

cardinal_pythonlib.cmdline.cmdline_split(s: str, platform: int | str = 'this') → List[str][source]

As per https://stackoverflow.com/questions/33560364/python-windows-parsing-command-lines-with-shlex.

Multi-platform variant of shlex.split() for command-line splitting. For use with subprocess, for argv injection etc. Using fast REGEX.

Parameters:

  • s – string to split

  • platform –

    • 'this' = auto from current platform;

    • 1 = POSIX;

    • 0 = Windows/CMD

    • (other values reserved)