Type all @property in openpyxl (#10787)

Author: Avasam

stubs/openpyxl/openpyxl/cell/__init__.pyi

@@ -1,2 +1,22 @@
+from datetime import date, datetime, time, timedelta
+from decimal import Decimal
+from typing_extensions import TypeAlias
+
+from openpyxl.cell.rich_text import CellRichText
+from openpyxl.worksheet.formula import ArrayFormula, DataTableFormula
+
 from .cell import Cell as Cell, MergedCell as MergedCell, WriteOnlyCell as WriteOnlyCell
 from .read_only import ReadOnlyCell as ReadOnlyCell
+
+_TimeTypes: TypeAlias = datetime | date | time | timedelta
+_CellValue: TypeAlias = (  # noqa: Y047 # Used in other modules
+    # if numpy is installed also numpy bool and number types
+    bool
+    | float
+    | Decimal
+    | str
+    | CellRichText
+    | _TimeTypes
+    | DataTableFormula
+    | ArrayFormula
+)

stubs/openpyxl/openpyxl/cell/cell.pyi

@@ -1,22 +1,16 @@
-from datetime import date, datetime, time, timedelta
-from decimal import Decimal
+from _typeshed import ReadableBuffer
+from datetime import datetime
 from re import Pattern
 from typing import overload
-from typing_extensions import Final, TypeAlias
+from typing_extensions import Final
 
-from openpyxl.cell.rich_text import CellRichText
+from openpyxl.cell import _CellValue, _TimeTypes
 from openpyxl.comments.comments import Comment
 from openpyxl.styles.cell_style import StyleArray
 from openpyxl.styles.styleable import StyleableObject
-from openpyxl.worksheet.formula import ArrayFormula, DataTableFormula
 from openpyxl.worksheet.hyperlink import Hyperlink
 from openpyxl.worksheet.worksheet import Worksheet
 
-_TimeTypes: TypeAlias = datetime | date | time | timedelta
-_CellValue: TypeAlias = (  # if numpy is installed also numpy bool and number types
-    bool | float | Decimal | str | CellRichText | _TimeTypes | DataTableFormula | ArrayFormula
-)
-
 __docformat__: Final = "restructuredtext en"
 TIME_TYPES: Final[tuple[type, ...]]
 TIME_FORMATS: Final[dict[type[_TimeTypes], str]]
@@ -65,14 +59,14 @@ class Cell(StyleableObject):
     @overload
     def check_string(self, value: None) -> None: ...
     @overload
-    def check_string(self, value: str | bytes) -> str: ...
+    def check_string(self, value: str | ReadableBuffer) -> str: ...
     def check_error(self, value: object) -> str: ...
     @property
-    def value(self) -> _CellValue: ...
+    def value(self) -> _CellValue | None: ...
     @value.setter
     def value(self, value: _CellValue | bytes | None) -> None: ...
     @property
-    def internal_value(self) -> _CellValue: ...
+    def internal_value(self) -> _CellValue | None: ...
     @property
     def hyperlink(self) -> Hyperlink | None: ...
     @hyperlink.setter
@@ -92,6 +86,7 @@ class MergedCell(StyleableObject):
     row: int
     column: int
     def __init__(self, worksheet: Worksheet, row: int | None = None, column: int | None = None) -> None: ...
+    # Same as Cell.coordinate
     @property
     def coordinate(self) -> str: ...
     value: str | float | int | datetime | None

stubs/openpyxl/openpyxl/cell/read_only.pyi

@@ -1,6 +1,14 @@
 from _typeshed import Incomplete
 from typing_extensions import Final
 
+from openpyxl.cell import _CellValue
+from openpyxl.styles.alignment import Alignment
+from openpyxl.styles.borders import Border
+from openpyxl.styles.cell_style import StyleArray
+from openpyxl.styles.fills import Fill
+from openpyxl.styles.fonts import Font
+from openpyxl.styles.protection import Protection
+
 class ReadOnlyCell:
     parent: Incomplete
     row: Incomplete
@@ -9,35 +17,38 @@ class ReadOnlyCell:
     def __init__(self, sheet, row, column, value, data_type: str = "n", style_id: int = 0) -> None: ...
     def __eq__(self, other): ...
     def __ne__(self, other): ...
-    # defined twice in the implementation
+    # Same as Cell.coordinate
+    # Defined twice in the implementation
     @property
-    def coordinate(self): ...
+    def coordinate(self) -> str: ...
+    # Same as Cell.column_letter
     @property
-    def column_letter(self): ...
+    def column_letter(self) -> str: ...
     @property
-    def style_array(self): ...
+    def style_array(self) -> StyleArray: ...
     @property
-    def has_style(self): ...
+    def has_style(self) -> bool: ...
     @property
-    def number_format(self): ...
+    def number_format(self) -> str: ...
     @property
-    def font(self): ...
+    def font(self) -> Font: ...
     @property
-    def fill(self): ...
+    def fill(self) -> Fill: ...
     @property
-    def border(self): ...
+    def border(self) -> Border: ...
     @property
-    def alignment(self): ...
+    def alignment(self) -> Alignment: ...
     @property
-    def protection(self): ...
+    def protection(self) -> Protection: ...
+    # Same as Cell.is_date
     @property
-    def is_date(self): ...
+    def is_date(self) -> bool: ...
     @property
-    def internal_value(self): ...
+    def internal_value(self) -> _CellValue | None: ...
     @property
-    def value(self): ...
+    def value(self) -> _CellValue | None: ...
     @value.setter
-    def value(self, value) -> None: ...
+    def value(self, value: None) -> None: ...
 
 class EmptyCell:
     value: Incomplete

stubs/openpyxl/openpyxl/cell/text.pyi

@@ -95,4 +95,4 @@ class Text(Serialisable):
     __elements__: ClassVar[tuple[str, ...]]
     def __init__(self, t: object = None, r=(), rPh=(), phoneticPr: _PhoneticProperties | None = None) -> None: ...
     @property
-    def content(self): ...
+    def content(self) -> str: ...

stubs/openpyxl/openpyxl/chart/_chart.pyi

@@ -46,4 +46,4 @@ class ChartBase(Serialisable):
     def add_data(self, data, from_rows: bool = False, titles_from_data: bool = False) -> None: ...
     def append(self, value) -> None: ...
     @property
-    def path(self): ...
+    def path(self) -> str: ...

stubs/openpyxl/openpyxl/chart/reference.pyi

@@ -41,9 +41,9 @@ class Reference(Strict):
     def __len__(self) -> int: ...
     def __eq__(self, other): ...
     @property
-    def rows(self) -> Generator[Incomplete, None, None]: ...
+    def rows(self) -> Generator[Reference, None, None]: ...
     @property
-    def cols(self) -> Generator[Incomplete, None, None]: ...
+    def cols(self) -> Generator[Reference, None, None]: ...
     def pop(self): ...
     @property
-    def sheetname(self): ...
+    def sheetname(self) -> str: ...

stubs/openpyxl/openpyxl/comments/comment_sheet.pyi

@@ -5,6 +5,7 @@ from typing_extensions import Literal, TypeAlias
 
 from openpyxl.cell.text import Text
 from openpyxl.comments.author import AuthorList
+from openpyxl.comments.comments import Comment
 from openpyxl.descriptors.base import Bool, Integer, Set, String, Typed, _ConvertibleToBool, _ConvertibleToInt
 from openpyxl.descriptors.excel import ExtensionList
 from openpyxl.descriptors.serialisable import Serialisable
@@ -101,7 +102,7 @@ class CommentRecord(Serialisable):
     @classmethod
     def from_cell(cls, cell): ...
     @property
-    def content(self): ...
+    def content(self) -> str: ...
 
 class CommentSheet(Serialisable):
     tagname: ClassVar[str]
@@ -113,9 +114,9 @@ class CommentSheet(Serialisable):
     def __init__(self, authors: AuthorList, commentList: Incomplete | None = None, extLst: Unused = None) -> None: ...
     def to_tree(self): ...
     @property
-    def comments(self) -> Generator[Incomplete, None, None]: ...
+    def comments(self) -> Generator[tuple[str, Comment], None, None]: ...
     @classmethod
     def from_comments(cls, comments): ...
     def write_shapes(self, vml: Incomplete | None = None): ...
     @property
-    def path(self): ...
+    def path(self) -> str: ...

stubs/openpyxl/openpyxl/comments/comments.pyi

@@ -1,4 +1,5 @@
 from _typeshed import Incomplete
+from typing import Any
 
 class Comment:
     content: Incomplete
@@ -7,12 +8,12 @@ class Comment:
     width: Incomplete
     def __init__(self, text, author, height: int = 79, width: int = 144) -> None: ...
     @property
-    def parent(self): ...
+    def parent(self) -> Any: ...  # AnyOf[Cell, MergedCell, ReadOnlyCell]
     def __eq__(self, other): ...
     def __copy__(self): ...
     def bind(self, cell) -> None: ...
     def unbind(self) -> None: ...
     @property
-    def text(self): ...
+    def text(self) -> str: ...
     @text.setter
-    def text(self, value) -> None: ...
+    def text(self, value: str) -> None: ...

stubs/openpyxl/openpyxl/drawing/drawing.pyi

@@ -1,5 +1,7 @@
 from _typeshed import Incomplete
 
+from .spreadsheet_drawing import AbsoluteAnchor, OneCellAnchor
+
 class Drawing:
     count: int
     name: str
@@ -14,13 +16,13 @@ class Drawing:
     anchorrow: int
     def __init__(self) -> None: ...
     @property
-    def width(self): ...
+    def width(self) -> int: ...
     @width.setter
-    def width(self, w) -> None: ...
+    def width(self, w: int) -> None: ...
     @property
-    def height(self): ...
+    def height(self) -> int: ...
     @height.setter
-    def height(self, h) -> None: ...
+    def height(self, h: int) -> None: ...
     def set_dimension(self, w: int = 0, h: int = 0) -> None: ...
     @property
-    def anchor(self): ...
+    def anchor(self) -> AbsoluteAnchor | OneCellAnchor: ...

stubs/openpyxl/openpyxl/drawing/image.pyi

@@ -6,4 +6,4 @@ class Image:
     format: Incomplete
     def __init__(self, img) -> None: ...
     @property
-    def path(self): ...
+    def path(self) -> str: ...