Merge pull request #694 from amoffat/develop

2.0.5 release

.github/workflows/main.yml

@@ -92,7 +92,7 @@ jobs:
 
       - name: Run tests
         run: |
-          SH_TESTS_RUNNING=1 SH_TESTS_USE_SELECT=${{ matrix.use-select }} LANG=${{ matrix.lang }} poetry run coverage run -a -m unittest
+          SH_TESTS_RUNNING=1 SH_TESTS_USE_SELECT=${{ matrix.use-select }} LANG=${{ matrix.lang }} poetry run coverage run -a -m pytest
 
       - name: Store coverage
         uses: actions/upload-artifact@v2

.gitignore

@@ -6,3 +6,6 @@ __pycache__/
 /.venv/
 /build
 /dist
+/docs/build
+/TODO.md
+/htmlcov/

.readthedocs.yaml

@@ -0,0 +1,29 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.10"
+  jobs:
+    post_create_environment:
+      - pip install poetry
+      - poetry config virtualenvs.create false
+    post_install:
+      - poetry install
+      - pip install -e .
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/source/conf.py
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+    - requirements: docs/requirements.txt

.vscode/tasks.json

@@ -0,0 +1,29 @@
+{
+  // See https://go.microsoft.com/fwlink/?LinkId=733558
+  // for the documentation about the tasks.json format
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "Doc builder",
+      "type": "shell",
+      "command": "source ${workspaceFolder}/.venv/bin/activate && find source/ | entr -s 'make clean && make html'",
+      "options": {
+        "cwd": "${workspaceFolder}/docs"
+      },
+      "problemMatcher": [],
+      "group": {
+        "kind": "build"
+      },
+      "isBackground": true,
+      "presentation": {
+        "echo": true,
+        "reveal": "always",
+        "focus": true,
+        "panel": "dedicated",
+        "showReuseMessage": false,
+        "clear": true,
+        "close": true
+      }
+    }
+  ]
+}

CHANGELOG.md

@@ -1,8 +1,13 @@
 # Changelog
 
+## 2.0.5 - 8/7/23
+
+- Allow nested `with` contexts [#690](https://github.com/amoffat/sh/issues/690)
+- Call correct asyncio function for getting event loop [#683](https://github.com/amoffat/sh/issues/683)
+
 ## 2.0.4 - 5/13/22
 
-- Allow `ok_code` to be used with `fg` [#655](https://github.com/amoffat/sh/pull/655)
+- Allow `ok_code` to be used with `fg` [#665](https://github.com/amoffat/sh/pull/665)
 - Make sure `new_group` never creates a new session [#675](https://github.com/amoffat/sh/pull/675)
 
 ## 2.0.2 / 2.0.3 (misversioned) - 2/13/22

MIGRATION.md

@@ -80,6 +80,28 @@ Previously, if the first argument of a sh command was an instance of `RunningCom
 it was automatically fed into the process's STDIN. This is no longer the case and you
 must explicitly use `_in=`.
 
+```python
+from sh import wc,ls
+
+print(wc(ls("/home/<user>", "-l"), "-l"))
+```
+
+Becomes:
+
+```python
+from sh import wc,ls
+
+print(wc("-l", _in=ls("/home/<user>", "-l")))
+```
+
+Or:
+
+```python
+from sh import wc,ls
+
+print(wc("-l", _in=ls("/home/<user>", "-l", _return_cmd=True)))
+```
+
 ### Workaround
 
 None

README.rst

@@ -15,16 +15,13 @@
 .. image:: https://img.shields.io/pypi/pyversions/sh.svg?style=flat-square
     :target: https://pypi.python.org/pypi/sh
     :alt: Python Versions
-.. image:: https://img.shields.io/travis/amoffat/sh/master.svg?style=flat-square
-    :target: https://travis-ci.org/amoffat/sh
-    :alt: Build Status
 .. image:: https://img.shields.io/coveralls/amoffat/sh.svg?style=flat-square
     :target: https://coveralls.io/r/amoffat/sh?branch=master
     :alt: Coverage Status
 
 |
 
-sh is a full-fledged subprocess replacement for Python 3.8 - 3.10, PyPy and PyPy3
+sh is a full-fledged subprocess replacement for Python 3.8 - 3.11, and PyPy
 that allows you to call *any* program as if it were a function:
 
 .. code:: python
@@ -37,7 +34,7 @@ sh is *not* a collection of system commands implemented in Python.
 sh relies on various Unix system calls and only works on Unix-like operating
 systems - Linux, macOS, BSDs etc. Specifically, Windows is not supported.
 
-`Complete documentation here <https://amoffat.github.io/sh>`_
+`Complete documentation here <https://sh.readthedocs.io/>`_
 
 Installation
 ============
@@ -55,11 +52,6 @@ Support
 Developers
 ==========
 
-Updating the docs
------------------
-
-Check out the `gh-pages <https://github.com/amoffat/sh/tree/gh-pages>`_ branch and follow the ``README.rst`` there.
-
 Testing
 -------
 
@@ -76,7 +68,7 @@ Coverage
 
 First run all of the tests::
 
-    $> SH_TESTS_RUNNING=1 coverage run --source=sh -m unittest
+    $> SH_TESTS_RUNNING=1 coverage run --source=sh -m pytest
 
 This will aggregate a ``.coverage``.  You may then visualize the report with::
 

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?= -a -W
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/requirements.txt

@@ -0,0 +1 @@
+toml==0.10.2

docs/source/conf.py

@@ -0,0 +1,62 @@
+# Configuration file for the Sphinx documentation builder.
+
+from pathlib import Path
+
+import toml
+
+_THIS_DIR = Path(__file__).parent
+_REPO = _THIS_DIR.parent.parent
+_PYPROJECT = _REPO / "pyproject.toml"
+
+pyproject = toml.load(_PYPROJECT)
+nitpicky = True
+
+nitpick_ignore = [
+    ("py:class", "Token"),
+    ("py:class", "'Token'"),
+]
+
+nitpick_ignore_regex = [
+    ("py:class", r".*lark.*"),
+]
+
+version = pyproject["tool"]["poetry"]["version"]
+release = version
+
+# -- Project information
+
+project = "sh"
+copyright = "2023, Andrew Moffat"
+author = "Andrew Moffat"
+
+# -- General configuration
+
+extensions = [
+    "sphinx.ext.duration",
+    "sphinx.ext.doctest",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.todo",
+]
+
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3/", None),
+    "sphinx": ("https://www.sphinx-doc.org/en/master/", None),
+    "lark": ("https://lark-parser.readthedocs.io/en/latest/", None),
+    "jinja2": ("https://jinja.palletsprojects.com/en/latest/", None),
+}
+intersphinx_disabled_domains = ["std"]
+
+templates_path = ["_templates"]
+
+# -- Options for HTML output
+
+html_theme = "sphinx_rtd_theme"
+
+# -- Options for EPUB output
+epub_show_urls = "footnote"
+
+autodoc_typehints = "both"
+
+add_module_names = False

docs/source/examples/done.rst

@@ -0,0 +1,24 @@
+Here's an example of using :ref:`done` to create a multiprocess pool, where
+``sh.your_parallel_command`` is executed concurrently at no more than 10 at a
+time:
+
+.. code-block:: python
+
+    import sh
+    from threading import Semaphore
+
+    pool = Semaphore(10)
+
+    def done(cmd, success, exit_code):
+        pool.release()
+
+    def do_thing(arg):
+        pool.acquire()
+        return sh.your_parallel_command(arg, _bg=True, _done=done)
+
+    procs = []
+    for arg in range(100):
+        procs.append(do_thing(arg))
+
+    # essentially a join
+    [p.wait() for p in procs]