fix: update action versions in workflows and improve XML parsing documentation

Author: garlontas

.github/workflows/build.yml

@@ -22,6 +22,6 @@ jobs:
       - name: Run tox
         run: tox -e py
       - name: SonarQube Scan
-        uses: SonarSource/sonarqube-scan-action@v6
+        uses: SonarSource/sonarqube-scan-action@299e4b793aaa83bf2aba7c9c14bedbb485688ec4
         env:
           SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

.github/workflows/unittests.yml

@@ -45,7 +45,7 @@ jobs:
       # The key configuration value here is `virtualenvs-in-project: true`: this creates the
       # venv as a `.venv` in your testing directory, which allows the next step to easily
       # cache it.
-      - uses: snok/install-poetry@v1
+      - uses: snok/install-poetry@76e04a911780d5b312d89783f7b1cd627778900a
         with:
           version: 2.1.0
           virtualenvs-create: true

pystreamapi/loaders/__xml/__xml_loader.py

@@ -39,8 +39,8 @@ def _lazy_parse_xml_file(file_path: str, encoding: str,
     """Lazily parse an XML file by reading its content and yielding parsed namedtuples."""
     def generator():
         """Generator that reads the XML file and yields parsed namedtuples lazily."""
+        # skipcq: PTC-W6004
         with open(file_path, mode='r', encoding=encoding) as xmlfile:
-            # skipcq: PTC-W6004
             xml_string = xmlfile.read()
             yield from _parse_xml_string_lazy(xml_string, retrieve_children, cast_types)
 
@@ -49,9 +49,7 @@ def generator():
 
 def _lazy_parse_xml_string(xml_string: str, retrieve_children: bool,
                            cast_types: bool) -> Iterator[Any]:
-    """
-    Lazily parse an XML string by yielding parsed namedtuples for each element.
-    """
+    """Lazily parse an XML string by yielding parsed namedtuples for each element."""
     def generator():
         """Generator that yields parsed namedtuples from the XML string lazily."""
         yield from _parse_xml_string_lazy(xml_string, retrieve_children, cast_types)