oslex2 0.1.5__py3-none-any.whl

oslex2/__init__.py

@@ -0,0 +1,69 @@
+import sys
+from typing import List
+
+
+def is_posix() -> bool:
+    """
+    Returns whether the system running Python is POSIX compatible.
+    This is the condition for oslex.underlying being shlex.
+    This is also the condition for os.path being posixpath.
+    """
+    return "posix" in sys.builtin_module_names
+
+
+def is_windows() -> bool:
+    """
+    Returns whether the system running Python is Windows based.
+    This is the condition for oslex.underlying being mslex.
+    This is also the condition for os.path being ntpath.
+    """
+
+    if is_posix():
+        # This early return is likely redundant, but we want to be 100% equivalent to the if-elseif structure found in os.py
+        # See https://github.com/python/cpython/blob/3.7/Lib/os.py
+        return False
+
+    return "nt" in sys.builtin_module_names
+
+
+# Import OS-specific module
+
+if is_posix():
+    import shlex as underlying
+elif is_windows():
+    # mslex has no type annotations -> we have to ignore the "import" error
+    # also, mypy does not understand conditional importing, so it thinks we are redefining the name "underlying" -> we have to ignore the "no-redef" error
+    import mslex as underlying  # type: ignore[import, no-redef]
+else:
+    raise ImportError("no os specific module found")
+
+# Define functions
+
+
+def quote(s: str, **kwargs) -> str:
+    """
+    Return a shell-escaped version of the string s. The returned value is a string that can safely be used as one token in a shell command line, for cases where you cannot use a list.
+    This function is safe to use both for POSIX-compatible shells and for Windows's cmd.
+    """
+    return underlying.quote(s, **kwargs)
+
+
+def split(s: str, **kwargs) -> List[str]:
+    """
+    Split the string s using shell-like syntax.
+    This function is safe to use both for POSIX-compatible shells and for Windows's cmd.
+    """
+    return underlying.split(s, **kwargs)
+
+
+def join(split_command: List[str]) -> str:
+    """
+    Concatenate the tokens of the list split_command and return a string. This function is the inverse of split().
+    The returned value is shell-escaped to protect against injection vulnerabilities (see quote()).
+    This function is safe to use both for POSIX-compatible shells and for Windows's cmd.
+    """
+    # shlex only has join() since Python 3.8
+    # mslex doesn't have it at all
+    # It's easier to just implement it without trying to import the functionality
+    # Implementation is the same as shlex.join(), see https://github.com/python/cpython/blob/3.8/Lib/shlex.py
+    return " ".join(quote(arg) for arg in split_command)

oslex2-0.1.5.dist-info/METADATA

@@ -0,0 +1,38 @@
+Metadata-Version: 2.3
+Name: oslex2
+Version: 0.1.5
+Summary: OS-independent wrapper for shlex and mslex, meant to be temporary until original repo updates PR
+Project-URL: Homepage, https://github.com/petamas/oslex
+Project-URL: Bug Tracker, https://github.com/petamas/oslex/issues
+Author-email: Jessie Wilson <jessielw4049@gmail.com>
+License-File: LICENSE
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.5
+Requires-Dist: mslex
+Description-Content-Type: text/markdown
+
+# oslex
+
+`oslex` is an OS-independent wrapper for [`shlex`](https://docs.python.org/3/library/shlex.html) and [`mslex`](https://pypi.org/project/mslex/).
+
+Its main purpose is to provide functions similar in functionality to `shlex.quote()`, `shlex.split()` and `shlex.join()` on both Windows and POSIX-compatible platforms.
+
+This goal is achieved by simply forwarding the calls to either `shlex` (from the standard library) on POSIX-compatible systems, or the excellent `mslex` library (written by Lawrence D'Anna / @smoofra) on Windows.
+
+In other words, `oslex` is to `shlex`/`mslex` what `os-path` is to `posixpath`/`ntpath`.
+
+## Licensing
+
+This library itself is licensed under the MIT license.
+
+`oslex` uses the [`mslex`](https://pypi.org/project/mslex/) library, which is distributed under the Apache 2.0 license.

oslex2-0.1.5.dist-info/RECORD

@@ -0,0 +1,6 @@
+oslex2/__init__.py,sha256=kVUF4amT10x17VEVoMhb43mFMaMr9xl-Kf9vpLVhPg8,2654
+oslex2/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+oslex2-0.1.5.dist-info/METADATA,sha256=AyxwQEVrc02RP6AAnanOEj2E4pY8C4dDWjUB3YDlXaM,1787
+oslex2-0.1.5.dist-info/WHEEL,sha256=uNdcs2TADwSd5pVaP0Z_kcjcvvTUklh2S7bxZMF8Uj0,87
+oslex2-0.1.5.dist-info/licenses/LICENSE,sha256=ZXB8tGHQGN6AIY-xxMUcN60DM-WA5XusmM6JlArTpm0,1091
+oslex2-0.1.5.dist-info/RECORD,,

oslex2-0.1.5.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.22.4
+Root-Is-Purelib: true
+Tag: py3-none-any

oslex2-0.1.5.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Tamás PEREGI
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.