fix: fix some shortlist issues

Author: scanny

pyproject.toml

@@ -23,7 +23,7 @@ classifiers = [
 ]
 dependencies = [
     "lxml>=3.1.0",
-    "typing_extensions",
+    "typing_extensions>=4.9.0",
 ]
 description = "Create, read, and update Microsoft Word .docx files."
 dynamic = ["version"]

src/docx/enum/base.py

@@ -4,9 +4,10 @@
 
 import enum
 import textwrap
-from typing import Any, Dict, Type, TypeVar
+from typing import TYPE_CHECKING, Any, Dict, Type, TypeVar
 
-from typing_extensions import Self
+if TYPE_CHECKING:
+    from typing_extensions import Self
 
 _T = TypeVar("_T", bound="BaseXmlEnum")
 
@@ -69,7 +70,7 @@ def to_xml(cls: Type[_T], value: int | _T | None) -> str | None:
         """XML value of this enum member, generally an XML attribute value."""
         # -- presence of multi-arg `__new__()` method fools type-checker, but getting a
         # -- member by its value using EnumCls(val) works as usual.
-        return cls(value).xml_value  # pyright: ignore[reportGeneralTypeIssues]
+        return cls(value).xml_value
 
 
 class DocsPageFormatter:
@@ -129,9 +130,7 @@ def _member_defs(self):
         """A single string containing the aggregated member definitions section of the
         documentation page."""
         members = self._clsdict["__members__"]
-        member_defs = [
-            self._member_def(member) for member in members if member.name is not None
-        ]
+        member_defs = [self._member_def(member) for member in members if member.name is not None]
         return "\n".join(member_defs)
 
     @property

src/docx/image/image.py

@@ -11,8 +11,6 @@
 import os
 from typing import IO, Tuple
 
-from typing_extensions import Self
-
 from docx.image.exceptions import UnrecognizedImageError
 from docx.shared import Emu, Inches, Length, lazyproperty
 
@@ -28,14 +26,14 @@ def __init__(self, blob: bytes, filename: str, image_header: BaseImageHeader):
         self._image_header = image_header
 
     @classmethod
-    def from_blob(cls, blob: bytes) -> Self:
+    def from_blob(cls, blob: bytes) -> Image:
         """Return a new |Image| subclass instance parsed from the image binary contained
         in `blob`."""
         stream = io.BytesIO(blob)
         return cls._from_stream(stream, blob)
 
     @classmethod
-    def from_file(cls, image_descriptor):
+    def from_file(cls, image_descriptor: str | IO[bytes]):
         """Return a new |Image| subclass instance loaded from the image file identified
         by `image_descriptor`, a path or file-like object."""
         if isinstance(image_descriptor, str):
@@ -57,7 +55,7 @@ def blob(self):
         return self._blob
 
     @property
-    def content_type(self):
+    def content_type(self) -> str:
         """MIME content type for this image, e.g. ``'image/jpeg'`` for a JPEG image."""
         return self._image_header.content_type
 
@@ -167,12 +165,11 @@ def _from_stream(
         return cls(blob, filename, image_header)
 
 
-def _ImageHeaderFactory(stream):
-    """Return a |BaseImageHeader| subclass instance that knows how to parse the headers
-    of the image in `stream`."""
+def _ImageHeaderFactory(stream: IO[bytes]):
+    """A |BaseImageHeader| subclass instance that can parse headers of image in `stream`."""
     from docx.image import SIGNATURES
 
-    def read_32(stream):
+    def read_32(stream: IO[bytes]):
         stream.seek(0)
         return stream.read(32)
 
@@ -188,32 +185,27 @@ def read_32(stream):
 class BaseImageHeader:
     """Base class for image header subclasses like |Jpeg| and |Tiff|."""
 
-    def __init__(self, px_width, px_height, horz_dpi, vert_dpi):
+    def __init__(self, px_width: int, px_height: int, horz_dpi: int, vert_dpi: int):
         self._px_width = px_width
         self._px_height = px_height
         self._horz_dpi = horz_dpi
         self._vert_dpi = vert_dpi
 
     @property
-    def content_type(self):
+    def content_type(self) -> str:
         """Abstract property definition, must be implemented by all subclasses."""
-        msg = (
-            "content_type property must be implemented by all subclasses of "
-            "BaseImageHeader"
-        )
+        msg = "content_type property must be implemented by all subclasses of " "BaseImageHeader"
         raise NotImplementedError(msg)
 
     @property
-    def default_ext(self):
+    def default_ext(self) -> str:
         """Default filename extension for images of this type.
 
         An abstract property definition, must be implemented by all subclasses.
         """
-        msg = (
-            "default_ext property must be implemented by all subclasses of "
-            "BaseImageHeader"
+        raise NotImplementedError(
+            "default_ext property must be implemented by all subclasses of " "BaseImageHeader"
         )
-        raise NotImplementedError(msg)
 
     @property
     def px_width(self):

src/docx/oxml/ns.py

@@ -1,8 +1,8 @@
 """Namespace-related objects."""
 
-from typing import Any, Dict
+from __future__ import annotations
 
-from typing_extensions import Self
+from typing import Any, Dict
 
 nsmap = {
     "a": "http://schemas.openxmlformats.org/drawingml/2006/main",
@@ -41,7 +41,7 @@ def clark_name(self) -> str:
         return "{%s}%s" % (self._ns_uri, self._local_part)
 
     @classmethod
-    def from_clark_name(cls, clark_name: str) -> Self:
+    def from_clark_name(cls, clark_name: str) -> NamespacePrefixedTag:
         nsuri, local_name = clark_name[1:].split("}")
         nstag = "%s:%s" % (pfxmap[nsuri], local_name)
         return cls(nstag)

src/docx/oxml/simpletypes.py

@@ -36,22 +36,18 @@ def convert_from_xml(cls, str_value: str) -> Any:
         return int(str_value)
 
     @classmethod
-    def convert_to_xml(cls, value: Any) -> str:
-        ...
+    def convert_to_xml(cls, value: Any) -> str: ...
 
     @classmethod
-    def validate(cls, value: Any) -> None:
-        ...
+    def validate(cls, value: Any) -> None: ...
 
     @classmethod
     def validate_int(cls, value: object):
         if not isinstance(value, int):
             raise TypeError("value must be <type 'int'>, got %s" % type(value))
 
     @classmethod
-    def validate_int_in_range(
-        cls, value: int, min_inclusive: int, max_inclusive: int
-    ) -> None:
+    def validate_int_in_range(cls, value: int, min_inclusive: int, max_inclusive: int) -> None:
         cls.validate_int(value)
         if value < min_inclusive or value > max_inclusive:
             raise ValueError(
@@ -129,8 +125,7 @@ def convert_to_xml(cls, value: bool) -> str:
     def validate(cls, value: Any) -> None:
         if value not in (True, False):
             raise TypeError(
-                "only True or False (and possibly None) may be assigned, got"
-                " '%s'" % value
+                "only True or False (and possibly None) may be assigned, got" " '%s'" % value
             )
 
 
@@ -248,8 +243,7 @@ def validate(cls, value: Any) -> None:
         # must be an RGBColor object ---
         if not isinstance(value, RGBColor):
             raise ValueError(
-                "rgb color value must be RGBColor object, got %s %s"
-                % (type(value), value)
+                "rgb color value must be RGBColor object, got %s %s" % (type(value), value)
             )
 
 
@@ -316,7 +310,7 @@ class ST_SignedTwipsMeasure(XsdInt):
     def convert_from_xml(cls, str_value: str) -> Length:
         if "i" in str_value or "m" in str_value or "p" in str_value:
             return ST_UniversalMeasure.convert_from_xml(str_value)
-        return Twips(int(str_value))
+        return Twips(int(round(float(str_value))))
 
     @classmethod
     def convert_to_xml(cls, value: int | Length) -> str:

src/docx/text/paragraph.py

@@ -4,8 +4,6 @@
 
 from typing import TYPE_CHECKING, Iterator, List, cast
 
-from typing_extensions import Self
-
 from docx import types as t
 from docx.enum.style import WD_STYLE_TYPE
 from docx.oxml.text.run import CT_R
@@ -29,9 +27,7 @@ def __init__(self, p: CT_P, parent: t.ProvidesStoryPart):
         super(Paragraph, self).__init__(parent)
         self._p = self._element = p
 
-    def add_run(
-        self, text: str | None = None, style: str | CharacterStyle | None = None
-    ) -> Run:
+    def add_run(self, text: str | None = None, style: str | CharacterStyle | None = None) -> Run:
         """Append run containing `text` and having character-style `style`.
 
         `text` can contain tab (``\\t``) characters, which are converted to the
@@ -82,7 +78,7 @@ def hyperlinks(self) -> List[Hyperlink]:
 
     def insert_paragraph_before(
         self, text: str | None = None, style: str | ParagraphStyle | None = None
-    ) -> Self:
+    ) -> Paragraph:
         """Return a newly created paragraph, inserted directly before this paragraph.
 
         If `text` is supplied, the new paragraph contains that text in a single run. If
@@ -123,9 +119,7 @@ def rendered_page_breaks(self) -> List[RenderedPageBreak]:
         Most often an empty list, sometimes contains one page-break, but can contain
         more than one is rare or contrived cases.
         """
-        return [
-            RenderedPageBreak(lrpb, self) for lrpb in self._p.lastRenderedPageBreaks
-        ]
+        return [RenderedPageBreak(lrpb, self) for lrpb in self._p.lastRenderedPageBreaks]
 
     @property
     def runs(self) -> List[Run]: