Merge branch 'main' into dependabot/pip/pytz-2023.4

.github/workflows/black.yml → .github/workflows/formatting.yml

@@ -1,4 +1,4 @@
-name: "Black"
+name: "Formatting"
 
 on: [push]
 jobs:
@@ -8,6 +8,7 @@ jobs:
       matrix:
         python-version: ["3.12"]
         os: [ubuntu-latest]
+        tool: ["black", "isort"]
     steps:
       - uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}
@@ -17,7 +18,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install black
-      - name: Black Code Formatter
+          pip install -r dev_requirements/requirements-formatting.txt
+      - name: ${{ matrix.tool }} Code Formatter
         run: |
-          black . --check
+          ${{ matrix.tool }} . --check

dev_requirements/requirements-formatting.in

@@ -0,0 +1,3 @@
+# specific requirements for the tox formatting environment
+black
+isort

dev_requirements/requirements-formatting.txt

@@ -0,0 +1,22 @@
+#
+# This file is autogenerated by pip-compile with Python 3.11
+# by the following command:
+#
+#    pip-compile requirements-formatting.in
+#
+black==24.1.1
+    # via -r requirements-formatting.in
+click==8.1.7
+    # via black
+colorama==0.4.6
+    # via click
+isort==5.12.0
+    # via -r requirements-formatting.in
+mypy-extensions==1.0.0
+    # via black
+packaging==23.2
+    # via black
+pathspec==0.12.1
+    # via black
+platformdirs==4.1.0
+    # via black

src/kohlrahbi/__init__.py

@@ -1,6 +1,7 @@
 """
 kohlrahbi is a package to scrape AHBs (in docx format)
 """
+
 import fnmatch
 import gc
 import json

src/kohlrahbi/ahb/ahbtable.py

@@ -1,6 +1,7 @@
 """
 This module provides the AhbTable class
 """
+
 from pathlib import Path
 from typing import Union
 

src/kohlrahbi/ahb/ahbtablerow.py

@@ -1,6 +1,7 @@
 """
 This module contains the class AhbTableRow
 """
+
 from typing import Optional
 
 import pandas as pd

src/kohlrahbi/changehistory/changehistorytable.py

@@ -1,6 +1,7 @@
 """
 This module provides the ChangeHistoryTable class
 """
+
 import attrs
 import pandas as pd
 from docx.table import Table  # type:ignore[import]

src/kohlrahbi/collect_pruefis.py

@@ -4,6 +4,7 @@
 Use this script to create an updated version of the all_known_pruefis.toml file.
 You should run it every time there is an update at edi-energy.de.
 """
+
 from datetime import date
 from pathlib import Path
 

src/kohlrahbi/docxfilefinder.py

@@ -1,6 +1,7 @@
 """
 This module contains the DocxFileFinder class.
 """
+
 from itertools import groupby
 from pathlib import Path
 

src/kohlrahbi/docxtablecells/bodycell.py

@@ -1,6 +1,7 @@
 """
 This module contains the class BodyCell
 """
+
 import attrs
 import pandas as pd
 from docx.table import _Cell  # type:ignore[import]

src/kohlrahbi/docxtablecells/edifactstrukturcell.py

@@ -1,6 +1,7 @@
 """
 This module contains the class EdifactStrukturCell
 """
+
 import re
 
 import attrs

src/kohlrahbi/logger.py

@@ -1,6 +1,7 @@
 """
 This module provides a logger instance for kohlrahbi
 """
+
 import logging.config
 from pathlib import Path
 

src/kohlrahbi/read_functions.py

@@ -1,6 +1,7 @@
 """
 A collection of functions to get information from AHB tables.
 """
+
 import re
 from datetime import datetime
 from typing import Generator, Optional, Union

src/kohlrahbi/row_type_checker.py

@@ -1,6 +1,7 @@
 """
 This module contains all functions to define the type of a row of the tables in an AHB.
 """
+
 from docx.oxml.ns import qn  # type:ignore[import]
 from docx.oxml.parser import OxmlElement  # type:ignore[import]
 from docx.shared import RGBColor  # type:ignore[import]

src/kohlrahbi/unfoldedahb/unfoldedahbtable.py

@@ -1,6 +1,7 @@
 """
 This module contains the UnfoldedAhbTable class.
 """
+
 import copy
 import json
 import re

tox.ini

@@ -59,8 +59,7 @@ deps =
     {[testenv:tests]deps}
     {[testenv:linting]deps}
     {[testenv:coverage]deps}
-    black
-    isort
+    -r dev_requirements/requirements-formatting.txt
     pip-tools
     pre-commit
 commands =

unittests/test_docx_extensions.py

@@ -1,6 +1,7 @@
 """
 tests all the features the kohlrahbi package provides to process Docx files (by using the docx package)
 """
+
 import pytest  # type:ignore[import]
 from _pytest.fixtures import SubRequest  # type:ignore[import]
 from docx import Document  # type:ignore[import]