python-pptx2 2.18.0__py3-none-any.whl → 2.19.0__py3-none-any.whl

pptx2/__init__.py

@@ -57,7 +57,7 @@ from pptx2.parts.slide import (
 if TYPE_CHECKING:
     from pptx2.opc.package import Part
 
-__version__ = "2.18.0"
+__version__ = "2.19.0"
 
 sys.modules["pptx2.exceptions"] = exceptions
 del sys

pptx2/_agent_friendly.py

@@ -23,23 +23,21 @@ caller bug and still raises.
 from __future__ import annotations
 
 import difflib
+import functools
+import inspect
 
 # Canonical kwarg -> spellings other ecosystems use for the same thing.
 SYNONYMS: dict[str, tuple[str, ...]] = {
     "text": ("txt", "string", "content", "label", "caption", "value"),
-    "font": ("font_family", "fontfamily", "font_name", "fontname", "typeface", "family", "face"),
+    "font": (
+        "font_family", "fontfamily", "font_name", "fontname", "typeface", "family", "face",
+    ),
     "size_pt": ("size", "font_size", "fontsize", "pt_size", "point_size"),
     "align": ("halign", "ha", "horizontal_align", "horizontal_alignment", "text_align", "text_alignment"),
     "anchor": ("valign", "va", "vertical_align", "vertical_alignment", "v_align"),
     "color": (
-        "colour",
-        "font_color",
-        "font_colour",
-        "text_color",
-        "text_colour",
-        "fg_color",
-        "line_color",
-        "stroke_color",
+        "colour", "font_color", "font_colour", "text_color", "text_colour",
+        "fg_color", "line_color", "stroke_color",
     ),
     "weight_pt": ("weight", "line_weight", "width_pt", "stroke_width"),
     "bold": ("font_bold", "is_bold"),
@@ -53,6 +51,8 @@ SYNONYMS: dict[str, tuple[str, ...]] = {
     "height": ("h",),
     "start": ("begin", "start_point", "start_shape", "from", "source"),
     "end": ("to", "end_point", "end_shape", "target"),
+    "image_file": ("image", "img", "path", "file", "filename", "image_path", "file_path"),
+    "steps": ("items", "stages", "nodes", "boxes"),
 }
 
 _ALIAS_TO_CANONICAL: dict[str, str] = {
@@ -89,17 +89,28 @@ def absorb_agent_kwargs(
     method: str,
     kwargs: dict,
     canonical_names: "list[str] | tuple[str, ...]",
+    extra_synonyms: "dict[str, tuple[str, ...]] | None" = None,
+    pass_through_unknown: bool = False,
 ) -> dict:
     """Map alias / near-miss *kwargs* onto canonical names; raise else.
 
     *canonical_names* lists the kwargs the method actually understands
-    (including any already-bound explicit parameters).  Returns a dict
-    containing only canonical names.  A synonym that matches a canonical
-    the caller already supplied with a *different* value raises
+    (including any already-bound explicit parameters).  *extra_synonyms*
+    adds call-site-specific spellings (e.g. ``{"cx": ("width", "w")}``
+    for ``add_chart``).  Returns a dict containing only canonical names
+    — unless *pass_through_unknown* is set (for functions that accept
+    ``**kwargs`` themselves), in which case unabsorbable names are
+    passed through verbatim.  A synonym that matches a canonical the
+    caller already supplied with a *different* value raises
     ``TypeError``; equal values are fine.
     """
     known = list(canonical_names)
-    alias_space = [a for a in _ALIAS_TO_CANONICAL if a not in known]
+    alias_map = dict(_ALIAS_TO_CANONICAL)
+    if extra_synonyms:
+        for canonical, aliases in extra_synonyms.items():
+            for alias in aliases:
+                alias_map[alias] = canonical
+    alias_space = [a for a in alias_map if a not in known]
     candidates = known + alias_space
 
     resolved: dict = {}
@@ -112,7 +123,7 @@ def absorb_agent_kwargs(
                 )
             resolved[name] = value
             continue
-        canonical = _ALIAS_TO_CANONICAL.get(name)
+        canonical = alias_map.get(name)
         if canonical is not None and canonical not in known:
             # The alias resolves to an argument this method doesn't take
             # (e.g. ``to=`` on add_text); fall through to the fuzzy/error
@@ -121,6 +132,9 @@ def absorb_agent_kwargs(
         if canonical is None:
             canonical = _did_you_mean(name, candidates, known)
             if canonical is None:
+                if pass_through_unknown:
+                    resolved[name] = value
+                    continue
                 raise TypeError(
                     f"{method}(): got an unexpected keyword argument {name!r}. "
                     f"Accepted: {', '.join(sorted(known))} "
@@ -134,3 +148,63 @@ def absorb_agent_kwargs(
             )
         resolved[canonical] = value
     return resolved
+
+
+def agent_friendly(extra_synonyms=None):
+    """Decorator: make a method/function absorb alias and fuzzy kwargs.
+
+    Wrap any public helper so its keyword arguments get the full
+    treatment from :func:`absorb_agent_kwargs` — global synonyms,
+    per-call *extra_synonyms*, fuzzy near-misses, and didactic errors —
+    without touching its body.  Usable bare (``@agent_friendly``) or
+    with per-method synonyms.  A keyword that repeats a value already
+    bound positionally (through a synonym or exact name) is dropped when
+    equal and raises ``TypeError`` when it contradicts::
+
+        @agent_friendly({"cx": ("width", "w"), "cy": ("height", "h")})
+        def add_chart(self, x, y, cx, cy, chart_type, chart_data): ...
+    """
+    if callable(extra_synonyms):  # used bare: @agent_friendly above def
+        return _decorate_friendly(extra_synonyms, None)
+
+    def decorator(func):
+        return _decorate_friendly(func, extra_synonyms)
+
+    return decorator
+
+
+def _decorate_friendly(func, extra_synonyms):
+    sig = inspect.signature(func)
+    has_self = bool(sig.parameters) and next(iter(sig.parameters)) in ("self", "cls")
+    param_list = [
+        p
+        for p in sig.parameters.values()
+        if p.kind not in (inspect.Parameter.VAR_POSITIONAL, inspect.Parameter.VAR_KEYWORD)
+        and p.name not in ("self", "cls")
+    ]
+    known = tuple(p.name for p in param_list)
+    takes_var_kw = any(
+        p.kind == inspect.Parameter.VAR_KEYWORD for p in sig.parameters.values()
+    )
+
+    @functools.wraps(func)
+    def wrapper(*args, **kwargs):
+        if kwargs:
+            kwargs = absorb_agent_kwargs(
+                func.__name__, kwargs, known, extra_synonyms,
+                pass_through_unknown=takes_var_kw,
+            )
+            offset = 1 if has_self else 0
+            for i, p in enumerate(param_list[: len(args) - offset]):
+                if p.name in kwargs:
+                    if kwargs[p.name] != args[offset + i]:
+                        raise TypeError(
+                            f"{func.__name__}(): {p.name} given positionally "
+                            f"({args[offset + i]!r}) and by keyword "
+                            f"({kwargs[p.name]!r}) with different values"
+                        )
+                    del kwargs[p.name]
+        return func(*args, **kwargs)
+
+    return wrapper
+

pptx2/diagrams.py

@@ -32,6 +32,7 @@ import math
 from dataclasses import dataclass, field
 from typing import TYPE_CHECKING, Any, Sequence
 
+from pptx2._agent_friendly import agent_friendly
 from pptx2.enum.shapes import MSO_SHAPE
 from pptx2.geometry import BBox
 from pptx2.util import Emu, Inches, Pt
@@ -245,6 +246,14 @@ def _card(
 # ----------------------------------------------------------------------------- pipelines
 
 
+@agent_friendly(
+    {
+        "text_color": ("color", "colour", "fg_color", "text_colour"),
+        "accent": ("accent_color", "primary", "primary_color"),
+        "fill": ("fill_color", "background", "bg"),
+    }
+
+)
 def horizontal_pipeline(
     slide,
     bbox: BBox,
@@ -312,6 +321,14 @@ def horizontal_pipeline(
     return PipelineResult(cards=cards, arrows=arrows)
 
 
+@agent_friendly(
+    {
+        "text_color": ("color", "colour", "fg_color", "text_colour"),
+        "accent": ("accent_color", "primary", "primary_color"),
+        "fill": ("fill_color", "background", "bg"),
+    }
+
+)
 def vertical_pipeline(
     slide,
     bbox: BBox,
@@ -371,6 +388,15 @@ def vertical_pipeline(
 # ----------------------------------------------------------------------------- hub
 
 
+@agent_friendly(
+    {
+        "text_color": ("color", "colour", "fg_color", "text_colour"),
+        "accent": ("accent_color", "primary", "primary_color"),
+        "fill": ("fill_color", "background", "bg"),
+        "spokes": ("items", "stages", "nodes"),
+        "centre": ("center", "hub", "hub_label", "title"),
+    }
+)
 def hub_and_spoke(
     slide,
     bbox: BBox,
@@ -479,6 +505,14 @@ def hub_and_spoke(
 # ----------------------------------------------------------------------------- cycle
 
 
+@agent_friendly(
+    {
+        "text_color": ("color", "colour", "fg_color", "text_colour"),
+        "accent": ("accent_color", "primary", "primary_color"),
+        "fill": ("fill_color", "background", "bg"),
+    }
+
+)
 def cycle(
     slide,
     bbox: BBox,
@@ -553,6 +587,15 @@ def cycle(
 # ----------------------------------------------------------------------------- decision tree
 
 
+@agent_friendly(
+    {
+        "text_color": ("color", "colour", "fg_color", "text_colour"),
+        "accent": ("accent_color", "primary", "primary_color"),
+        "fill": ("fill_color", "background", "bg"),
+        "branches": ("items", "nodes", "children", "steps"),
+        "root": ("root_label", "title", "center"),
+    }
+)
 def decision_tree(
     slide,
     bbox: BBox,
@@ -675,6 +718,14 @@ def decision_tree(
 # ----------------------------------------------------------------------------- columns
 
 
+@agent_friendly(
+    {
+        "text_color": ("color", "colour", "fg_color", "text_colour"),
+        "accent": ("accent_color", "primary", "primary_color"),
+        "fill": ("fill_color", "background", "bg"),
+        "columns": ("items", "cols", "sections"),
+    }
+)
 def comparison_columns(
     slide,
     bbox: BBox,

pptx2/shapes/shapetree.py

@@ -34,6 +34,7 @@ from pptx2.shapes.placeholder import (
     TablePlaceholder,
 )
 from pptx2.shared import ParentedElementProxy
+from pptx2._agent_friendly import agent_friendly
 from pptx2.util import Emu, _coerce_emu, lazyproperty
 
 if TYPE_CHECKING:
@@ -567,6 +568,7 @@ class _BaseGroupShapes(_BaseShapes):
         super(_BaseGroupShapes, self).__init__(grpSp, parent)
         self._grpSp = grpSp
 
+    @agent_friendly({"cx": ("width", "w"), "cy": ("height", "h"), "chart_data": ("data", "chartdata"), "chart_type": ("type", "charttype")})
     def add_chart(
         self,
         chart_type: XL_CHART_TYPE,
@@ -601,6 +603,7 @@ class _BaseGroupShapes(_BaseShapes):
         _apply_horizontal_bar_default(shape, chart_type)
         return cast("Chart", shape)
 
+    @agent_friendly({"connector_type": ("type", "kind", "connector"), "begin_x": ("x1", "start_x"), "begin_y": ("y1", "start_y"), "end_x": ("x2", "to_x"), "end_y": ("y2", "to_y")})
     def add_connector(
         self,
         connector_type: MSO_CONNECTOR_TYPE,
@@ -621,6 +624,7 @@ class _BaseGroupShapes(_BaseShapes):
         self._recalculate_extents()
         return cast(Connector, self._shape_factory(cxnSp))
 
+    @agent_friendly({"shapes": ("items", "members")})
     def add_group_shape(self, shapes: Iterable[BaseShape] = ()) -> GroupShape:
         """Return a |GroupShape| object newly appended to this shape tree.
 
@@ -639,6 +643,7 @@ class _BaseGroupShapes(_BaseShapes):
             grpSp.recalculate_extents()
         return cast(GroupShape, self._shape_factory(grpSp))
 
+    @agent_friendly
     def add_ole_object(
         self,
         object_file: str | IO[bytes],
@@ -700,6 +705,7 @@ class _BaseGroupShapes(_BaseShapes):
         self._recalculate_extents()
         return cast(GraphicFrame, self._shape_factory(graphicFrame))
 
+    @agent_friendly
     def add_picture(
         self,
         image_file: str | os.PathLike[str] | IO[bytes],
@@ -762,6 +768,7 @@ class _BaseGroupShapes(_BaseShapes):
             picture.top = Emu(ct + new_top)
         return picture
 
+    @agent_friendly({"svg_file": ("svg", "svg_path", "svg_source")})
     def add_svg_picture(
         self,
         svg_file,
@@ -825,6 +832,7 @@ class _BaseGroupShapes(_BaseShapes):
         self._recalculate_extents()
         return cast(Picture, self._shape_factory(pic))
 
+    @agent_friendly({"autoshape_type_id": ("shape_type", "autoshape_type", "shape", "preset_shape")})
     def add_shape(
         self,
         autoshape_type_id: MSO_SHAPE,
@@ -863,6 +871,7 @@ class _BaseGroupShapes(_BaseShapes):
             shape.top = Emu(ct + new_top)
         return shape
 
+    @agent_friendly
     def add_textbox(
         self,
         left: Length,
@@ -1498,6 +1507,7 @@ class _BaseGroupShapes(_BaseShapes):
         sp = self._spTree.add_textbox(id_, name, x, y, cx, cy)
         return sp
 
+    @agent_friendly({"cols": ("columns", "num_cols", "col_count"), "rows": ("num_rows", "row_count")})
     def add_table(
         self,
         rows: int,
@@ -1549,6 +1559,7 @@ class _BaseGroupShapes(_BaseShapes):
             tbl.vert_banding = False
         return shape
 
+    @agent_friendly({"movie_file": ("video", "video_file", "movie", "path", "file")})
     def add_movie(
         self,
         movie_file: str | IO[bytes],

pptx2/skill/references/basics.md

@@ -452,9 +452,13 @@ end. `move` raises `IndexError` out of range; `reorder` raises
 
 ### Forgiving keyword arguments
 
-The one-call helpers (`add_text`, `add_equation`, `add_arrow`) absorb
-cross-library and near-miss kwargs, so the `font_family=` / `halign=` /
-`fontsize=` / `colour` / `x,y,w,h` / `begin,to` habits of other
-ecosystems just work. Synonyms substitute, never contradict (two
-different values for the same logical argument still raise), and a
-truly unknown kwarg raises a `TypeError` listing every accepted name.
+Every shape helper (`add_text`, `add_shape`, `add_picture`,
+`add_table`, `add_chart`, `add_textbox`, `add_connector`, `add_movie`,
+`add_arrow`, `add_equation`, ...) and the diagram recipes
+(`horizontal_pipeline`, `hub_and_spoke`, ...) absorb cross-library and
+near-miss kwargs: `font_family=`, `halign=`/`valign=`, `fontsize=`,
+`colour`, `x,y,w,h` geometry keywords, `shape_type=`, `image=`,
+`columns=`, `data=`, `begin=`/`to=`, `items=`/`nodes=` ... Synonyms
+substitute, never contradict (two different values for the same
+logical argument still raise), and a truly unknown kwarg raises a
+`TypeError` listing every accepted name.

{python_pptx2-2.18.0.dist-info → python_pptx2-2.19.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-pptx2
-Version: 2.18.0
+Version: 2.19.0
 Summary: Create, read, and update PowerPoint 2007+ (.pptx) files. Fork of power-pptx / python-pptx, published as python-pptx2.
 Author: Matěj Štágl
 Author-email: stagl@wattlescript.org

{python_pptx2-2.18.0.dist-info → python_pptx2-2.19.0.dist-info}/RECORD

@@ -1,5 +1,5 @@
-pptx2/__init__.py,sha256=RLbdJA33KyGpbpK-EK8th847D5voP73QPHz9FaEVq2M,4076
-pptx2/_agent_friendly.py,sha256=zysyr-CLIM6saCk7m-fp8CcMJOaaIMPbqpmWMOibBCA,5663
+pptx2/__init__.py,sha256=SyJ-yjsqXoYHIjHWLRvKdyYTilNWX5KpkyHWIepB8HA,4076
+pptx2/_agent_friendly.py,sha256=wYh9LmVuZMVlwOxzyd1mw0NmtPKQ2cTC21Y1Ww8ehO8,8834
 pptx2/_color.py,sha256=Ureg4dSEdHbwpVZ5eJIyt0kLx_W3mGftmznejth_oLQ,2889
 pptx2/_slide_importer.py,sha256=Ot3lW20eS7fMKsaGaeqPyeS9zVzt5D1WkovwozWwbYY,27033
 pptx2/_svg.py,sha256=pMURsUQaJ9-dqRl4nEZKt1VECNpA8Ghp4EwNRWcBG-c,5973
@@ -10,7 +10,7 @@ pptx2/action.py,sha256=BiDtM80P6oFsNOtLIT1nX82LXEvaGOg4Usaf5CA7kNY,9648
 pptx2/animation.py,sha256=g0OxAkCoGu0QEx3QB9Yu4BOnGLjD3tcLpKoYBAtUW6s,83756
 pptx2/api.py,sha256=n98a5qUhVxSwZ_yG_aXxtDCxtnEp37LPsSIsYsbwsfA,1841
 pptx2/audit.py,sha256=xg1QAs-ByW3xwBEcJ-Y9ptYe2WHKmVuVWAgRKQZfcr8,11276
-pptx2/diagrams.py,sha256=5NqGg-CMj6ZYoEsI9pBD1UHmwQhSAK8oAFYD89NPsVg,24654
+pptx2/diagrams.py,sha256=4NmdFBg367hRjfFh7pQCVivScspmyvPnp94IyncJgCc,26277
 pptx2/exc.py,sha256=k6p-e9h5cKal09-sAv3E1QTXmVDuF8FqewW1CKFQmfw,1276
 pptx2/formats.py,sha256=w0b8YXBjBbPhDu1UV9-1iUJdL62d9_gcQSp9sHKVr_s,5081
 pptx2/geometry.py,sha256=X1tzwqTxXCMPPRpZhHSax6PKGy_-64MAudMI9h3ILJk,15221
@@ -137,12 +137,12 @@ pptx2/shapes/graphfrm.py,sha256=mwA9Wb4WRKBy6sA7KzOZFl3aHlpN-TmWRcE-kiMoqRI,1189
 pptx2/shapes/group.py,sha256=xlcGi3MAzBHX2IM16IATxRgw8NwsPFzTMVbRPYQ7OKg,11036
 pptx2/shapes/picture.py,sha256=U7rwiy7OXn0RgFSEdh07bdhIplWsI82OjFk-mt975J0,14938
 pptx2/shapes/placeholder.py,sha256=9tIeNscnV46hWyMr8ZSiZO3TZr-tt4kZgx6BRB0tCvc,17838
-pptx2/shapes/shapetree.py,sha256=m1tVELFeK7Ha7uEMU1vtzxHXAZzGyk5bgTmiR8tgWlQ,90442
+pptx2/shapes/shapetree.py,sha256=ZXO1mE2-sMF8Era-EA4mT61Mcj2Hfsr8v-7xOZM_oBw,91287
 pptx2/skill/SKILL.md,sha256=6w7sWflZvhYYIzBsXLjx2uVKqB0793ZTvoZ_SUfzQxg,23668
 pptx2/skill/__init__.py,sha256=bUkfMETwf3K6J7GSE-tLQjdNziS_JceunComLiLIeGI,2665
 pptx2/skill/__main__.py,sha256=ohMLGy1jbjKV5_FqY6aGj4tm_isJ6fznvqUKiE1H6s8,1777
 pptx2/skill/references/animations.md,sha256=ca02l5XCtOQpD-uSCItQixGaW0yONIY0P55yy-T-J1Q,5875
-pptx2/skill/references/basics.md,sha256=XhdtDY93gQ9_dzPCITsgORFVLZNBaEnSQLMuK06dDio,14583
+pptx2/skill/references/basics.md,sha256=O2ODa85fIK6mkom4aK2ehb2laEsogmtQ31RF5ckh6B0,14806
 pptx2/skill/references/charts.md,sha256=skCS4Kn1j49mlIQJYDAkcu2VHc3S1mzwqkGT3ZE94wg,8119
 pptx2/skill/references/compose.md,sha256=AfFwqAyQ9ggR140laqRDIUE3OcmTtXpIZH1oPcTOunA,8088
 pptx2/skill/references/design.md,sha256=ne3xVyIwqpkhEkd8XK74QEija040eHve5zBHBx9LeNo,11706
@@ -171,9 +171,9 @@ pptx2/text/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 pptx2/text/fonts.py,sha256=ECa9HuBfeTqOi-uJTz_bu7eurC7e1_64RTwDatxmkpk,16498
 pptx2/text/layout.py,sha256=k8bqod6GyshHJtfoqFtH9W-eHTI43IB0e6SLT1ibSUU,12815
 pptx2/text/text.py,sha256=LPqF1B4GSQNSnSlVMm1v7pgtHCymOJPTUG_Kdt5_ou4,55039
-python_pptx2-2.18.0.dist-info/licenses/LICENSE,sha256=hLdud18ZPS9iSG3kBCBLiGYzj4A6zedCHiDejIDBXNg,1230
-python_pptx2-2.18.0.dist-info/METADATA,sha256=iiglSWLjdpEaY77K99QiNh0yJ_jaDzrU9so-vNplp0k,14374
-python_pptx2-2.18.0.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
-python_pptx2-2.18.0.dist-info/entry_points.txt,sha256=UpD1_pA-2BPeN0iDeD-u4NZ_yC78TvBdWu3V1xLsSRE,105
-python_pptx2-2.18.0.dist-info/top_level.txt,sha256=NDdhJ4rOySlDU-cw4g-bQMoZCiy41WszlRXmIiReSRs,6
-python_pptx2-2.18.0.dist-info/RECORD,,
+python_pptx2-2.19.0.dist-info/licenses/LICENSE,sha256=hLdud18ZPS9iSG3kBCBLiGYzj4A6zedCHiDejIDBXNg,1230
+python_pptx2-2.19.0.dist-info/METADATA,sha256=ttj2GNUUnqaxdWQqPvqwfN4lOn6KcRzMWtcBt1UnnCA,14374
+python_pptx2-2.19.0.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+python_pptx2-2.19.0.dist-info/entry_points.txt,sha256=UpD1_pA-2BPeN0iDeD-u4NZ_yC78TvBdWu3V1xLsSRE,105
+python_pptx2-2.19.0.dist-info/top_level.txt,sha256=NDdhJ4rOySlDU-cw4g-bQMoZCiy41WszlRXmIiReSRs,6
+python_pptx2-2.19.0.dist-info/RECORD,,