Merge branch 'main' into patch_linting_issues_for_version_bump_pylint

requirements.txt

@@ -40,7 +40,7 @@ pydantic-core==2.18.2
  # via pydantic
 python-dateutil==2.9.0.post0
  # via pandas
-python-docx==1.1.0
+python-docx==1.1.2
  # via kohlrahbi (pyproject.toml)
 pytz==2024.1
  # via

src/kohlrahbi/ahb/__init__.py

@@ -9,10 +9,10 @@
 from typing import Any, Dict, Optional
 
 import click
-import docx # type: ignore
+import docx
 import tomlkit
-from docx.document import Document # type:ignore[import]
-from docx.table import Table # type:ignore[import]
+from docx.document import Document
+from docx.table import Table
 from maus.edifact import EdifactFormatVersion
 
 from kohlrahbi.ahbtable.ahbtable import AhbTable

src/kohlrahbi/ahbtable/ahbcondtions.py

@@ -4,7 +4,7 @@
 import re
 from pathlib import Path
 
-from docx.table import Table as DocxTable # type: ignore[import-untyped]
+from docx.table import Table as DocxTable
 from maus.edifact import EdifactFormat
 from pydantic import BaseModel, ConfigDict
 

src/kohlrahbi/ahbtable/ahbpackagetable.py

@@ -7,7 +7,7 @@ class which contains AHB package condition table
 from pathlib import Path
 
 import pandas as pd
-from docx.table import Table as DocxTable # type: ignore[import-untyped]
+from docx.table import Table as DocxTable
 from maus.edifact import EdifactFormat
 from pydantic import BaseModel, ConfigDict
 

src/kohlrahbi/ahbtable/ahbsubtable.py

@@ -5,8 +5,8 @@
 from typing import Generator
 
 import pandas as pd
-from docx.table import Table as DocxTable # type:ignore[import]
-from docx.table import _Cell # type:ignore[import]
+from docx.table import Table as DocxTable
+from docx.table import _Cell
 from pydantic import BaseModel, ConfigDict
 
 from kohlrahbi.ahbtable.ahbtablerow import AhbTableRow

src/kohlrahbi/ahbtable/ahbtablerow.py

@@ -5,7 +5,7 @@
 from typing import Optional
 
 import pandas as pd
-from docx.table import _Cell # type:ignore[import]
+from docx.table import _Cell
 from pydantic import BaseModel, ConfigDict
 
 from kohlrahbi.docxtablecells import BedingungCell, BodyCell, EdifactStrukturCell

src/kohlrahbi/changehistory/__init__.py

@@ -13,10 +13,10 @@
 from pathlib import Path
 from typing import Optional
 
-import docx # type: ignore
+import docx
 import pandas as pd
-from docx.document import Document # type:ignore[import]
-from docx.table import Table # type: ignore
+from docx.document import Document
+from docx.table import Table
 
 from kohlrahbi.changehistory.changehistorytable import ChangeHistoryTable
 from kohlrahbi.docxfilefinder import DocxFileFinder

src/kohlrahbi/changehistory/changehistorytable.py

@@ -3,7 +3,7 @@
 """
 
 import pandas as pd
-from docx.table import Table # type:ignore[import]
+from docx.table import Table
 from pydantic import BaseModel, ConfigDict
 
 from kohlrahbi.ahbtable.ahbsubtable import AhbSubTable

src/kohlrahbi/conditions/__init__.py

@@ -4,7 +4,7 @@
 
 from pathlib import Path
 
-import docx # type: ignore[import-untyped]
+import docx
 from maus.edifact import EdifactFormat, EdifactFormatVersion, get_format_of_pruefidentifikator
 
 from kohlrahbi.ahb import get_pruefi_to_file_mapping
@@ -46,7 +46,8 @@ def scrape_conditions(
  for file in files:
  # pylint: disable=too-many-function-args
  # type: ignore[call-arg, arg-type]
- doc = docx.Document(basic_input_path / path_to_file / Path(file))
+ path: Path = basic_input_path / path_to_file / Path(file)
+ doc = docx.Document(str(path.absolute()))
  logger.info("Start scraping conditions for %s in %s", edifact_format, file)
  if not doc:
  logger.error("Could not open file %s as docx", Path(file))

src/kohlrahbi/docxtablecells/bedinungscell.py

@@ -5,7 +5,7 @@
 import re
 
 import pandas as pd
-from docx.table import _Cell # type:ignore[import]
+from docx.table import _Cell
 from pydantic import BaseModel, ConfigDict
 
 

src/kohlrahbi/docxtablecells/bodycell.py

@@ -3,7 +3,7 @@
 """
 
 import pandas as pd
-from docx.table import _Cell # type:ignore[import]
+from docx.table import _Cell
 from maus.reader.flat_ahb_reader import FlatAhbCsvReader
 from pydantic import BaseModel, ConfigDict
 

src/kohlrahbi/docxtablecells/edifactstrukturcell.py

@@ -5,7 +5,7 @@
 import re
 
 import pandas as pd
-from docx.table import _Cell # type:ignore[import]
+from docx.table import _Cell
 from pydantic import BaseModel, ConfigDict
 
 _segment_group_pattern = re.compile(r"^SG\d+$")

src/kohlrahbi/read_functions.py

@@ -2,13 +2,13 @@
 A collection of functions to get information from AHB tables.
 """
 
-from typing import Generator, Optional, Tuple, Union
+from typing import Generator, Optional, Tuple, TypeGuard, Union
 
-from docx.document import Document # type:ignore[import]
-from docx.oxml.table import CT_Tbl # type:ignore[import]
-from docx.oxml.text.paragraph import CT_P # type:ignore[import]
-from docx.table import Table, _Cell # type:ignore[import]
-from docx.text.paragraph import Paragraph # type:ignore[import]
+from docx.document import Document
+from docx.oxml.table import CT_Tbl
+from docx.oxml.text.paragraph import CT_P
+from docx.table import Table, _Cell
+from docx.text.paragraph import Paragraph
 from maus.edifact import EdifactFormat, get_format_of_pruefidentifikator
 
 from kohlrahbi.ahbtable.ahbcondtions import AhbConditions
@@ -275,7 +275,7 @@ def is_last_row_unt_0062(item: Table | Paragraph) -> bool:
  return isinstance(item, Table) and "UNT\t0062" == item.cell(row_idx=-1, col_idx=0).text.strip()
 
 
-def is_relevant_pruefi_table(item: Paragraph | Table, seed: Seed, edifact_format) -> bool:
+def is_relevant_pruefi_table(item: Paragraph | Table, seed: Seed, edifact_format) -> TypeGuard[Table]:
  """compares new pruefis to last pruefi and thus checks whether new table"""
  return (
  isinstance(item, Table)

src/kohlrahbi/row_type_checker.py

@@ -2,10 +2,10 @@
 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]
-from docx.table import _Cell # type:ignore[import]
+from docx.oxml.ns import qn
+from docx.oxml.parser import OxmlElement
+from docx.shared import RGBColor
+from docx.table import _Cell
 
 from kohlrahbi.enums import RowType
 

src/kohlrahbi/seed.py

@@ -2,7 +2,7 @@
 This module provides a class to collect information which of need for all parsing functions
 """
 
-from docx.table import Table # type:ignore[import]
+from docx.table import Table
 from pydantic import BaseModel
 
 from kohlrahbi.enums import RowType

src/kohlrahbi/table_header.py

@@ -5,8 +5,8 @@
 from enum import StrEnum
 from typing import Dict, List, Mapping, cast
 
-from docx.table import _Cell # type:ignore[import]
-from docx.text.paragraph import Paragraph # type:ignore[import]
+from docx.table import _Cell
+from docx.text.paragraph import Paragraph
 from more_itertools import first, last
 from pydantic import BaseModel
 

unittests/cellparagraph.py

@@ -1,7 +1,7 @@
 from typing import Optional
 
 from attr import define, field
-from docx.shared import Length # type:ignore[import]
+from docx.shared import Length
 
 
 @define(auto_attribs=True, kw_only=True)

unittests/conftest.py

@@ -1,4 +1,4 @@
-import docx # type:ignore[import]
+import docx
 import pytest # type:ignore[import]
 
 from unittests.cellparagraph import CellParagraph

unittests/test_ahb_sub_table.py

@@ -4,8 +4,8 @@
 
 from pathlib import Path
 
-import docx # type:ignore[import]
-from docx.table import Table # type:ignore[import]
+import docx
+from docx.table import Table
 
 from kohlrahbi.ahbtable.ahbsubtable import AhbSubTable
 from kohlrahbi.read_functions import get_all_paragraphs_and_tables

unittests/test_cells/test_bedingung_cell_parser.py

@@ -1,6 +1,6 @@
 import pandas as pd
 import pytest # type:ignore[import]
-from docx.shared import Twips # type:ignore[import]
+from docx.shared import Twips
 
 from kohlrahbi.docxtablecells import BedingungCell
 from unittests.cellparagraph import CellParagraph

unittests/test_cells/test_body_cell_parser.py

@@ -1,6 +1,6 @@
 import pandas as pd
 import pytest # type:ignore[import]
-from docx.shared import Length, Twips # type:ignore[import]
+from docx.shared import Length, Twips
 
 from kohlrahbi.docxtablecells import BodyCell
 from unittests.cellparagraph import CellParagraph

unittests/test_cells/test_edifact_struktur_cell_parser.py

@@ -1,6 +1,6 @@
 import pandas as pd
 import pytest # type:ignore[import]
-from docx.shared import Twips # type:ignore[import]
+from docx.shared import Twips
 
 from kohlrahbi.docxtablecells import EdifactStrukturCell
 from unittests.cellparagraph import CellParagraph

unittests/test_check_row_type.py

@@ -1,6 +1,6 @@
-import docx # type:ignore[import]
+import docx
 import pytest # type:ignore[import]
-from docx.shared import RGBColor # type:ignore[import]
+from docx.shared import RGBColor
 
 from kohlrahbi.row_type_checker import RowType, get_row_type
 

unittests/test_docx_extensions.py

@@ -2,19 +2,21 @@
 tests all the features the kohlrahbi package provides to process Docx files (by using the docx package)
 """
 
+from typing import Generator
+
 import pytest # type:ignore[import]
 from _pytest.fixtures import SubRequest # type:ignore[import]
-from docx import Document # type:ignore[import]
-from docx.document import Document as DocumentClass # type:ignore[import]
-from docx.table import Table # type:ignore[import]
-from docx.text.paragraph import Paragraph # type:ignore[import]
+from docx import Document
+from docx.document import Document as DocumentClass
+from docx.table import Table
+from docx.text.paragraph import Paragraph
 
 from kohlrahbi.read_functions import get_all_paragraphs_and_tables
 
 
 class TestDocxExtensions:
  @pytest.fixture
- def create_docx_from_filename(self, request: SubRequest, datafiles) -> DocumentClass:
+ def create_docx_from_filename(self, request: SubRequest, datafiles) -> Generator[DocumentClass, None, None]:
  """a fixture to quickly instantiate a docx.Document from a given docx file name"""
  docx_file_name = request.param
  docx_file_path = datafiles / docx_file_name

unittests/test_read_functions.py

@@ -1,8 +1,7 @@
 import json
-import os
 from pathlib import Path
 
-import docx # type:ignore[import]
+import docx
 import pytest # type:ignore[import]
 from docx import Document
 from maus.edifact import EdifactFormat, EdifactFormatVersion