Merge branch '3.9' into extending-newtypes

Author: Catadanna

.github/pr-title-checker-config.json

@@ -0,0 +1,15 @@
+{
+    "problemMatcher": [
+        {
+            "owner": "pospell",
+            "pattern": [
+                {
+                    "regexp": "^(.*):(\\d+):(.*)$",
+                    "file": 1,
+                    "line": 2,
+                    "message": 3
+                }
+            ]
+        }
+    ]
+}

.github/problem-matchers/pospell.json

@@ -11,51 +11,58 @@ on:
       - '*.*'
 
 jobs:
-  pospell:
-    name: 'Orthographe'
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - name: Install pospell
-        run: |
-          sudo apt-get update
-          sudo apt-get install -y hunspell hunspell-fr-comprehensive
-          sudo python3 -m pip install pospell
-      - name: Run pospell
-        run: pospell -p dict -l fr_FR *.po */*.po
-
-  powrap:
-    name: 'Ensure wrapping consistency'
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - name: Install powrap
-        run: |
-          sudo apt-get update
-          sudo apt-get install gettext
-          sudo python3 -m pip install powrap
-      - name: Run powrap
-        run: powrap --check --quiet *.po */*.po
+  checks:
+    strategy:
+      matrix:
+        tool:
+          - name: Orthographe
+            package: pospell
+            apt_dependencies: hunspell hunspell-fr-comprehensive
+            command: 'pospell -p dict -l fr_FR $CHANGED_PO_FILES'
+          - name: Longueur des lignes
+            package: powrap
+            apt_dependencies: gettext
+            command: 'powrap --check --quiet --diff $CHANGED_PO_FILES'
+          - name: Grammaire
+            package: padpo
+            command: 'padpo -i $CHANGED_PO_FILES 2>&1 | grep -v -Ff padpo.ignore'
 
-  padpo:
-    name: 'Grammaire'
+    name: ${{ matrix.tool.name }} (${{ matrix.tool.package }})
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
+      - name: Register problem matchers
+        run: echo "::add-matcher::.github/problem-matchers/pospell.json"
+      - uses: lots0logs/gh-action-get-changed-files@2.1.4
+        id: changed_files
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
       - uses: actions/setup-python@v2
         with:
           python-version: '3.9'
-      - name: Install padpo
+      - name: Install ${{ matrix.tool.package }}
+        run: |
+          [ -n "${{ matrix.tool.apt_dependencies }}" ] && sudo apt-get update && sudo apt-get install -y ${{ matrix.tool.apt_dependencies }}
+          python -m pip install --upgrade pip setuptools wheel
+          python -m pip install ${{ matrix.tool.package }}
+      - name: Run ${{ matrix.tool.package }}
+        env:
+          ADDED_FILES: ${{ join(fromJSON(steps.changed_files.outputs.added), ' ') }}
+          MODIFIED_FILES: ${{ join(fromJSON(steps.changed_files.outputs.modified), ' ') }}
         run: |
-          python3.9 -m venv .venv
-          .venv/bin/python -m pip install --upgrade pip setuptools wheel
-          .venv/bin/python -m pip install padpo
-      - name: Run padpo
-        run: PATH=$PATH:$PWD/.venv/bin/ padpo -i *.po */*.po 2>&1 | grep -v -Ff padpo.ignore
+          CHANGED_PO_FILES=$(printf "%s %s\n" "$ADDED_FILES" "$MODIFIED_FILES" | tr ' ' '\n' | grep '.po$'; true)
+          if [ -n "$CHANGED_PO_FILES" ]
+          then
+            echo "Running on:" $CHANGED_PO_FILES
+            ${{ matrix.tool.command }}
+          else
+            echo "No changed po files, nothing to check."
+          fi
 
   sphinx:
-    name: 'Build the doc'
+    name: 'Génération de la doc (sphinx)'
     runs-on: ubuntu-latest
+    timeout-minutes: 30
     steps:
       - uses: actions/checkout@v2
       - uses: actions/cache@v2
@@ -76,8 +83,12 @@ jobs:
         run: |
           mkdir -p ~/locales/fr/LC_MESSAGES/
           cp -uv --parents *.po */*.po ~/locales/fr/LC_MESSAGES/
-          git -C ~/cpython checkout b30934e9afb0af3f8e2e5f0992445be775b3c630
+          git -C ~/cpython checkout 895591c1f0bdec5ad357fe6a5fd0875990061357
       - name: Prepare venv
-        run: make -C $HOME/cpython/Doc venv
+        run: |
+          # If the venv exists but is broken, drop it (happens on Python upgrades):
+          # see https://github.com/actions/setup-python/issues/170
+          [ -d $HOME/cpython/Doc/venv/bin/ -a ! -e $HOME/cpython/Doc/venv/bin/python ] && rm -fr $HOME/cpython/Doc/venv
+          make -C $HOME/cpython/Doc venv
       - name: sphinx-build
         run: make -C $HOME/cpython/Doc SPHINXOPTS="-qW -j4 -D locale_dirs=$HOME/locales -D language=fr -D gettext_compact=0" autobuild-dev-html

.github/workflows/pr-title-cheker.yml

@@ -5,3 +5,4 @@ venv/
 .DS_Store
 .pospell/
 .potodo/
+locales/

.github/workflows/tests.yml

@@ -0,0 +1,87 @@
+Maintenance
+-----------
+
+Les commandes suivantes doivent être exécutées à partir de la racine d'un clone
+de ``python-docs-fr`` et certaines s'attendent à trouver un clone de CPython
+à jour à proximité :
+
+.. code-block:: bash
+  
+  ~/
+  ├── python-docs-fr/
+  └── cpython/
+  
+  
+Pour cloner CPython, vous pouvez utiliser :
+  
+.. code-block:: bash
+  
+  git clone --depth 1 --no-single-branch https://github.com/python/cpython.git
+  
+  
+Ceci évite de télécharger tout l'historique (inutile pour générer la
+documentation) mais récupère néanmoins toutes les branches.
+
+.. code-block:: bash
+  
+  make merge
+
+Dans certains cas on a besoin de propager des traductions d'une branche
+à l'autre :
+  
+- d'une ancienne branche vers une nouvelle branche : lors du passage
+  d'une version à l'autre de CPython, lorsque quelqu'un a une PR sur une
+  ancienne version (*forward porting*) ;
+- d'une nouvelle branche vers des anciennes branches : pour propager
+  de temps en temps le travail sur d'anciennes versions (rétroportage
+  ou *backporting*).
+  
+Pour forward-porter un ou plusieurs commits, il vaut mieux utiliser ``git
+cherry-pick -x LE_SHA``, ça garde l'auteur, le sha1 d'origine, et
+toutes les modifications.
+
+Pour rétroporter « en gros » on utilise ``pomerge``\  : on le fait lire
+sur une branche, puis écrire sur une autre, par exemple pour copier de
+la 3.8 à la 3.7 :
+  
+.. code-block:: bash
+  
+    git fetch
+    git checkout 3.8
+    git reset --hard upstream/3.8
+    pomerge --from-files *.po */*.po
+    git checkout --branch back-porting upstream/3.7
+    pomerge  --no-overwrite --to-files *.po */*.po
+    powrap --modified
+    git add --patch
+    git commit --message="Backporting from 3.8"
+    git push --set-upstream origin HEAD
+  
+  
+Notes :
+  
+- j'utilise ``git fetch`` au début pour avoir *upstream/3.7* et
+ *upstream/3.8* à jour localement, ainsi je peux travailler sans
+  toucher au réseau jusqu'au ``git push``, mais chacun fait comme il
+  veut ;
+- j'utilise ``*.po */*.po`` et pas ``**/*.po``, car si vous avez un
+  *venv* dans l'arborescence il va vous trouver des traductions de Sphinx
+  et peut-être d'autres paquets dans ``.venv/lib/python*/`` (et mettre
+  beaucoup plus de temps) ;
+- j'utilise ``pomerge --no-overwrite``, ça indique à ``pomerge`` de
+  n'écrire que si le ``msgstr`` est vide, donc de ne pas modifier
+  l'existant, ainsi il est impossible de casser quelque chose.
+  On peut le tenter sans ``--no-overwrite``, attention, ça fait
+  des bêtises, ça nécessite une relecture attentive :
+  certaines traductions, comme *example:* sont en parfois traduites en
+  français avec une majuscule, et parfois non, en
+  fonction du contexte, ``pomerge`` uniformiserait ça, ce n'est pas bien ;
+- attention, si vous testez sans ``--no-overwrite``, il est peut-être
+  bon de vider la mémoire de ``pomerge`` avant la lecture, pour éviter
+  de lui faire écrire des choses lues lors des sessions précédentes,
+  via un ``rm -f ~/.pomerge.json``\  ;
+- j'utilise ``git add --patch`` (ou ``-p``) car j'aime bien relire quand même,
+  en général, je n'ajoute pas les différences d'ordre dans les entêtes,
+  mais un ``git add --update`` irait très bien ;
+- attention au fichier *dict* auquel il peut manquer des lignes.
+