odd rendering of dataclass __init__ method

[Lx]

Problem Description

Given this dataclass definition:

@dataclass(frozen=True, slots=True)
class ShiftChange:
    """A single instance of one shift being added or deleted, and when."""

    shift: Shift
    """The shift that this change concerns."""

    exists: bool
    """Whether the shift exists after the operation (i.e. it was added)."""

    window: TimeWindow
    """When the change occurred."""

pdoc renders the __init__ method like this:

I noted in particular:

• the comma placement between the shift and exists parameters
• the placement of the window parameter on the same line as the exists parameter, but not the shift parameter.

System Information

❯ pdoc --version
pdoc: 12.0.1
Python: 3.10.4
Platform: macOS-12.4-arm64-arm-64bit

[mhils]

Could you please post a full self-contained example? The following works just fine for me:

clerk.py

from dataclasses import dataclass

class objects:
    class shift:
        class Shift: pass
    class timewindow:
        class TimeWindow: pass

Shift = objects.shift.Shift
TimeWindow = objects.timewindow.TimeWindow

@dataclass(frozen=True, slots=True)
class ShiftChange:
    """A single instance of one shift being added or deleted, and when."""

    shift: Shift
    """The shift that this change concerns."""

    exists: bool
    """Whether the shift exists after the operation (i.e. it was added)."""

    window: TimeWindow
    """When the change occurred."""

[Lx]

If I put all the classes into one single file (in an attempt to offer you a self-contained example), then the problem disappears. So this:

from dataclasses import dataclass

# from .shift import Shift


class Shift:
    pass


class TimeWindow:
    pass


@dataclass(frozen=True, slots=True)
class ShiftChange:
    """A single instance of one shift being added or deleted, and when."""

    shift: Shift
    """The shift that this change concerns."""

    exists: bool
    """Whether the shift exists after the operation (i.e. it was added)."""

    window: TimeWindow
    """When the change occurred."""

renders with no issue:

but if the class Shift: pass is commented out and the from .shift import Shift line is re-introduced, it looks like this again:

However, notably, even if the sibling shift.py file contains only this:

class Shift:
    pass

the formatting is still broken, so it's not a matter of what's in shift.py.

---

Also for what it's worth, it's apparently not limited to __init__—here's some odd rendering from another file:

noting in particular the splitting of my old parameter's type definition across different lines and indentation levels.

[mhils]

Ah, now I can repro. Thanks! Fixed in a34e22c, a new release should be out in a few minutes. 😃

[Lx]

All looking perfect in v12.0.2. Many thanks.