Merge openpyxl stubs from microsoft/python-type-stubs

stubs/openpyxl/@tests/stubtest_allowlist.txt

@@ -1,5 +1,264 @@
-# "cls" argument has wrong name in implementation.
-openpyxl.descriptors.slots.AutoSlotProperties.__new__
+# The actual runtime definition depends on what else is installed
+# (lxml, defusedxml, et_xmlfile, numpy, ...)
+openpyxl.xml._functions
+openpyxl.xml.functions.Element.__iter__
+openpyxl.xml.functions.tostring
+openpyxl.xml.functions.xmlfile
 
 # Requires numpy to be installed
 openpyxl.utils.dataframe
+
+# Inconsistent __init__ because
+# - using the default value results in an error because of the runtime type-guards
+# - or, keyword arguments are explicitly specified
+openpyxl.cell.text.PhoneticProperties.__init__
+openpyxl.cell.text.PhoneticText.__init__
+openpyxl.chart.axis._BaseAxis.__init__
+openpyxl.chart.axis.DateAxis.__init__
+openpyxl.chart.axis.NumericAxis.__init__
+openpyxl.chart.axis.SeriesAxis.__init__
+openpyxl.chart.axis.TextAxis.__init__
+openpyxl.styles.colors.RgbColor.__init__
+openpyxl.styles.named_styles._NamedCellStyle.__init__
+openpyxl.styles.numbers.NumberFormat.__init__
+openpyxl.workbook.defined_name.DefinedName.__init__
+
+# Leaked into the global space
+openpyxl.utils.cell.col
+openpyxl.utils.cell.i
+
+# Unintended re-exports
+openpyxl.chart.marker.DRAWING_NS
+openpyxl.chart.marker.PRESET_COLORS
+openpyxl.chart.shapes.DRAWING_NS
+openpyxl.chart.shapes.PRESET_COLORS
+openpyxl.drawing.text.PRESET_COLORS
+
+# Type vs class stubtest issue
+openpyxl.chart.descriptors.NumberFormatDescriptor.expected_type
+
+# Variable differs from runtime type because attributes are actually
+# non-Convertible descriptors and the value is obtained through a dynamic getter
+openpyxl.cell.text.InlineFont.color
+openpyxl.cell.text.InlineFont.rFont
+openpyxl.cell.text.InlineFont.scheme
+openpyxl.cell.text.InlineFont.u
+openpyxl.cell.text.InlineFont.vertAlign
+openpyxl.cell.text.PhoneticProperties.alignment
+openpyxl.cell.text.PhoneticProperties.type
+openpyxl.cell.text.PhoneticText.t
+openpyxl.cell.text.PhoneticText.text
+openpyxl.cell.text.RichText.font
+openpyxl.cell.text.RichText.rPr
+openpyxl.cell.text.RichText.t
+openpyxl.cell.text.RichText.text
+openpyxl.cell.text.Text.formatted
+openpyxl.cell.text.Text.phonetic
+openpyxl.cell.text.Text.phoneticPr
+openpyxl.cell.text.Text.PhoneticProperties
+openpyxl.cell.text.Text.plain
+openpyxl.cell.text.Text.r
+openpyxl.cell.text.Text.rPh
+openpyxl.cell.text.Text.t
+openpyxl.chart.axis._BaseAxis.axPos
+openpyxl.chart.axis._BaseAxis.crosses
+openpyxl.chart.axis._BaseAxis.graphicalProperties
+openpyxl.chart.axis._BaseAxis.majorGridlines
+openpyxl.chart.axis._BaseAxis.majorTickMark
+openpyxl.chart.axis._BaseAxis.minorGridlines
+openpyxl.chart.axis._BaseAxis.minorTickMark
+openpyxl.chart.axis._BaseAxis.number_format
+openpyxl.chart.axis._BaseAxis.numFmt
+openpyxl.chart.axis._BaseAxis.scaling
+openpyxl.chart.axis._BaseAxis.spPr
+openpyxl.chart.axis._BaseAxis.textProperties
+openpyxl.chart.axis._BaseAxis.tickLblPos
+openpyxl.chart.axis._BaseAxis.title
+openpyxl.chart.axis._BaseAxis.txPr
+openpyxl.chart.axis.ChartLines.graphicalProperties
+openpyxl.chart.axis.ChartLines.spPr
+openpyxl.chart.axis.DateAxis.axPos
+openpyxl.chart.axis.DateAxis.baseTimeUnit
+openpyxl.chart.axis.DateAxis.crosses
+openpyxl.chart.axis.DateAxis.extLst
+openpyxl.chart.axis.DateAxis.majorGridlines
+openpyxl.chart.axis.DateAxis.majorTickMark
+openpyxl.chart.axis.DateAxis.majorTimeUnit
+openpyxl.chart.axis.DateAxis.minorGridlines
+openpyxl.chart.axis.DateAxis.minorTickMark
+openpyxl.chart.axis.DateAxis.minorTimeUnit
+openpyxl.chart.axis.DateAxis.numFmt
+openpyxl.chart.axis.DateAxis.scaling
+openpyxl.chart.axis.DateAxis.spPr
+openpyxl.chart.axis.DateAxis.tickLblPos
+openpyxl.chart.axis.DateAxis.title
+openpyxl.chart.axis.DateAxis.txPr
+openpyxl.chart.axis.DisplayUnitsLabel.graphicalProperties
+openpyxl.chart.axis.DisplayUnitsLabel.layout
+openpyxl.chart.axis.DisplayUnitsLabel.spPr
+openpyxl.chart.axis.DisplayUnitsLabel.text
+openpyxl.chart.axis.DisplayUnitsLabel.textPropertes
+openpyxl.chart.axis.DisplayUnitsLabel.tx
+openpyxl.chart.axis.DisplayUnitsLabel.txPr
+openpyxl.chart.axis.DisplayUnitsLabelList.builtInUnit
+openpyxl.chart.axis.DisplayUnitsLabelList.dispUnitsLbl
+openpyxl.chart.axis.DisplayUnitsLabelList.extLst
+openpyxl.chart.axis.NumericAxis.axPos
+openpyxl.chart.axis.NumericAxis.crossBetween
+openpyxl.chart.axis.NumericAxis.crosses
+openpyxl.chart.axis.NumericAxis.dispUnits
+openpyxl.chart.axis.NumericAxis.extLst
+openpyxl.chart.axis.NumericAxis.majorGridlines
+openpyxl.chart.axis.NumericAxis.majorTickMark
+openpyxl.chart.axis.NumericAxis.minorGridlines
+openpyxl.chart.axis.NumericAxis.minorTickMark
+openpyxl.chart.axis.NumericAxis.numFmt
+openpyxl.chart.axis.NumericAxis.scaling
+openpyxl.chart.axis.NumericAxis.spPr
+openpyxl.chart.axis.NumericAxis.tickLblPos
+openpyxl.chart.axis.NumericAxis.title
+openpyxl.chart.axis.NumericAxis.txPr
+openpyxl.chart.axis.Scaling.extLst
+openpyxl.chart.axis.Scaling.orientation
+openpyxl.chart.axis.SeriesAxis.axPos
+openpyxl.chart.axis.SeriesAxis.crosses
+openpyxl.chart.axis.SeriesAxis.extLst
+openpyxl.chart.axis.SeriesAxis.majorGridlines
+openpyxl.chart.axis.SeriesAxis.majorTickMark
+openpyxl.chart.axis.SeriesAxis.minorGridlines
+openpyxl.chart.axis.SeriesAxis.minorTickMark
+openpyxl.chart.axis.SeriesAxis.numFmt
+openpyxl.chart.axis.SeriesAxis.scaling
+openpyxl.chart.axis.SeriesAxis.spPr
+openpyxl.chart.axis.SeriesAxis.tickLblPos
+openpyxl.chart.axis.SeriesAxis.title
+openpyxl.chart.axis.SeriesAxis.txPr
+openpyxl.chart.axis.TextAxis.axPos
+openpyxl.chart.axis.TextAxis.crosses
+openpyxl.chart.axis.TextAxis.extLst
+openpyxl.chart.axis.TextAxis.lblAlgn
+openpyxl.chart.axis.TextAxis.majorGridlines
+openpyxl.chart.axis.TextAxis.majorTickMark
+openpyxl.chart.axis.TextAxis.minorGridlines
+openpyxl.chart.axis.TextAxis.minorTickMark
+openpyxl.chart.axis.TextAxis.numFmt
+openpyxl.chart.axis.TextAxis.scaling
+openpyxl.chart.axis.TextAxis.spPr
+openpyxl.chart.axis.TextAxis.tickLblPos
+openpyxl.chart.axis.TextAxis.title
+openpyxl.chart.axis.TextAxis.txPr
+openpyxl.chartsheet.chartsheet.Chartsheet.sheet_state
+openpyxl.chartsheet.Chartsheet.sheet_state
+openpyxl.chartsheet.custom.CustomChartsheetView.state
+openpyxl.packaging.workbook.ChildSheet.state
+openpyxl.styles.alignment.Alignment.horizontal
+openpyxl.styles.alignment.Alignment.shrink_to_fit
+openpyxl.styles.alignment.Alignment.text_rotation
+openpyxl.styles.alignment.Alignment.textRotation
+openpyxl.styles.alignment.Alignment.vertical
+openpyxl.styles.alignment.Alignment.wrap_text
+openpyxl.styles.Alignment.horizontal
+openpyxl.styles.Alignment.shrink_to_fit
+openpyxl.styles.Alignment.text_rotation
+openpyxl.styles.Alignment.textRotation
+openpyxl.styles.Alignment.vertical
+openpyxl.styles.Alignment.wrap_text
+openpyxl.styles.Border.bottom
+openpyxl.styles.Border.diagonal
+openpyxl.styles.Border.end
+openpyxl.styles.Border.horizontal
+openpyxl.styles.Border.left
+openpyxl.styles.Border.right
+openpyxl.styles.Border.start
+openpyxl.styles.Border.top
+openpyxl.styles.Border.vertical
+openpyxl.styles.borders.Border.bottom
+openpyxl.styles.borders.Border.diagonal
+openpyxl.styles.borders.Border.end
+openpyxl.styles.borders.Border.horizontal
+openpyxl.styles.borders.Border.left
+openpyxl.styles.borders.Border.right
+openpyxl.styles.borders.Border.start
+openpyxl.styles.borders.Border.top
+openpyxl.styles.borders.Border.vertical
+openpyxl.styles.borders.Side.border_style
+openpyxl.styles.borders.Side.color
+openpyxl.styles.borders.Side.style
+openpyxl.styles.Color.rgb
+openpyxl.styles.Color.type
+openpyxl.styles.colors.Color.rgb
+openpyxl.styles.colors.Color.type
+openpyxl.styles.colors.ColorDescriptor.expected_type
+openpyxl.styles.colors.ColorList.indexedColors
+openpyxl.styles.colors.ColorList.mruColors
+openpyxl.styles.colors.RgbColor.rgb
+openpyxl.styles.differential.DifferentialStyle.alignment
+openpyxl.styles.differential.DifferentialStyle.border
+openpyxl.styles.differential.DifferentialStyle.fill
+openpyxl.styles.differential.DifferentialStyle.font
+openpyxl.styles.differential.DifferentialStyle.numFmt
+openpyxl.styles.differential.DifferentialStyle.protection
+openpyxl.styles.differential.DifferentialStyleList.dxf
+openpyxl.styles.fills.GradientFill.fill_type
+openpyxl.styles.fills.GradientFill.stop
+openpyxl.styles.fills.GradientFill.type
+openpyxl.styles.fills.PatternFill.bgColor
+openpyxl.styles.fills.PatternFill.end_color
+openpyxl.styles.fills.PatternFill.fgColor
+openpyxl.styles.fills.PatternFill.fill_type
+openpyxl.styles.fills.PatternFill.patternType
+openpyxl.styles.fills.PatternFill.start_color
+openpyxl.styles.fills.Stop.color
+openpyxl.styles.fills.StopList.expected_type
+openpyxl.styles.Font.bold
+openpyxl.styles.Font.color
+openpyxl.styles.Font.italic
+openpyxl.styles.Font.name
+openpyxl.styles.Font.scheme
+openpyxl.styles.Font.size
+openpyxl.styles.Font.strikethrough
+openpyxl.styles.Font.u
+openpyxl.styles.Font.underline
+openpyxl.styles.Font.vertAlign
+openpyxl.styles.fonts.Font.bold
+openpyxl.styles.fonts.Font.color
+openpyxl.styles.fonts.Font.italic
+openpyxl.styles.fonts.Font.name
+openpyxl.styles.fonts.Font.scheme
+openpyxl.styles.fonts.Font.size
+openpyxl.styles.fonts.Font.strikethrough
+openpyxl.styles.fonts.Font.u
+openpyxl.styles.fonts.Font.underline
+openpyxl.styles.fonts.Font.vertAlign
+openpyxl.styles.GradientFill.fill_type
+openpyxl.styles.GradientFill.stop
+openpyxl.styles.GradientFill.type
+openpyxl.styles.named_styles._NamedCellStyle.extLst
+openpyxl.styles.named_styles._NamedCellStyle.name
+openpyxl.styles.named_styles._NamedCellStyleList.cellStyle
+openpyxl.styles.named_styles.NamedStyle.alignment
+openpyxl.styles.named_styles.NamedStyle.border
+openpyxl.styles.named_styles.NamedStyle.fill
+openpyxl.styles.named_styles.NamedStyle.font
+openpyxl.styles.named_styles.NamedStyle.name
+openpyxl.styles.named_styles.NamedStyle.number_format
+openpyxl.styles.named_styles.NamedStyle.protection
+openpyxl.styles.NamedStyle.alignment
+openpyxl.styles.NamedStyle.border
+openpyxl.styles.NamedStyle.fill
+openpyxl.styles.NamedStyle.font
+openpyxl.styles.NamedStyle.name
+openpyxl.styles.NamedStyle.number_format
+openpyxl.styles.NamedStyle.protection
+openpyxl.styles.numbers.NumberFormat.formatCode
+openpyxl.styles.numbers.NumberFormatList.numFmt
+openpyxl.styles.PatternFill.bgColor
+openpyxl.styles.PatternFill.end_color
+openpyxl.styles.PatternFill.fgColor
+openpyxl.styles.PatternFill.fill_type
+openpyxl.styles.PatternFill.patternType
+openpyxl.styles.PatternFill.start_color
+openpyxl.styles.Side.border_style
+openpyxl.styles.Side.color
+openpyxl.styles.Side.style
+openpyxl.workbook.views.BookView.visibility

stubs/openpyxl/METADATA.toml

@@ -1,4 +1 @@
 version = "3.1.*"
-
-[tool.stubtest]
-ignore_missing_stub = true

stubs/openpyxl/openpyxl/__init__.pyi

@@ -1,3 +1,5 @@
+from typing import Protocol
+
 from openpyxl.compat.numbers import NUMPY as NUMPY
 from openpyxl.reader.excel import load_workbook as load_workbook
 from openpyxl.workbook import Workbook as Workbook
@@ -13,3 +15,7 @@ from ._constants import (
 )
 
 open = load_workbook
+
+# Utility type reused elsewhere
+class _Decodable(Protocol):  # noqa: Y046
+    def decode(self, __encoding: str) -> str: ...

stubs/openpyxl/openpyxl/cell/cell.pyi

@@ -1,42 +1,49 @@
-from _typeshed import Incomplete
-from datetime import datetime
+import datetime
+from _typeshed import ReadableBuffer
+from re import Pattern
+from typing_extensions import Final, Literal, TypeAlias
 
 from openpyxl.comments.comments import Comment
+from openpyxl.compat.numbers import NUMERIC_TYPES as NUMERIC_TYPES, _NumericTypes
 from openpyxl.styles.cell_style import StyleArray
 from openpyxl.styles.styleable import StyleableObject
+from openpyxl.workbook.child import _WorkbookChild
 from openpyxl.worksheet.hyperlink import Hyperlink
-from openpyxl.worksheet.worksheet import Worksheet
 
 __docformat__: str
-TIME_TYPES: Incomplete
-TIME_FORMATS: Incomplete
-STRING_TYPES: Incomplete
-KNOWN_TYPES: Incomplete
-ILLEGAL_CHARACTERS_RE: Incomplete
-ERROR_CODES: Incomplete
-TYPE_STRING: str
-TYPE_FORMULA: str
-TYPE_NUMERIC: str
-TYPE_BOOL: str
-TYPE_NULL: str
-TYPE_INLINE: str
-TYPE_ERROR: str
-TYPE_FORMULA_CACHE_STRING: str
-VALID_TYPES: Incomplete
+_TimeTypes: TypeAlias = datetime.datetime | datetime.date | datetime.time | datetime.timedelta
+TIME_TYPES: tuple[type[_TimeTypes], ...]
+TIME_FORMATS: dict[type[_TimeTypes], str]
+STRING_TYPES: tuple[type[str], type[bytes]]
+_StringTypes: TypeAlias = str | bytes
+_KnownTypes: TypeAlias = _NumericTypes | _TimeTypes | _StringTypes | bool | None
+KNOWN_TYPES: tuple[type[_KnownTypes], ...]
+ILLEGAL_CHARACTERS_RE: Pattern[str]
+ERROR_CODES: Final[tuple[str, ...]]
+TYPE_STRING: Final = "s"
+TYPE_FORMULA: Final = "f"
+TYPE_NUMERIC: Final = "n"
+TYPE_BOOL: Final = "b"
+TYPE_NULL: Final = "n"
+TYPE_INLINE: Final = "inlineStr"
+TYPE_ERROR: Final = "e"
+TYPE_FORMULA_CACHE_STRING: Final = "str"
 
-def get_type(t: type, value: object) -> str | None: ...
-def get_time_format(t: datetime) -> str: ...
+VALID_TYPES: Final[tuple[str, ...]]
+
+def get_type(t: type, value: _KnownTypes) -> Literal["n", "s", "d", None]: ...
+def get_time_format(t: _TimeTypes) -> str: ...
 
 class Cell(StyleableObject):
-    row: int
-    column: int
+    row: int | None
+    column: int | None
     data_type: str
     def __init__(
         self,
-        worksheet: Worksheet,
+        worksheet: _WorkbookChild,
         row: int | None = ...,
         column: int | None = ...,
-        value: str | float | datetime | None = ...,
+        value: _KnownTypes = ...,
         style_array: StyleArray | None = ...,
     ) -> None: ...
     @property
@@ -48,15 +55,15 @@ class Cell(StyleableObject):
     @property
     def encoding(self) -> str: ...
     @property
-    def base_date(self) -> datetime: ...
-    def check_string(self, value: str): ...
+    def base_date(self) -> datetime.datetime: ...
+    def check_string(self, value: ReadableBuffer): ...
     def check_error(self, value: object) -> str: ...
     @property
-    def value(self) -> str | float | datetime | None: ...
+    def value(self) -> _KnownTypes: ...
     @value.setter
-    def value(self, value: str | float | datetime | None) -> None: ...
+    def value(self, value: _KnownTypes) -> None: ...
     @property
-    def internal_value(self) -> str | float | datetime | None: ...
+    def internal_value(self) -> _KnownTypes: ...
     @property
     def hyperlink(self) -> Hyperlink | None: ...
     @hyperlink.setter
@@ -73,11 +80,11 @@ class MergedCell(StyleableObject):
     data_type: str
     comment: Comment | None
     hyperlink: Hyperlink | None
-    row: int
-    column: int
-    def __init__(self, worksheet: Worksheet, row: int | None = ..., column: int | None = ...) -> None: ...
+    row: int | None
+    column: int | None
+    def __init__(self, worksheet: _WorkbookChild, row: int | None = ..., column: int | None = ...) -> None: ...
     @property
     def coordinate(self) -> str: ...
-    value: str | float | int | datetime | None
+    value: _KnownTypes
 
-def WriteOnlyCell(ws: Worksheet | None = ..., value: str | float | datetime | None = ...) -> Cell: ...
+def WriteOnlyCell(ws: _WorkbookChild | None = ..., value: _KnownTypes = ...) -> Cell: ...