oslex2 0.1.5__tar.gz

oslex2-0.1.5/.editorconfig

@@ -0,0 +1,6 @@
+[*]
+trim_trailing_whitespace = true
+insert_final_newline = true
+indent_style = "space"
+indent_size = 4
+

oslex2-0.1.5/.gitignore

@@ -0,0 +1,160 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

oslex2-0.1.5/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.

oslex2-0.1.5/PKG-INFO

@@ -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/README.md

@@ -0,0 +1,15 @@
+# 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/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/pyproject.toml

@@ -0,0 +1,33 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "oslex2"
+version = "0.1.5"
+authors = [
+	{ name="Jessie Wilson", email="jessielw4049@gmail.com" },
+]
+description = "OS-independent wrapper for shlex and mslex, meant to be temporary until original repo updates PR"
+readme = "README.md"
+requires-python = ">=3.5"
+dependencies = [
+  "mslex",
+]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.6",
+    "Programming Language :: Python :: 3.7",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: MacOS",
+    "Operating System :: Microsoft :: Windows",
+    "Operating System :: POSIX",
+]
+
+[project.urls]
+"Homepage" = "https://github.com/petamas/oslex"
+"Bug Tracker" = "https://github.com/petamas/oslex/issues"

oslex2-0.1.5/test.py

@@ -0,0 +1,6 @@
+import oslex
+
+
+test = oslex.split("cmd /c echo hi!")
+
+print(test)